開發人員服務入口網站安裝

Developer Services Portal 4.16.05 版

請按照下列步驟安裝開發人員 Channel Services 入口網站。

繼續安裝之前,請先備份整個 Drupal 網路根目錄。預設的安裝位置為 /var/www/html,但您可能在安裝時變更了位置。執行以下安裝步驟後,您就可以從備份還原自訂內容。

1. 取得開發人員 Channel Services 套裝組合

前往 http://community.apigee.com/content/apigee-customer-support,然後選取「登入支援入口網站」來索取開發人員通路服務 .tar 檔案:

  • 要求 Edge for Private Cloud 下載目錄的存取權。
  • 要求開發人員 Channel Services .tar 檔案的網址。

2. 確認您的系統符合系統需求

您的伺服器必須符合下列需求,才能安裝入口網站:

  1. 請確認您是在系統支援的 Red Hat Enterprise Linux、CentOS 或 Oracle 64 位元版本上執行安裝作業。如要查看支援的版本清單,請按這裡
  2. 確認已安裝 Yum。
  3. (如要在沒有網際網路連線的伺服器上進行安裝),您必須先以單一 .tar.gz 檔案的形式,將所有必要檔案下載至具備網際網路連線功能的伺服器上。接著,您會將 .tar.gz 檔案複製到沒有網際網路連線的伺服器,以便執行安裝作業。
    1. 以根使用者或超級使用者的身分登入伺服器。
    2. 建立安裝檔案的目錄,例如 portal_tar
    3. 將 CD 寫入新目錄,並下載開發人員 Channel Services DeveloperServices_x.y.z.tar 檔案,其中的 x.y.z 代表入口網站版本號碼。
    4. 使用下列指令擷取 Developer Channel Services .tar 檔案的內容:
      > tar -xvf <tar file>
    5. CD 至 DeveloperServices-4.x.y.z
    6. 使用下列指令建立入口網站 .tar.gz 檔案:
      > ./non-networked-install.sh

      這個指令會將所有必要檔案全部下載至單一 .tar.gz 檔案。接著,您可以將該 .tar.gz 檔案複製到沒有網際網路連線的伺服器,以便完成安裝程序。
  4. 在入口網站伺服器上執行命令提示字元並執行下列 cURL 指令,測試與 Edge 管理伺服器之間的連線:
    > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}



    請務必指定 Edge 安裝專用的主機名稱和通訊埠編號。通訊埠 8080 是 Edge 使用的預設通訊埠。如果連接至雲端的機構,則要求網址為:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    如果成功,這個指令會傳回類似以下的回應:
    {
    "createAt" : 1348689232699,










3. 使用自動化安裝指令碼安裝開發人員 Channel Services

請按照下列程序,透過自動安裝指令碼安裝入口網站。這項程序適用於無論是否有外部網際網路連線,

  1. 以超級使用者或超級使用者身分登入伺服器。
  2. 建立安裝檔案的目錄,例如 portal
  3. 在網路連線的伺服器上:
    1. CD 至新的入口網站目錄,並下載開發人員 Channel Services DeveloperServices_x.y.z.tar 檔案,其中 x.y.z 會對應至入口網站版本號碼。

      您可以透過瀏覽器中的 Apigee 傳送給您的連結下載檔案,或是複製檔案並新增至下列 cURL 指令:
      > curl -kOL <paste link here>
    2. 使用下列指令擷取 Developer Channel Services .tar 檔案的內容:
      > tar -xvf <tar file>
    3. CD 至 DeveloperServices-4.x.y.z
    4. 使用下列指令執行安裝指令碼:
      > ./networked-install.sh
  4. 在沒有網際網路連線的伺服器上:
    1. 複製您在上方第 2 節建立的 .tar.gz 檔案。確認您的系統符合系統需求。
    2. 使用下列指令擷取 .tar.gz 檔案的內容:
      > tar -xvf <tar file>
    3. CD 儲存至由 tar 指令建立的目錄。
    4. install-from-rpm-bundle.sh 指令碼上設定權限:
      > chmod 755 install-from-rpm-bundle.sh
    5. 使用下列指令執行 install-from-rpm-bundle.sh 指令碼:
      >./install-from-rpm-bundle.sh
  5. 回答提示問題。
  6. 安裝完成後,在瀏覽器中前往伺服器網址,例如:
    http://localhost。如果您已設定特定 IP 或 DNS,請前往 http://IP_addresshttp://DNS_name

    系統會將您重新導向至 Apigee 設定檔資料庫設定頁面。

    注意:通常您已設定主機名稱,並向 DNS 伺服器註冊該主機名稱,因此無需使用 http://localhost
  7. 設定與 MySQL 的連線。如果 MySQL 位於遠端電腦,請展開「進階選項」區段,輸入與該機器的連線資訊,然後選取「儲存並繼續」
  8. 輸入下列資訊即可設定 Apigee 端點的連線,然後選取「儲存」
    如要進一步瞭解這些值,請參閱「開發人員服務入口網站需求」的「開始安裝前需要的資訊」。
    1. 開發人員入口網站機構
    2. 開發人員入口網站端點網址
    3. 端點驗證使用者
    4. 已驗證使用者的密碼
  9. 出現提示時,選取「Install Sample SmartDocs WADL」按鈕,安裝範例 SmartDocs WADL。如果您略過這個步驟,入口網站就不會顯示範例 SmartDocs API。
    注意:如果您的入口網站會連線至 Apigee Edge for Private Cloud 的安裝,且 Edge 的安裝沒有外部網際網路連線,則您必須先執行 SmartDocs 模組的其他設定,才能使用 SmartDocs。如要進一步瞭解 SmartDocs,請參閱 http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis
  10. 調整 SMTP 伺服器設定。Apigee 會要求您設定 SMTP 伺服器,以便從入口網站傳送電子郵件。
    詳情請參閱 http://apigee.com/docs/developer-services/content/configuring-email
  11. 如要設定管理員使用者,請輸入以下資訊,然後選取「儲存」。請注意,Drupal 建立名為「admin」的管理員使用者,因此請勿使用「admin」做為使用者名稱。
    即使略過這個步驟,你仍可使用 Drush 建立管理員,詳情請參閱下方的第 4 節說明。建立管理員使用者。
    1. 開發人員的姓名
    2. 開發人員的入口網站使用者名稱
    3. 密碼
    4. 電子郵件地址
  12. 安裝完成後,請在 settings.php 檔案上設定權限:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. 前往入口網站的 http://localhost/ 或入口網站的 DNS 名稱。
  14. 使用管理員憑證登入入口網站。

4. 建立管理員使用者

使用 Drush 建立開發人員 Channel Services 安裝作業的管理使用者。根據預設,Drupal 會自動建立名為「admin」的管理員使用者,因此請勿使用「admin」做為使用者名稱。

  1. CD 至您的 drupal_root/sites/預設目錄。Drupal 根目錄的標準位置為 /var/www/html:
    > cd <drupal_root>/sites/default
  2. 確認您具備私人 Drupal 檔案的寫入權限:
    > drush vget file_private_path

    這個指令會傳回私人 Drupal 檔案的路徑,例如:
    file_private_path: 'sites/default/private'

    對應於 /var/www/html/sites/default/private/。使用下列指令來確保擁有者和群組可以寫入此目錄:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. 輸入下列指令,建立管理員使用者,並將「< >」中的指令替換為適當的值:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush 使用者-add-role Admin <username>
  4. 使用您在上方指定的使用者名稱和密碼,以管理員的身分登入開發人員入口網站。

5. 設定 MySQL 根密碼

如果於入口網站安裝時安裝 MySQL,安裝指令碼會保留 MySQL 根密碼的預設值 (空白)。

使用下列指令設定根密碼:

> mysqladmin -u root password NEWPASSWORD

如果您先前設定過根密碼,但想要變更,請使用下列指令:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

您也必須更新 /var/www/html/sites/default/settings.php 檔案中的密碼。

6. 確認已啟用更新管理員模組

如要接收 Drupal 更新通知,請確認已啟用 Drupal Update Manager 模組。在 Drupal 選單中選取「Modules」,然後向下捲動至「Update Manager」模組。如果尚未啟用,請啟用。

啟用後,您可以前往「報表」>「可用的更新」選單項目,查看可用的更新。您也可以使用下列 Drush 指令:

> drush pm-info update

使用「Reports」(報表) >「Available Updates」(可用更新) >「Settings」(設定) 選單項目來設定模組,讓系統在有可用更新時透過電子郵件通知您,以及設定檢查更新的頻率。

7. 選用 - 在實際工作環境伺服器上部署

如果您在實際工作環境伺服器上部署入口網站,則應執行額外的安全性步驟,包括:

  1. 執行下列指令碼,保護 MySQL 安裝作業安全:
    > /usr/bin/MySQL_secure_installation

    這個指令碼會設定根密碼,讓您選擇僅限 localhost 存取,以及移除測試資料庫和預設建立的匿名使用者。強烈建議您針對實際工作環境的伺服器執行這個指令碼。
  2. 如果公司政策要求,請啟用及設定 SELinux。

8. 選用 - 設定 Apache Solr 搜尋引擎

根據預設,當您安裝入口網站時,系統會停用連結至 Apache Solr 搜尋引擎的 Drupal 模組。大多數的入口網站使用 Drupal 搜尋引擎,因此不需要 Drupal Solr 模組。

如果您決定使用 Solr 做為搜尋引擎,就必須在伺服器上本機安裝 Solr,然後在入口網站上啟用並設定 Drupal Solr 模組。

如要啟用 Drupal Solr 模組:

  1. 以具備管理員或內容建立權限的使用者登入入口網站。
  2. 在「Drupal」選單中選取「Modules」
  3. 啟用 Apache Solr Framework 模組和 Apache Solr Search 模組。
  4. 儲存變更。
  5. 請按照 https://drupal.org/node/1999280 的說明設定 Solr。

9. 選用 - 安裝 mod_ssl 來支援 HTTPS

Apache HTTP Server 會使用 mod_ssl 模組透過 HTTPS 提供網頁。如果您想使用 HTTPS,請執行以下指令安裝 mod_ssl

> yum install mod_ssl

如要進一步瞭解如何設定入口網站以使用 SSL,請參閱 http://apigee.com/docs/developer-services/content/using-ssl-portal

10. 選用 - 安裝 SmartDocs

SmartDocs 可讓您在 Developer Services 入口網站上以完全互動的方式提供 API 說明文件,藉此記錄您在 Developer Services 入口網站中的 API。不過,您必須先在 Edge 上安裝 SmartDocs,才能透過入口網站使用 SmartDocs。

  • 如要將入口網站連線至 Edge Cloud 安裝項目,代表裝置已安裝 SmartDocs,您不需要再進一步設定。
  • 如要將入口網站連結至 Edge for Private Cloud 安裝作業,請務必確認已在 Edge 上安裝 SmartDocs。如要進一步瞭解如何安裝 Edge 和 SmartDocs,請參閱安裝 SmartDocs

如要進一步瞭解 SmartDocs,請參閱「使用 SmartDocs 記錄 API」。

11. 接下來要我為你做什麼呢?

安裝 Developer Services 入口網站後,您可以依自身需求設定及自訂入口網站。Apigee 網站上的說明文件包含設定、樣式和管理入口網站的所有資訊。如要查看說明文件,請前往 http://apigee.com/docs/developer-services/content/what-developer-portal

下表列出您在安裝後最常執行的部分常見工作,並提供 Apigee 說明文件的連結,該說明文件可讓您進一步瞭解相關資訊:

工作

說明

自訂主題

主題會定義入口網站的外觀,包括顏色、樣式和其他視覺元素。

自訂外觀

首頁包含主選單、歡迎訊息、頁首、頁尾和標題。

新增及管理使用者帳戶

註冊程序可控管新開發人員在入口網站上註冊帳戶的方式。舉例來說,新的開發人員可以立即存取入口網站,或是需要經過管理員驗證。這項程序也能控管入口網站管理員在建立新帳戶時的通知方式。

設定電子郵件

入口網站會針對特定事件傳送電子郵件。例如,有一位新開發人員在入口網站註冊,以及開發人員遺失自己的密碼。

新增及管理使用者帳戶

新增《條款及細則》頁面,開發人員必須先接受這些條款,才能存取入口網站。

新增及管理使用者帳戶

入口網站會實作角色型授權模型。在允許開發人員註冊之前,請先定義入口網站使用的權限和角色。

新增網誌和論壇貼文

入口網站內建對網誌和討論串論壇的支援,定義查看、新增、編輯及刪除網誌和論壇文章所需的權限。

確保進行資料庫備份

請務必備份 Drupal 資料庫。請注意,由於每次安裝項目都不同,因此您可以選擇如何以最佳方式備份資料庫。

設定主機名稱

如果您沒有在 DNS 伺服器上設定主機名稱,您隨時可以透過伺服器的 IP 位址存取網站。如果您想使用主機名稱,可以為伺服器設定 DNS。基本設定應可正常運作,無須進行任何其他設定。

如果您設定了負載平衡器,或因為其他原因而在網站上取得錯誤網址,可以在開發人員入口網站的 settings.php 檔案中設定 $base_url,根據預設,該檔案位於 /var/www/html/sites/default 目錄中。