2 分鐘閱讀 | 最後修改: 0001-01-01, 0:00:00 am

全域性頁面模板

目錄結構

|-- global_page_templates/
  |-- global_page_templates.yaml

global_page_templates.yaml 檔案中可以包含一個或多個全域性頁面模板。

配置說明

每個全域性頁面模板是一個包含以下引數的物件：

引數名資料型別是否必選描述
namestring是頁面模板的名稱，也是該模板的唯一標識
contentstring是頁面模板的 HTML 內容

配置示例

- name: page403
  content: |
    <!doctype html>
    <html>
    <head>
      <title>403 For Bidden</title>
    </head>
    <body>
      ::CLIENT_IP::
    </body>
    </html>

- name: page404
  content: |
    <!doctype html>
    <html>
    <head>
      <title>404 Not Found</title>
    </head>
    <body>
      ::CLIENT_IP::
    </body>
    </html>

此配置定義了兩個全域性頁面模板，分別用於 403 和 404 錯誤頁面。

使用示例

更新配置到 OpenResty Edge 中：

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l global_page_templates -i /root/oredge-configs

從 OpenResty Edge 中匯出配置：

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l global_page_templates

示例中均使用 -l global_page_templates 來指定只匯入/匯出全域性頁面模板相關的配置。

注意事項

  1. 全域性頁面模板是一個全域性配置，為了保持與多個本地配置的相容性，在更新配置時不會執行刪除操作。

  2. 每個全域性頁面模板必須有一個唯一的名稱。

  3. 模板內容可以包含特殊佔位符，如 ::CLIENT_IP::，這些佔位符會在實際使用時被替換為相應的值。

  4. 在更新配置時，工具會比較新舊配置來確定是否需要更新。如果模板內容有變化，則會執行更新操作。

  5. 在匯入配置時，工具會先檢查配置的有效性，確保每個模板都包含 name 和 content 欄位。

  6. 在匯出配置時，工具會格式化 YAML 內容，保持模板內容的可讀性。

  7. 頁面模板可以被其他功能引用，如錯誤頁面配置、自定義響應等。

相關文件