PST設定ファイル（2.4.8）

保存場所

設定ファイルはKUSANAGIのプロファイルディレクトリ内の以下のパスに保存されています。
(a) ユーザがカスタマイズするユーザ設定ファイル
wexal/userdir/pst.config.yaml
(b) Page Speed Technologyが自動生成するプロファイル設定ファイル(本番用)
wexal/pst.config.yaml
(c) Page Speed Technologyが自動生成するプロファイル設定ファイル(ステージング用)
wexal/pst.stg.config.yaml
(d) Davidが作成する設定ファイル(pst ai configコマンド実行により作成)
wexal/David.config.yaml
(e) Davidが作成する設定ファイル(クラスターごとに設定を集約したもの。pst ai configコマンド実行により作成)
wexal/David.cluster.数字.config.yaml

カスタマイズは (a) ユーザ設定ファイル、(c) プロファイル設定ファイル(ステージング用)、(d) Davidが作成する設定ファイル、(e) Davidが作成する設定ファイル(クラスターごと)に対して行います。
カスタマイズした内容は、設定ファイルの記述に誤りがないか確認した上でPage Speed Technologyが (b) プロファイル設定ファイル(本番用)に反映します。

以降の説明では、特に記述のない限り設定ファイルは (a) ユーザがカスタマイズするユーザ設定ファイルを指します。

※注意事項※
プロファイル設定ファイルは直接編集しないでください。
記述に誤りがあった場合には、Webサイトが表示されないといった不具合が出ることがあります。

編集方法

pst edit_configコマンドによる編集

pst edit_configコマンドを実行し、エディタを起動して設定ファイルをカスタマイズします。
編集終了後に設定ファイルの記述に誤りがない場合は、設定ファイルよりプロファイル設定ファイル(ステージング用)を自動生成します。設定ファイルの内容は即座に反映されます。
設定ファイルの記述に誤りがあった場合は、プロファイル設定ファイルは自動生成されません。編集前の設定が継続して有効となります。
その後、pst makeコマンドを実行することにより、ステージング用設定ファイルが、本番用設定ファイルに反映されます。

pst edit --productionコマンドによる編集

pst edit --productionコマンドを実行した場合、ステージング用設定ファイルではなく、本番用設定ファイルに反映します。

別の方法で設定ファイルを編集して、pst make_configコマンドで反映

設定ファイルをダウンロードしてカスタマイズするなど、別の方法で設定ファイルを編集することもできます。
カスタマイズした設定ファイルをアップロードした場合は、pst make_configコマンドを実行します。
アップロードした設定ファイルの記述に誤りがない場合は、設定ファイルよりプロファイル設定ファイルを自動生成します。設定ファイルの内容は即座に反映されます。
設定ファイルの記述に誤りがあった場合は、プロファイル設定ファイルは自動生成されません。編集前の設定が継続して有効となります。

設定の書式

pst設定ファイルは YAML で書かれています。
YAMLの基本的なフォーマットは、YAMLの解説を参照してください。
YAML

本項ではPage Speed Technologyで記述するノードを解説します。

pst

Page Speed Technologyを制御します。

型

スカラー

値

on
有効にします

off
無効にします

例

pst: on

watch

Page Speed Technologyのプロファイル監視プロセスを制御します。

型

スカラー

値

on
サーバの起動時に自動的にプロファイル監視プロセスを起動します。
off
サーバの起動時に自動的にプロファイル監視プロセスを起動しません。

例

watch: on

tdir

Page Speed TechnologyのプロファイルディレクトリにあるDocumentRootを指定します。
pst initコマンドで自動的に設定されるので、基本的に変更は不要です。

型

スカラー

値

プロファイルディレクトリ /DocumentRoot

例

tdir: /home/kusanagi/profile/DocumentRoot

odir

Page Speed Technologyで参照するオリジナルコンテンツへのシンボリックリンク名を指定します。
pst initコマンドで自動的に設定されるので、基本的に変更は不要です。

型

スカラー

値

_wexal

例

odir: _wexal

timezone

Page Speed Technologyが参照するタイムゾーンを指定します。

型

スカラー

値

タイムゾーン 書式はtzselectコマンドで調べることができます。

例

timezone: Asia/Tokyo

protocol

Page Speed Technologyを適用するプロトコルを指定します。

型

スカラー

値

http
HTTPで適用します。

https
HTTPSで適用します。httpsを指定する際は、HTTPからHTTPSに対する301リダイレクトを合わせて設定してください。リダイレクトの設定は、kusanagi sslコマンドを参照してください。

例

protocol: http

conf

