نصب درگاه

قبل‌از نصب کردن «درگاه خدمات توسعه‌دهنده Apigee» (یا به‌طور ساده، درگاه)، مطمئن شوید که:

  1. ‫Postgres را قبل‌از نصب کردن درگاه نصب می‌کنید. می‌توانید Postgres را به‌عنوان بخشی از نصب Edge نصب کنید یا Postgres را به‌صورت مستقل برای استفاده در درگاه نصب کنید.
    • اگر Postgres را به‌صورت مستقل نصب کنید، می‌تواند در همان گره درگاه باشد.
    • اگر به Postgres متصل می‌شوید که به‌عنوان بخشی از Edge نصب شده است و Postgres در حالت اصلی/آماده به‌کار پیکربندی شده است، نشانی IP سرور اصلی Postgres را مشخص کنید.
  2. نصب را روی نسخه ۶۴ بیتی یکی از نسخه‌های پشتیبانی‌شده Red Hat Enterprise Linux،‏ CentOS، یا Oracle انجام می‌دهید. فهرست نسخه‌های پشتیبانی‌شده را در نرم‌افزار پشتیبانی‌شده و نسخه‌های پشتیبانی‌شده ببینید.
  3. ‫Yum نصب شده است.

نصب‌کننده فقط شامل واحدهای همیاری Drupal است که برای درگاه «خدمات توسعه‌دهندگان Apigee» (یا به‌سادگی، درگاه) لازم است. برای اطلاعات درباره نصب دیگر واحدهای همیاری‌شده، به گسترش Drupal 7 مراجعه کنید.

نمای کلی نصب

برای نصب کردن درگاه، مراحل زیر را انجام خواهید داد. هریک از این مراحل در بخش‌های بعدی با جزئیات بیشتری توضیح داده شده است.

  1. اتصال خود را آزمایش کنید
  2. برداشتن نسخه‌های قبل‌از ۷.۰ از PHP
  3. نصب Postgres
  4. نصب درگاه
  5. مطمئن شوید «مدیر به‌روزرسانی» فعال باشد
  6. (اختیاری) پیکربندی Apache Solr
  7. (اختیاری) نصب SmartDocs
  8. (اختیاری) پیکربندی JQuery

منسوخ شدن خصوصیت SMTPSSL

در نسخه‌های قبلی، از دارایی SMTPSSL برای تنظیم پروتکل استفاده‌شده توسط سرور SMTP متصل به درگاه استفاده می‌کردید. آن دارایی منسوخ شده است.

اکنون به‌جای خصوصیت SMTPSSL، از خصوصیت SMTP_PROTOCOL برای تنظیم پروتکل استفاده‌شده توسط سرور SMTP متصل به درگاه استفاده می‌کنید. مقادیر معتبر عبارت‌اند از: «standard»‏، «ssl»، یا «tls».

ایجاد فایل پیکربندی درگاه

در زیر نمونه‌ای از فایل پیکربندی بی‌صدا برای نصب درگاه نشان داده شده است. این فایل را درصورت نیاز برای پیکربندی‌تان ویرایش کنید. برای setup.sh کردن این فایل، از گزینه -f استفاده کنید.

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres.
PG_NAME=devportal

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal
# to access the Postgres database,
# This account is created if it does not already exist.
DRUPAL_PG_USER=drupaladmin
DRUPAL_PG_PASS=portalSecret

# Specify 'postgres' as the database.
DEFAULT_DB=postgres

# Specify the Drupal admin account details.
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin.
# The installer creates this user on the portal.
DEVPORTAL_ADMIN_FIRSTNAME=firstName
DEVPORTAL_ADMIN_LASTNAME=lastName
DEVPORTAL_ADMIN_USERNAME=userName
DEVPORTAL_ADMIN_PWD=PORTAL_ADMIN_PASSWORD
DEVPORTAL_ADMIN_EMAIL=foo@bar.com

# Edge connection details.
# If omitted, you can set them in the portal UI.
# Specify the Edge organization associated with the portal.
EDGE_ORG=edgeOrgName

# Specify the URL of the Edge management API.
# For a Cloud based installation of Edge, the URL is:
# https://api.enterprise.apigee.com/v1
# For a Private Cloud installation, it is in the form:
# http://ms_IP_or_DNS:8080/v1 or
# https://ms_IP_or_DNS:TLSport/v1
MGMT_URL=https://api.enterprise.apigee.com/v1

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword.
# The portal uses this information to connect to Edge.
DEVADMIN_USER=orgAdmin@myCorp.com
DEVADMIN_PWD=ORG_ADMIN_PASSWORD

