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

開發人員服務入口網站 4.16.09 版

安裝前,請先確認下列事項:

  • 您是在 64 位元版本的 Red Hat Enterprise Linux、CentOS 或 Oracle 上執行安裝作業。如要查看支援的版本清單,請按這裡。
  • 已安裝 Yum。
  • 備份現有安裝項目。如果您修改了 Drupal 核心或任何非自訂模組中的程式碼,系統會覆寫您的修改內容。包括您對 .htaccess 所做的任何變更。請假設 /sites 目錄以外的所有內容都屬於 Drupal。這項規則的例外狀況是 robots.txt;如果這個檔案存在於網頁根目錄中,系統會為您保留。繼續安裝前,請先備份整個 Drupal 網頁根目錄。預設安裝位置為 /var/www/html,但您可能在安裝時變更了位置。完成下列安裝步驟後,即可從備份還原自訂項目。

請按照下列步驟安裝開發人員管道服務入口網站。

1. 取得 Developer Channel Services 套件

前往 http://community.apigee.com/content/apigee-customer-support,然後選取「Login to your Support Portal」,透過下列任一方式索取開發人員入口網站服務 .tar 檔案:

  • 要求 Edge for Private Cloud 下載目錄的存取權。
  • 索取開發人員管道服務 .tar 檔案的網址。

2. 測試與 Apigee Edge 的連線

在入口網站伺服器的命令提示字元中執行下列 cURL 指令,測試與 Edge 管理伺服器的連線:
> curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

其中 EMAIL 和 PASSWORD 是 ORGNAME 管理員的電子郵件地址和密碼。

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

如果成功,這個指令會傳回類似以下的回應:
{
"createdAt" : 1348689232699,
"createdBy" : "USERNAME",
"displayName" : "cg",
"environments" : [ "test", "prod" ],
"lastModifiedAt" : 1348689232699,
"lastModifiedBy" : "foo@bar.com",
"name" : "cg",
"properties" : {
"property" : [ ]
},
"type" : "trial"
}

3. 移除 7.0 以下版本的 PHP

安裝指令碼會在開始安裝前,檢查系統上是否有 7.0 之前的 PHP 版本。如果存在 7.0 之前的 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

如果是 CentOS 和 Red Hat Enterprise Linux (RHEL),請使用下列指令移除 PHP 套件:

yum remove <package-name>

4. 使用自動安裝指令碼安裝開發人員管道服務

請根據您是否要在連上網際網路連線的伺服器上安裝入口網站,使用下列其中一項程序。

在連上網際網路的伺服器上:

如要在連上網際網路的伺服器上安裝開發人員管道服務,請按照下列步驟操作:

  1. 以 root 或超級使用者身分登入伺服器。
  2. 為安裝檔案建立目錄,例如 portal。
  3. 將 CD 放入新的 portal 目錄,然後下載開發人員管道服務 DeveloperServices_x.y.z.tar 檔案,其中 x.y.z 對應至入口網站版本號碼。

    您可以在瀏覽器中,透過 Apigee 傳送給您的連結下載檔案,也可以複製連結並新增至下列 cURL 指令:
    > curl -kOL <paste link here>
  4. 使用下列指令,解壓縮開發人員管道服務 .tar 檔案的內容:
    > tar -xvf <tar file>
  5. 將目錄變更為 DeveloperServices-4.x.y.z。
  6. 使用下列指令執行安裝指令碼:
    > ./networked-install.sh
  7. 回應提示。

在未連上網際網路連線的伺服器上:

首先,在有網際網路連線的系統上,建立非網路安裝指令碼:

  1. 以 root 或超級使用者身分登入已連上網路連線的系統。
  2. 建立安裝檔案的目錄,例如 portal_tar。
  3. 切換至 portal_tar 目錄,然後下載開發人員入口網站服務 DeveloperServices_x.y.z.tar 檔案,其中 x.y.z 對應至入口網站版本號碼。
  4. 使用下列指令,解壓縮開發人員管道服務 .tar 檔案的內容:
    > tar -xvf <tar file>
  5. 將目錄變更為 DeveloperServices-4.x.y.z。
  6. 使用下列指令建立入口網站 .tar.gz 檔案:
    > ./non-networked-install.sh