Page Speed Technologyの設定ファイルのエディタ・書式を指定します。

型

マッピング

値

例

conf:
  editor: vim
  format: yaml

options

Page Speed Technologyの最適化で使用するディレクティブの種類を指定します。

型

シーケンス

値

lua

luaディレクティブを使用します。
指定されていない場合、luaノードに書かれたディレクティブは無効になります。

wp

wpディレクティブを使用します。
指定されていない場合、wpノードに書かれたディレクティブは無効になります。

apply_logged_in_user

ログイン中のユーザのセッションに対してPage Speed Technologyの最適化を有効にするか指定します。
指定されていない場合、ログイン中のユーザのセッションに対しては無効になります。

例

options:
- lua
- wp

global_exclude

Page Speed Technologyの最適化対象に含めないディレクトリを指定します。

型

シーケンス

値

パス
KUSANAGIのプロファイルのDocumentRoot (tdirノードの値) からの絶対パスで指定します。

例

global_exclude:
- /_wexal
- ~$
- /\.
- /wp-admin
- /wp-includes
- /wp-content/upgrade
- /wp-content/plugins

watch_additional_exclude

Page Speed Technologyのプロファイル監視プロセスで最適化対象に含めないディレクトリを指定します。
watch_additional_excludeに指定したディレクトリは、プロファイル監視プロセスの最適化対象にはなりませんが、スケジュール実行の対象にはなります。
逐次最適化の必要はなく、バッチ処理で最適化を行うディレクトリを指定してください。

型

シーケンス

値

パス
KUSANAGIのプロファイルのDocumentRoot (tdirノードの値) からの絶対パスで指定します。
例

watch_additional_exclude:
- /wp-content/uploads

lua

Page Speed Technologyの最適化で使用するluaディレクティブを指定します。
luaディレクティブはプロファイルで動作する全てのCMSに対して有効です。
luaディレクティブを参照してください。

型

マッピング

値

dynamicの値

fcacheの値

例

lua:
  header_filter:
  - cmd: add
    args:
    - 'page-speed-technology: on'
  body_filter:
  - cmd: shorten url

worker

Page Speed Technologyのコンテンツ最適化の方法を設定します。
workerディレクティブはプロファイルで動作する全てのCMSに対して有効です。
workerディレクティブを参照してください。

※注意事項※
workerディレクティブの変更を反映するには、プロファイル監視プロセス (watch) と最適化実行プロセス (runner) の再起動が必要です。
pst watch restart と pst runner restart を実行してください。

型

マッピング

値

imgの値

例

worker:
  img:
    "": []
    .webp: []
    .jp2: []
    .jxr: []
  css: []
  js: []

wp

Page Speed Technologyの最適化で使用するwpディレクティブを指定します。
wpディレクティブはプロファイルで動作するCMSがWordPressのときに有効です。
wpディレクティブを参照してください。

型

マッピング

値

例

wp:
  wexal_init: []
  wexal_head: []
  wexal_enqueue_opt: []
  wexal_footer: []
  wexal_flush:
  - cmd: server push external css

cron

Page Speed Technologyのスケジュール実行の方法を設定します。

型

マッピング

値

jobの値

例

cron:
  job:
  - cmd: opt_image
    args:
    - '/'
    - '--force'
    schedule:
    - '0'
    - '3'
    - '*'
    - '*'
    - '0'

overrides

上部で指定したPSTの設定を上書きします。

型

マッピング

値

例

overrides:
- name: mobile pages
  device: mobile
  path: .
  if: 1
  node:
  - lua
  patch:
  - op: remove
    path: /lua/body_filter/2/args/scripts/24
  - op: replace
    path: /lua/body_filter/2/args/scripts/10/type
    value: 'js [ jQuery is found in body ]'
  - op: add
    path: /lua/body_filter/2/args/scripts/1/method
    value: webfont
  applied:
    lua:
      fcache:
        enable: 0
        exptime: 60
      header_filter:
      - cmd: wp remove header
      body_filter:
      - cmd: wp shorten url

url

一意なURLとして認識させたいQuery Stringを指定します。
Page Speed Technologyでは基本的にQuery Stringを省いたURLを一意のURLとして認識します。しかしQuery Stringによって異なるページが生成される場合など、Query Stringによって異なる最適化を行いたい場合に使用します。
Page Speed Technologyは、指定されたQuery Stringのキーと値にマッチするものを残して、一意のURLを生成するようになります。
複数のQuery Stringを指定した場合は OR 条件となります。

型

マッピング

値

Query Stringのキーの値

例

url:
  user: .
  group: ^wp-