# The PHP port.
# If omitted, it defaults to 8888.
PHP_FPM_PORT=8888

# Optionally configure the SMTP server used by the portal.
# If you do, the properties SMTPHOST and SMTPPORT are required.
# The others are optional with a default value as notated below.
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com.
SMTPHOST=smtp.gmail.com

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# SMTP port (usually 25).
# The value can be different based on the selected encryption protocol.
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS.
SMTPPORT=25

# Username used for SMTP authentication, defaults is blank.
SMTPUSER=your@email.com

# Password used for SMTP authentication, default is blank.
SMTPPASSWORD=YOUR_EMAIL_PASSWORD

۱. اتصال خود به Apigee Edge را آزمایش کنید

با اجرای فرمان curl زیر در سرور درگاه، اتصال بین سروری که می‌خواهید درگاه را در آن نصب کنید و سرور مدیریت Edge را آزمایش کنید:

curl -u EMAIL:PASSWORD http://ms_IP_or_DNS:8080/v1/organizations/ORGNAME

یا:

curl -u EMAIL:PASSWORD https://ms_IP_or_DNS:TLSPort/v1/organizations/ORGNAME

که در آن EMAIL و PASSWORD نشانی ایمیل و گذرواژه سرپرست ORGNAME است.

حتماً نام میزبان و شماره درگاه مربوط به نصب Edge خود را مشخص کنید. درگاه ‫۸۰۸۰ درگاه پیش‌فرضی است که Edge استفاده می‌کند. اگر به سازمانی در فضای ابری متصل می‌شوید، نشانی وب درخواست این است: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

اگر موفقیت‌آمیز باشد، curl پاسخی مشابه با پاسخ زیر برمی‌گرداند:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

۲. برداشتن نسخه‌های قبل‌از ۷.۰ PHP

پیش‌از شروع نصب، دستور نصب نسخه‌های قبل‌از ۷.۰ PHP را در سیستم بررسی می‌کند. اگر نسخه‌های قبل‌از ۷.۰ PHP وجود داشته باشد، پیام هشدار زیر نمایش داده می‌شود:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

بسته‌های PHP را بااستفاده از فرمان زیر بردارید:

yum remove package_name

اگر مطمئن نیستید که PHP روی سرورتان نصب شده است یا نه، از فرمان زیر استفاده کنید:

rpm -qa | grep -i php

توجه داشته باشید که پورتال از نسخه PHP 4.18.01-0.0.49 استفاده می‌کند. این عدد برای مطابقت با شماره نسخه Apigee Edge برای «ابر خصوصی» درنظر گرفته نشده است.

۳. نصب Postgres

برای نصب کردن درگاه، باید Postgres را نصب کنید. می‌توانید Postgres را هم‌زمان با نصب Edge نصب کنید، یا Postgres را به‌صورت مستقل برای استفاده در درگاه نصب کنید.

  • اگر به Postgres متصل می‌شوید که به‌عنوان بخشی از Edge نصب شده است و Postgres در حالت اصلی/آماده به‌کار پیکربندی شده است، نشانی IP سرور اصلی Postgres را مشخص کنید.
  • اگر Postgres را به‌صورت مستقل نصب کنید، می‌تواند در همان گره درگاه باشد.

برای اطلاعات درباره نصب Postgres به‌عنوان بخشی از نصب Edge، به نصب اجزای Edge در گره مراجعه کنید.

برای نصب Postgres خوداتکا:

  1. برنامه کمکی Edge apigee-setup را بااستفاده از رویه اینترنتی یا غیر اینترنتی روی گره نصب کنید. برای اطلاعات بیشتر، نصب ابزار کمکی apigee-setup در Edge را ببینید.
  2. فایل پیکربندی Postgres را همان‌طور که در مثال زیر نشان داده شده است ایجاد کنید:
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
    HOSTIP=$(hostname -i)
    
    # The pod and region of Postgres. Use the default values shown below.
    MP_POD=gateway
    REGION=dc-1
    
    # Set the Postgres password. The default value is 'postgres'.
    PG_PWD=postgres
  3. در خط فرمان، دستورگان راه‌اندازی را اجرا کنید تا Postgres نصب شود:
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

    گزینه -p pdb نصب Postgre را مشخص می‌کند. فایل پیکربندی باید برای کاربر «apigee» دردسترس یا قابل‌خواندن باشد.

