環境設定

Grav では、 開発環境 や、 ステージング環境 、 本番環境 のような、異なる環境に異なる設定をサポートするため、 強力な設定機能 を拡張できます。

[!Info]
Grav 1.6 までは、環境変数は user/ フォルダに保存していました。 Grav 1.7 では、環境変数を user/env/ に移し、メンテナンスしやすくしました。既存のサイトでは、この新しい場所に環境変数を移し替えることを強く推奨します。

自動的な環境設定

ここでの意味は、環境ごとに、必要な分だけ設定の変更を提供できるということです。この良い例として、デバッグバー があります。デフォルトでは、新しいデバッグバーは、コアの system/config/system.yaml ファイルでは無効化されており、ユーザーファイルでの上書きも同様です：

user/config/system.yaml

もしこれを有効化したい場合は、 user/config/system.yaml ファイルで簡単に有効にすることができます。しかし、より良い解決策は、 localhost 経由でのアクセス時の開発環境で 有効 となり、 本番 サーバーでは 無効 になることかもしれません。

これは、簡単に実現可能です。次のファイルに、上書き設定をします：

user/env/localhost/config/system.yaml

localhost が環境のホスト名（ブラウザで入るホスト、たとえば http://localhost/your-site）であり、設定ファイルには次のように書いてください：

debugger:
  enabled: true

同様に、 CSS や Link, JS と JS モジュールなどのアセットパイプライン（結合+ミニファイ）を本番サイトでのみ有効化したいと思うかもしれません：

assets:
  css_pipeline: true
  js_pipeline: true
  js_module_pipeline: true

本番サーバーが http://www.mysite.com でアクセスできる場合、 user/env/www.mysite.com/config/system.yaml にあるファイルで、本番サイト固有の設定を提供できます。

もちろん、system.yaml への変更に限ったものではありません。 site.yaml ファイルへの あらゆる Grav 設定も上書きできますし、あらゆる プラグイン設定 さえ可能です！

[!Info]
Grav の スケジューラー を利用している場合、 localhost 環境を使うため、その設定に注意してください。

[!訳注]
スケジューラーは、ホスト名を持たないため、 localhost 環境として実行されるそうです。

プラグインの上書き

プラグインの config 設定の YAML ファイルを上書きするには、通常ファイルを上書きするのと同じ処理です。標準的な設定ファイルが、次の場所に置かれている場合：

user/config/plugins/email.yaml

その時は、ローカルテストでのみ上書きする設定を、次の場所で上書きできます：

user/env/localhost/config/plugins/email.yaml

設定は、以下のようにします：

mailer:
  engine: smtp
  smtp:
    server: smtp.mailtrap.io
    port: 2525
    encryption: none
    user: '9a320798e65135'
    password: 'a13e6e27bc7205'

テーマの上書き

テーマについても、同じ方法で上書きできます：

user/config/themes/antimatter.yaml

あらゆる環境に対して上書き可能です。たとえば、本番サイトが http://www.mysite.com のとき：

user/env/www.mysite.com/config/themes/antimatter.yaml

サーバー設定をもとにした環境設定

Grav 1.7 以降、サーバーの設定を使って環境を設定することができるようになりました。想定される利用場面としては、サーバーから、もしくはスクリプトから環境変数を設定します。ここでのスクリプトというのは、 Grav よりも前に実行され、Grav が使う環境を選択するためのものです。

環境を設定する最も簡単な方法は、 GRAV_ENVIRONMENT を使うことです。 GRAV_ENVIRONMENT の値は、ドメイン付きもしくはドメイン無しの適切なサーバー名でなければいけません。

以下の例は、localhost 向けに development 環境を選択します：

Apache2:

<VirtualHost 127.0.0.1:80>
    ...

    SetEnv GRAV_ENVIRONMENT development
</VirtualHost>

NGINX php-fpm:

location / {
    ...

   fastcgi_param GRAV_ENVIRONMENT development;
}

NGINX php-cgi:

location / {
   ...

    env[GRAV_ENVIRONMENT] = development
}

Docker:

web:
  environment:
    - GRAV_ENVIRONMENT=development

PHP:

// Set environment in setup.php or make sure it runs before Grav.
define('GRAV_ENVIRONMENT', 'development');

カスタム環境パス

Grav 1.7 より、環境設定の保存場所を変更できるようにもなりました。2つの選択肢があります：すべての環境で共通の場所を設定する、もしくは、ひとつひとつ定義する。

すべての環境について設定の場所をカスタムする

何かの理由で、環境設定のデフォルトの保存場所 user/env を使いたくない場合、 GRAV_ENVIRONMENTS_PATH 環境変数を使うことで、変更ができます。

GRAV_ENVIRONMENTS_PATH の値は、 GRAV_ROOT 以下の存在するパスでなければいけません。最後にスラッシュは付けないでください。

以下の例では、すべての環境について、 user/sites/GRAV_ENVIRONMENT に保存されます。 GRAV_ENVIRONMENT は、自動的に検出されるか、サーバー設定により手動で設定されます：

Apache2:

<VirtualHost 127.0.0.1:80>
...

    SetEnv GRAV_ENVIRONMENTS_PATH user://sites
</VirtualHost>

NGINX php-fpm:

location / {
    ...

fastcgi_param GRAV_ENVIRONMENTS_PATH user://sites;
}

NGINX php-cgi:

location / {
...

    env[GRAV_ENVIRONMENTS_PATH] = user://sites
}

Docker:

web:
  environment:
    - GRAV_ENVIRONMENTS_PATH=user://sites

PHP:

// Set environments path in setup.php or make sure that the following code runs before Grav.
define('GRAV_ENVIRONMENTS_PATH', 'user://sites');

現在の環境について設定の場所をカスタムする

ときには、あなたの環境において設定場所をカスタムすることが便利な場合もあります。

GRAV_ENVIRONMENT_PATH の値は、 GRAV_ROOT 以下の存在するパスでなければいけません。最後にスラッシュは付けないでください。 GRAV_ENVIRONMENT_PATH の値は、

次の例では、現在の環境でのみ、 user/development を使います：

Apache2:

<VirtualHost 127.0.0.1:80>
...

    SetEnv GRAV_ENVIRONMENT_PATH user://development
</VirtualHost>

NGINX php-fpm:

location / {
    ...

fastcgi_param GRAV_ENVIRONMENT_PATH user://development;
}

NGINX php-cgi:

location / {
...

    env[GRAV_ENVIRONMENT_PATH] = user://development
}

Docker:

web:
  environment:
    - GRAV_ENVIRONMENT_PATH=user://development

PHP:

// Set environment path in setup.php or make sure that the following code runs before Grav.
define('GRAV_ENVIRONMENT_PATH', 'user://development');

GRAV_ENVIRONMENT_PATH は、 GRAV_ENVIRONMENT とは違うことに気をつけてください。このため、現在のドメイン名にもとづいて自動的に環境名が設定されたくない場合は、環境名も明示的に設定する必要があります。

さらなるカスタマイズ

環境設定は、このページで解説したものよりも、さらにカスタマイズ可能です。

より詳しい情報は、続けて次のページをお読みください： マルチサイト設定.