您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
Apigee 使用網站管理服務 Pantheon 來託管雲端式開發人員服務入口網站。Pantheon 可與 Drupal 搭配使用,讓您在安全的環境中開發、測試及發布入口網站。Pantheon 的網站管理服務適用於世界各地擁有託管和開發作業需求的客戶。
以下各節說明如何使用 Pantheon 開發及管理入口網站。
存取 Pantheon 資訊主頁
當 Apigee 傳送您的入口網站網址時,您也會收到 Pantheon 資訊主頁的網址:https://dashboard.getpantheon.com/。
首次登入 Pantheon 資訊主頁時,您會到達「網站」頁面,如下所示:
您可以透過資訊主頁存取網站、設定帳戶及執行其他作業。
選取網站的圖片 (例如 apigeedocs),開啟該網站的資訊主頁:
管理環境
Pantheon 資訊主頁的頁面頂端有三種環境:「Dev」、「測試」和「直播」。下表說明每個選項。
環境 |
說明 |
---|---|
開發人員 |
Dev 環境會連線至您的 Git 存放區。您推送至 Git 的任何變更都會立即顯示在 Dev 環境中。 這個網站的網址格式如下,其中 org_name 是您的機構名稱: http://dev-{org_name}.devportal.apigee.io/ |
測試 |
「Test」環境可讓您使用「Live」環境的資料副本來測試最新的程式碼。這個環境可讓您在將程式碼變更推送至「Live」環境之前,先測試程式碼變更。 這個網站的網址格式如下,其中 org_name 是您的機構名稱: http://test-{org_name}.devportal.apigee.io/ |
即時影像 |
「即時」環境是您可供客戶存取的實際工作環境。 這個網站的網址格式如下,其中 org_name 是您的機構名稱: http://live-{org_name}.devportal.apigee.io/ |
開發入口網站內容
以下各節將說明如何製作入口網站內容。
此外,請參閱下列各節,進一步瞭解如何自訂入口網站。
您的目標 |
你可以 |
更多資訊 |
---|---|---|
變更網站的外觀和風格 |
基本:使用入口網站網站的「外觀」選單項目進行變更,例如修改標誌和網站顏色。 |
請參閱「自訂外觀」一節: |
進階:如要修改網站的完整外觀和風格,請擴充 Apigee 回應式主題。 |
請參閱「自訂主題」一節。 |
|
變更網站功能的行為 |
基本 - 使用入口網站的管理員設定變更/設定網站行為。 |
按這裡查看 Apigee 說明文件 |
進階 - 建立自訂模組以變更網站的任何行為。 |
請參閱 Drupal 說明文件中的「建立自訂模組」一節 |
Git 存放區總覽
Drupal 程式碼的 Git 存放區含有所有入口網站程式碼,並依照下列結構分類。
注意:請只修改 /sites/all
目錄中的內容,如果您修改的內容位於 /sites/all
目錄之外,升級到新版本時將會發生問題,而在檢查 Git 的變更時,可能會發生合併衝突。
Git 存放區中的資料夾 |
說明 |
---|---|
/profiles/apigee |
Apigee 維護的模組和主題,包括:
注意:請勿修改 /profiles/apigee 目錄中的內容,否則在升級至新版本時將會發生問題,而且在檢查 Git 的變更時,可能會發生合併衝突。如要瞭解 Drupal 最佳做法,請參閱「永不入侵核心」。 |
/sites/all |
您的自訂 Drupal 模組和主題。如要進一步瞭解如何管理這個資料夾中的內容,請參閱「新增自訂模組和主題」和「覆寫 Drupal 設定檔模組和主題」。 注意:請只修改 /sites/all 目錄中的內容, |
存取程式碼
如要存取 Git 中的程式碼存放區,您必須執行以下各節所述的工作:
另請參閱如何存取 Drupal 7 開發人員入口網站原始碼?
啟用伺服器的 SSH 存取權
您必須先將安全殼層金鑰上傳至 Pantheon,藉此啟用 SSH 以存取伺服器,才能使用 Git 管理 Drupal 程式碼。
如何啟用伺服器的 SSH 存取功能:
- 前往 https://dashboard.getpantheon.com/ 登入 Pantheon。
- 在資訊主頁中選取「帳戶」。
- 選取左側選單中的「SSH 金鑰」。
- 新增金鑰,然後選取「新增金鑰」。
如需協助,請選取「瞭解如何產生安全殼層金鑰」連結。
存取 Git 中的程式碼存放區
注意:如需 Git 存放區結構的總覽,請參閱 Git 存放區總覽。
如要存取 Git 中的程式碼存放區:
- 登入 Pantheon 資訊主頁。
- 在協作平台主頁面中,選取入口網站的圖示。
- Git 存放區的網址會顯示在「Connection Mode」的右側頁面,如上圖所示。
- 使用下列指令複製 Git 存放區的網址,並複製到本機開發環境:
> git clone gitURL sitename
例如:
> git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/git~/repository.]
您推送至 Git 存放區的所有程式碼變更,都會立即顯示在入口網站的 Dev 環境中。
將程式碼部署至入口網站環境
如要編寫程式碼至您的入口網站環境,請按照下列指示操作:
- 將程式碼更新推送至 Git,以立即更新 Dev 環境。
- 登入 Pantheon 並選取您的網站。
- 選取「Dev」環境。
- 選取左側選單中的「Code」</>,即可在「Commit Log」中查看程式碼變更的相關訊息:
- 選取頁面頂端的「測試」環境。
- 如果您尚未將「Dev」上傳至「Test」,系統會提示您立即進行。
- 如果您已經有「Test」環境,系統會顯示訊息,指出「Dev」的修訂版本已準備好部署:
- 如果您已將網站推送至「Live」環境,您可以選擇勾選第三個核取方塊,將即時資料庫以及開發人員上傳的任何檔案複製到「即時」中「測試」。如要依據上線上的最新資料測試程式碼變更,這個做法就很實用。
- 選取「Deploy Code from Development」按鈕。
- 在「Test」環境中測試入口網站。
- 修正任何程式碼至「Dev」環境,然後再次推送檔案至「Test」測試。
- 測試完成後,請選取頁面頂端的「Live」環境。
- 如果您尚未將「測試」上傳至「直播」,系統會提示您立即進行。
- 如果您已經有「Live」環境,系統會顯示訊息,指出「Test」的修訂版本已準備就緒,隨時可以部署。以將變更部署至「開發人員」的「測試」的方式部署這些變更。測試完成後,請將程式碼推送至「Live」環境。
瞭解詳情:
- Pantheon 會提供一系列可以檢視的直播文章。其中最重要的之一是「使用 Pantheon 工作流程」一文,其中提供如何開發、測試及推送網站總覽的總覽。
新增自訂模組和主題
您可以在下表列出的資料夾中加入自己的自訂模組和主題,藉此擴充入口網站的功能。
注意:請只修改 /sites/all 目錄中的內容,如果您修改的內容位於 /sites/all 目錄外,在檢查 Git 的變更時,可能會發生合併衝突。
模組/主題 | Git 存放區中的資料夾 | 更多資訊 (Drupal 說明文件) |
自訂模組 | sites/all/modules/custom |
建立自訂模組 |
自訂主題 | sites/all/themes |
自訂主題 主題 Drupal 7 |
在開發環境環境中新增自訂模組或主題後,您即可將其部署至「測試」來進行測試,然後套用至正式版的即時環境,詳情請參閱「將程式碼部署至入口網站環境」一文。
覆寫 Drupal 設定檔模組和主題
下列目錄中的模組和主題會覆寫 /profiles/apigee
Apigee 中維護及發布的 Drupal 設定檔模組和主題。請參閱 Git 存放區總覽。
舉例來說,您可能會想在下列情況中覆寫 Apigee Drupal 發布中的模組:
- 您想要使用不同版本的模組。
- 您想在下個排定的 Apigee 版本前導入安全性更新。
模組/主題 | Git 存放區中的資料夾 | 更多資訊 (Drupal 說明文件) |
學生提供模組 |
注意:儲存在 |
貢獻的模組
注意:這個目錄中的 Drupal 提供的模組會覆寫 |
學生提供的主題 | sites/all/themes |
提供的主題
注意:這個目錄中 Drupal 提供的主題會覆寫 |
關於 settings.php 檔案
Drupal settings.php
已提交至 Apigee Drupal 開發人員入口網站上游 Git 存放區。如要變更 sites/default/settings.php
檔案,請勿直接編輯檔案。請改為建立名為 sites/default/settings.local.php
的檔案,並在其中放置自訂程式碼。settings.php
檔案內含 sites/default/settings.local.php
。
舉例來說,按照 Pantheon 提供的操作說明為上線網站設定自訂網域時,請在 sites/default/settings.local.php
中新增必要的更新,而不是直接修改 settings.php
檔案。
保護入口網站
根據預設,與開發、測試和上線環境相關聯的入口網站會開放公開存取。這表示任何知道網站網址的人都能存取,但是可能無法註冊帳戶或登入網站。如要進一步瞭解如何控管使用者註冊作業,請參閱「新增及管理使用者帳戶」。
建議您隱藏「Dev」和「Test」網站,在完成開發前隱藏「Live」網站。Pantheon 可讓您新增使用者名稱/密碼控管機制,藉此鎖定網站,只讓具備適當憑證的使用者存取網站。
在環境的左側選單中選取「安全性」,即可為這三個環境新增鎖定功能。詳情請參閱鎖定網站。
如要為網站啟用 TLS/SSL,請參閱在入口網站上使用 TLS。
在入口網站套用 Apigee 更新
Apigee 發布新版入口網站時,Pantheon 資訊主頁會顯示一則訊息。
您通常會將更新套用至「Dev」環境,然後以測試自己程式碼變更的方式測試這些變更。例如,將「Dev」環境推送至「Test」,將即時資料從「Live」推送至「Test」,然後測試更新。
如何套用更新內容:
- 前往 https://dashboard.getpantheon.com/ 登入 Pantheon,然後選取您的網站。
- 選取「Dev」環境。
- 選取左側的「Code」</>選單項目。如有可用的 Apigee 更新,就會顯示更新項目。
- 套用更新:
-
勾選「在提取程式碼後執行 update.php」核取方塊。
-
如果可以,請勾選「Clear cache with afterPull with code is」(提取提取後清除快取之後) 核取方塊。
-
選取「Deploy Code」(部署程式碼) 按鈕。
-
- 更新完成後,請選取資訊主頁左側的「狀態」選單項目。
- 在環境的「狀態」區域中,您可能會注意到資料庫更新的錯誤,如下所示:
如果在任何環境中看到這個錯誤,請手動更新資料庫:
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 依序選取入口網站左上角的「首頁」圖示 >「執行更新」。
- 按照操作說明更新資料庫。
- 將程式碼變更推送至「Test」環境,然後按照上述說明推送至「Live」。
遷移自訂功能
假如您在入口網站中新增自訂程式碼或功能,就必須決定維護方式,以及如何將這些程式碼或功能從「Dev」移至「Test」環境。
如果是 Git 存放區中的程式碼,您可以按照「將程式碼部署至入口網站環境」一文所述的程序,將程式碼從「Dev」遷移至「測試」改為「實際執行」。
如果您已建立自訂設定,請使用下列其中一種方法遷移:
方法 | 說明 |
將設定匯出至程式碼 | 許多常見的設定能夠「匯出」到使用功能模組的程式碼。例如檢視畫面、面板、圖片快取等。 |
實作 hook_update_N() 函式 |
Drupal 使用 hook_update_N() 函式管理資料庫和設定變更。
如果擁有自訂模組,您可以:
|
另請參閱使用 Pantheon 工作流程,概略瞭解如何開發、測試及推送網站。本文內容為「 設定管理」一節。
設定自訂網域
Apigee 為入口網站提供的網域名稱預設為 apigee.io
,詳情請參閱「管理環境」一節,但這可能不是您想向客戶公開的名稱。
付費入口網站方案可以為入口網站設定自訂網域名稱 (開發人員或免費帳戶不得建立自訂網域)。如要使用自訂網域,請在 DNS 中建立 CNAME,並將網域指向 edge.apigee.getpantheon.com。
舉例來說,如要為名為 Mytech 的公司設定自訂網域:
- 調整下列 DNS 設定:
developer.mytech.com. 3600 IN CNAME Edge.apigee.getpantheon.com
這項 DNS 變更最多可能需要 48 小時才會對所有用戶端裝置生效。 - 使用資訊主頁左側的「網域 / 安全資料傳輸層 (SSL)」選單項目,將這個網域新增至「Live」環境的 Pantheon 資訊主頁。
在大多數情況下,您只為「即時」環境設定 DNS,無法針對「Dev」和「Test」設定 DNS。請勿將開發或測試環境用於實際工作環境。
詳情請參閱這裡的 Pantheon 說明文件。
新增入口網站管理員
當您收到 Apigee 傳送的電子郵件,指出您的入口網站已經準備就緒,Apigee 就會設有入口網站管理員名單。如要查看這份清單,請選取網站資訊主頁右上方的「團隊」連結。
如要新增其他管理員,請參閱建立管理員使用者。
備份入口網站
如要備份入口網站,請使用 Pantheon 資訊主頁的「備份」分頁。您可以建立隨選或自動備份。在 Pantheon 中,備份包含三個獨立的封存:資料庫、檔案和程式碼。
詳情請參閱 Pantheon 說明文件中的「備份工具」一文。
訂閱狀態更新
您可以在 status.apigee.com 訂閱 Apigee 的版本和狀態更新。按一下「訂閱更新」,在系統提示時輸入電子郵件地址等聯絡資訊,然後點選「訂閱」。在電子郵件通知管理頁面中,確認已選取「開發人員入口網站」、視需要切換其他通知設定,然後按一下「更新偏好設定」。
您可以在 http://status.getpantheon.com 訂閱 Pantheon 狀態更新和事件報告 (如服務中斷發生時)。按一下「訂閱更新」即可註冊。