۴. نصب درگاه

قبل‌از اینکه بتوانید درگاه را نصب کنید، مطمئن شوید که موارد زیر را همان‌طور که در ۳. نصب Postgres:

  1. ابزار Edge apigee-setup را در گره درگاه نصب کنید
  2. ‫Postgres را نصب کنید، چه به‌صورت خوداتکا و چه به‌عنوان بخشی از نصب Edge

برای نصب درگاه:

  1. در پیام‌واره فرمان، setup متن را اجرا کنید:
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    مکان:

    • configFile فایل پیکربندی درگاه است که در ایجاد فایل پیکربندی درگاه توضیح داده شده است.
    • ‫-p dp به دستورگان setup دستور می‌دهد درگاه را نصب کند.

برای درستی‌سنجی اینکه نصب درگاه موفقیت‌آمیز بوده است:

  1. به صفحه اصلی درگاه در http://localhost:8079 یا به نام ساناد درگاهتان پیمایش کنید.
  2. بااستفاده از اطلاعات اعتباری سرپرستی که در فایل پیکربندی درگاه تنظیم کرده‌اید، به سیستم درگاه وارد شوید.
  3. گزارش‌ها > گزارش وضعیت را در منو Drupal انتخاب کنید تا مطمئن شوید که می‌توانید وضعیت فعلی درگاه را ببینید.
  4. مطمئن شوید که اتصال «سرور مدیریت» موفقیت‌آمیز بوده است. اگر نبود:
    1. به صفحه «پیکربندی اتصال» در درگاه پیمایش کنید (برای مثال، http://portal_IP:8079/admin/config/devconnect).
    2. روی دکمه آزمایش کردن اتصال کلیک کنید. اگر اتصال موفقیت‌آمیز باشد، کار تمام است. اگر اتصال برقرار نشد، ادامه دهید.
    3. تنظیمات نقطه پایانی و اصالت‌سنجی را بررسی کنید:
      • نشانی وب نقطه پایان «میانای برنامه‌سازی کاربردی مدیریت»: بررسی کنید که پروتکل (HTTP یا HTTPS)، نام IP یا ساناد، و شماره درگاه صحیح باشد؛ برای مثال:
        http://10.10.10.10:8080/v1
      • کاربر اصالت‌سنجی‌شده نقطه پایانی: نام کاربری سرپرست سازمان.
      • گذرواژه کاربر اصیل: گذرواژه سرپرست سازمان.

      مقادیر پیش‌فرض تنظیمات موجود در فایل پیکربندی درگاه شما را که درطول فرایند نصب ایجاد کرده‌اید منعکس می‌کند.

      این مقادیر باید با مقادیر ms_IP_or_DNS، email، و password که در مرحله ۱: اتصال به Apigee Edge را آزمایش کنید استفاده کردید مطابقت داشته باشد. نام کاربری و گذرواژه باید با مقادیر ویژگی‌های USER_NAME و USER_PWD در فایل پیکربندی آماده‌سازی، یا اطلاعات اعتباری هر کاربری که نقش «سرپرست سازمان» دارد مطابقت داشته باشد.

    4. پس‌از اینکه با موفقیت به «سرور مدیریت» متصل شدید، روی دکمه ذخیره پیکربندی در پایین صفحه کلیک کنید تا تغییراتتان ذخیره شود.

۵. مطمئن شوید که واحد «مدیر به‌روزرسانی» فعال باشد

برای دریافت اعلان‌های به‌روزرسانی Drupal، مطمئن شوید که واحد «مدیر به‌روزرسانی Drupal» فعال باشد. از منو Drupal، واحدها را انتخاب کنید و به پایین پیمایش کنید تا به واحد مدیر به‌روزرسانی برسید. اگر فعال نیست، آن را فعال کنید.

پس‌از فعال شدن، می‌توانید به‌روزرسانی‌های دردسترس را بااستفاده از مورد منو گزارش‌ها > به‌روزرسانی‌های دردسترس مشاهده کنید. همچنین می‌توانید از فرمان Drush زیر استفاده کنید:

drush pm-info update

باید این فرمان را از فهرست راهنمای ریشه سایت اجرا کنید. به‌طور پیش‌فرض، درگاه در /opt/apigee/apigee-drupal/wwwroot نصب می‌شود. بنابراین، پیش‌از اجرای فرمان، ابتدا باید دایرکتوری را به /opt/apigee/apigee-drupal/wwwroot تغییر دهید. اگر درگاه را در پوشه پیش‌فرض نصب نکرده‌اید، به پوشه نصب خود بروید.

از عنصر منو گزارش‌ها > به‌روزرسانی‌های دردسترس > تنظیمات برای پیکربندی واحد استفاده کنید تا وقتی به‌روزرسانی دردسترس است به شما ایمیل کند و دفعات بررسی به‌روزرسانی‌ها را تنظیم کنید.

‫۶. پیکربندی موتور جستجوی Apache Solr (اختیاری)

به‌طور پیش‌فرض، واحدهای Drupal که به موتور جستجوی Apache Solr متصل می‌شوند هنگام نصب درگاه غیرفعال می‌شوند. اکثر درگاه‌ها از موتور جستجوی داخلی Drupal استفاده می‌کنند و بنابراین به واحد Drupal Solr نیاز ندارند.

اگر تصمیم گرفتید از Solr به‌عنوان موتور جستجو استفاده کنید، باید Solr را به‌صورت محلی در سرورتان نصب کنید و سپس واحدهای Drupal Solr را در درگاه فعال و پیکربندی کنید.

برای فعال کردن واحدهای Drupal Solr:

  1. به‌عنوان کاربری با امتیازات سرپرست یا تولید محتوا، به سیستم درگاهتان وارد شوید.
  2. واحدها را در منو Drupal انتخاب کنید.
  3. واحد چارچوب Apache Solr و واحد جستجوی Apache Solr را فعال کنید.
  4. تغییرات را ذخیره کنید.
  5. ‫Solr را همان‌طور که در https://drupal.org/node/1999280 توضیح داده شده است پیکربندی کنید.

‫۷. نصب SmartDocs (اختیاری)

‫SmartDocs به شما امکان می‌دهد میاناهای برنامه‌سازی کاربردی خود را در درگاه به‌گونه‌ای مستند کنید که مستندات میانای برنامه‌سازی کاربردی کاملاً تعاملی باشد. بااین‌حال، برای استفاده از «اسناد هوشمند» با درگاه، ابتدا باید «اسناد هوشمند» را در Edge نصب کنید.

  • اگر درحال متصل کردن درگاه به نصب Edge Cloud هستید، SmartDocs ازقبل نصب شده است و پیکرببندی دیگری لازم نیست.
  • اگر درحال متصل کردن درگاه به نصب Edge for Private Cloud هستید، باید مطمئن شوید که SmartDocs روی Edge نصب شده باشد. برای اطلاعات بیشتر درباره نصب Edge و SmartDocs، به نصب SmartDocs مراجعه کنید.

همچنین باید «سندهای هوشمند» را در درگاه فعال کنید. برای کسب اطلاعات بیشتر درباره SmartDocs، به استفاده از SmartDocs برای مستندسازی میاناهای برنامه‌سازی کاربردی مراجعه کنید.

‫۸. پیکربندی واحد JQuery Update برای نصب‌های غیر اینترنتی (اختیاری)

اگر واحد «به‌روزرسانی JQuery» را در نصب غیر اینترنتی نصب و استفاده می‌کنید، باید واحد را پیکربندی کنید تا از نسخه محلی JQuery استفاده کند. اگر واحد را برای استفاده از CDN برای نصب غیر اینترنتی پیکربندی کنید، واحد تلاش می‌کند به CDN دسترسی پیدا کند و باعث تأخیر در بار کردن صفحه می‌شود. برای کسب اطلاعات بیشتر درباره واحد «به‌روزرسانی JQuery»، به https://www.drupal.org/project/jquery_update مراجعه کنید.

برای پیکربندی واحد «به‌روزرسانی JQuery» برای استفاده از نسخه محلی JQuery:

  1. به‌عنوان کاربری با امتیازات سرپرست یا تولید محتوا، به سیستم درگاهتان وارد شوید.
  2. در منو Drupal، گزینه پیکربندی > توسعه > به‌روزرسانی JQuery را انتخاب کنید.
  3. در پیمایش سمت راست، روی عملکرد کلیک کنید.
  4. در منو کرکره‌ای «شبکه توزیع محتوای JQuery و JQuery UI»، هیچ‌کدام را انتخاب کنید.
  5. روی ذخیره پیکربندی کلیک کنید.

‫۹. مراحل بعدی

جدول زیر برخی‌از رایج‌ترین تکالیفی را که پس‌از نصب انجام می‌دهید فهرست می‌کند، و شامل پیوندهایی به مستندات Apigee است که در آن می‌توانید اطلاعات بیشتری پیدا کنید:

وظیفه شرح

سفارشی‌سازی زمینه

زمینه ظاهر درگاه را تعریف می‌کند، ازجمله رنگ‌ها، سبک، و دیگر جنبه‌های دیداری.

سفارشی‌سازی کردن ظاهر

صفحه اصلی شامل منو اصلی، پیام خوشامدگویی، سرصفحه، پاصفحه، و عنوان است.

افزودن و مدیریت حساب‌های کاربری

فرایند ثبت‌نام کنترل می‌کند که توسعه‌دهندگان جدید چگونه در درگاه حساب ثبت کنند. برای مثال، آیا توسعه‌دهندگان جدید بلافاصله به درگاه دسترسی پیدا می‌کنند یا باید توسط سرپرست درستی‌سنجی شوند. این فرایند همچنین کنترل می‌کند که وقتی حساب جدیدی ایجاد می‌شود، چگونه به سرپرست درگاه اطلاع داده شود.

درحال پیکربندی ایمیل

درگاه در پاسخ به رویدادهای خاصی ایمیل ارسال می‌کند. برای مثال، وقتی توسعه‌دهنده جدیدی در درگاه ثبت‌نام می‌کند و وقتی توسعه‌دهنده‌ای گذرواژه‌اش را ازدست می‌دهد.

افزودن و مدیریت حساب‌های کاربری

صفحه «شرایط خدمات» اضافه کنید که توسعه‌دهندگان باید قبل‌از اینکه اجازه دسترسی به درگاه را پیدا کنند آن را بپذیرند.

افزودن و مدیریت حساب‌های کاربری

درگاه مدل مجوز مبتنی بر نقش را پیاده‌سازی می‌کند. قبل‌از اینکه به توسعه‌دهندگان اجازه دهید ثبت‌نام کنند، اجازه‌ها و نقش‌های مورد استفاده در درگاه را تعریف کنید.

افزودن پست‌های وبلاگ و تالار گفتمان

این درگاه از وبلاگ‌ها و تالارهای گفتمان رشته‌ای پشتیبانی داخلی دارد. اجازه‌های موردنیاز برای مشاهده، افزودن، ویرایش، و حذف پست‌های وبلاگ و تالار گفتمان را تعریف کنید.

مطمئن شوید که از پایگاه داده پشتیبان‌گیری می‌کنید

مطمئن شوید که از پایگاه داده Drupal پشتیبان‌گیری می‌کنید. توجه داشته باشید که چون هر نصب متفاوت است، این شما هستید که باید بهترین روش پشتیبان‌گیری از پایگاه داده را تعیین کنید.

همچنین نحوه انجام پشتیبان‌گیری را ببینید.

راه‌اندازی نام میزبان

اگر نام میزبان را در سرور ساناد خود تنظیم نکنید، همیشه می‌توانید ازطریق نشانی IP سرور به سایت دسترسی داشته باشید. اگر می‌خواهید از نام میزبان استفاده کنید، می‌توانید ساناد را برای سرور پیکربندی کنید، که باید بدون هیچ پیکربندی دیگری در راه‌اندازی اولیه به‌درستی کار کند.

اگر ترازکننده بار راه‌اندازی کرده‌اید یا به دلایل دیگر نشانی‌های وب نادرست در سایتتان دریافت می‌کنید، می‌توانید $base_url را برای Drupal با دنبال کردن این مراحل تنظیم کنید:

  1. اگر دایرکتوری /opt/apigee/data/apigee-drupal-devportal/sites/default/includes وجود ندارد، آن را ایجاد کنید.
  2. فایلی به‌نام settings.php در آن دایرکتوری ایجاد کنید.
  3. مورد زیر را به فایل settings.php اضافه کنید:
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
  4. آخرین $base_url خط را به نام میزبان سایتتان تغییر دهید.
  5. فایل را ذخیره کنید.

توجه داشته باشید که می‌توانید هر تنظیم دیگری را از /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php در این فایل قرار دهید.

برای اطلاعات بیشتر درباره دارایی $base_url، موارد زیر را ببینید:

توسعه سفارشی همچنین ممکن است بخواهید قابلیت‌های درگاهتان را با کد سفارشی خارج از موضوعتان گسترش دهید. برای انجام این کار، همان‌طور که در مباحث توسعه واحد Drupal توضیح داده شده است، واحد Drupal خودتان را ایجاد کنید و واحد را در دایرکتوری /sites/all/modules قرار دهید.