系統會為非網路安裝建立新的 .tar.gz 檔案。

如要在未連上網際網路連線的伺服器上安裝開發人員管道服務,請按照下列步驟操作:

      1. 以 root 或超級使用者身分登入伺服器。
      2. 為安裝檔案建立目錄,例如 portal。
      3. 切換至 portal 目錄。
      4. 將您為非網路安裝建立的 .tar.gz 檔案 (在上述程序中) 複製到 portal 目錄。
      5. 使用下列指令解壓縮 .tar.gz 檔案內容:
        > tar -xvf <tar file>
      6. 使用 cd 指令切換至 tar 指令建立的目錄。
      7. 設定 install-from-rpm-bundle.sh 指令碼的權限:
        > chmod 755 install-from-rpm-bundle.sh
      8. 使用下列指令執行 install-from-rpm-bundle.sh 指令碼:
        > ./install-from-rpm-bundle.sh
      9. 回應提示。

      5. 設定開發人員入口網站

      大部分的入口網站設定都不需要您互動,例如 Drupal 模組安裝和預設內容建立。系統會提示您設定資料庫、設定 Edge 端點,以及建立新的管理員使用者。

      如何設定開發人員入口網站:

      1. 在瀏覽器中前往伺服器網址,例如
        http://localhost。或者,如果您已設定特定 IP 或 DNS,請前往 http://IP_address 或 http://DNS_name。

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

        注意:一般來說,您應該已經設定主機名稱,並向 DNS 伺服器註冊,因此不必使用 http://localhost。
      2. 設定資料庫連線。如果資料庫位於遠端機器,請展開「Advanced Options」(進階選項) 部分,輸入該機器的連線資訊,然後選取「Save and continue」(儲存並繼續)。
      3. 輸入下列資訊,設定與 Apigee 端點的連線,然後選取「儲存」。
        如要進一步瞭解這些值,請參閱「開發人員服務入口網站規定」中的「開始安裝前須提供的資訊」。
        1. Management API 組織
        2. Management API 端點網址
        3. 端點已驗證使用者
        4. 通過驗證的使用者密碼
      4. 輸入下列資訊來設定管理員使用者,然後選取「Save」(儲存)。請注意,Drupal 預設會建立名為「admin」的管理員使用者,因此請勿使用「admin」做為使用者名稱。
        如果略過這個步驟,仍可使用 Drush 建立管理員,詳情請參閱下方第 4 步。建立管理員使用者。
        1. 開發人員姓名
        2. 開發人員入口網站使用者名稱
        3. 密碼
        4. 電子郵件地址
      5. 安裝完成後,請設定 settings.php 檔案的權限:
        > chmod 640 /var/www/html/sites/default/settings.php
      6. 前往入口網站首頁 http://localhost/ 或入口網站的 DNS 名稱。
      7. 使用管理員憑證登入入口網站。

      6. 建立管理員使用者 (選用)

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

      1. 切換至 drupal_root/sites/default 目錄。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 user-add-role Administrator <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 更新管理員模組。在 Drupal 選單中選取「Modules」,然後向下捲動至「Update manager」模組。如果尚未啟用,請啟用。

      啟用後,您可以使用「Reports」>「Available Updates」選單項目查看可用的更新。您也可以使用下列 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 可讓您在開發人員服務入口網站中記錄 API,使 API 說明文件完全互動。不過,如要搭配入口網站使用 SmartDocs,您必須先在 Edge 上安裝 SmartDocs。

      • 如果您將入口網站連線至 Edge Cloud 安裝,SmartDocs 已安裝,不需要進一步設定。
      • 如果您將入口網站連線至 Edge for Private Cloud 安裝,則必須確保 Edge 上已安裝 SmartDocs。如要進一步瞭解如何安裝 Edge 和 SmartDocs,請參閱「安裝 SmartDocs」。

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

      11. 後續步驟

      安裝開發人員服務入口網站後,下一步是根據特定需求進行設定和自訂。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 目錄。