マルチサイト設定

[!Info]
Grav は暫定的にマルチサイトをサポートしています。 しかし、マルチサイト設定を完全にサポートするには、管理パネルプラグインに、さらなるアップデートが必要です。Grav の今後のリリースで、引き続き取り組んでいきます。

マルチサイト設定とは？

マルチサイト設定とは、1つの Grav のインストールで、複数の web サイトネットワークを作成したり、管理したりできるようにする設定です。

Grav は、組み込みでマルチサイトをサポートしています。この機能は、本番サイトと開発サイトでカスタム環境変数を定義できる 基本的な環境設定 を拡張しています。

完全なマルチサイト設定により、そのファイルすべてをどこから、どのように読み込むかを変更することができます。

Grav マルチサイト設定の要件

Grav で複数のサイトネットワーク運営するために最も重要なのは、良い web サイトホスティング環境です。多くのサイトを作成しようと考えていなければ、そして多くの閲覧者を想定していなければ、レンタルサーバーでも大丈夫です。しかし、マルチサイトの性質上、サイトが増えたり、成長するにつれて、 VPS や専用サーバーが必要になるでしょう。

セットアップとインストール

始める前に、あなたの web サーバーが、複数の web サイトを運用できるかどうか確認をしてください。つまり、 Grav の root ディレクトリへのアクセス権が必要です。

1つの同じインストールから、複数の web サイトを提供するのは、 Grav の root ディレクトリに置いた setup.php ファイルをベースとして行われるので、これは必須です。

クイックスタート（初心者向け）

一度作成すれば、 setup.php は、ユーザーがページをリクエストするたびに呼ばれます。1つのインストールから複数の web サイトを提供するために、（大まかに言えば）このスクリプトは、 Grav に特定のサブサイトのためのファイル（設定ファイル、テーマファイル、プラグインファイル、ページファイル、その他のファイル）が、どこに置かれているのかを伝えなければいけません。

以下のスニペットは、左のようなリクエストが来たときに、右の対応方法をするように Grav のインストールにセットアップします。

https://<subsite>.example.com   -->   user/env/<subsite>.example.com

もしくは

https://example.com/<subsite>   -->   user/env/<subsite>

user ディレクトリではなく、その中の user/env ディレクトリを使ってください。

サブサイトに、サブディレクトリや path ベースの URL を選んだ場合、 user/env ディレクトリの中に、サブサイトごとにディレクトリを作ることだけが必要です。そのディレクトリには、少なくとも config, pages, plugins, そして themes フォルダが必要です。

web サイトネットワーク構造にサブドメインを選んだ場合、 user/env ディレクトリにサブサイトの設定をした上で、サーバー上に（ワイルドカード）サブドメインを設定しなければいけません。

どちらの方法でも、あなたのベストなセットアップを選んでください。

[!訳注]
レンタルサーバーでのサブドメイン運用において、ワイルドカードサブドメイン設定が必要かどうかは、そのレンタルサーバーの仕様によるようです。

スニペット

サブドメイン経由でサブサイトへサクセスするため、 setup.php へ setup_subdomain.php ファイルをコピーしてください。サブディレクトリ経由でサブサイトへアクセスするには、 setup_subdirectory.php ファイルをコピーしてください。

[!Tip]
setup.php ファイルは、 Grav のルートフォルダに置かなければいけません。 index.php や、 README.md ファイル、その他の Grav ファイルと同じフォルダです。

setup_subdomain.php:

<?php
/**
 * Multisite setup for subsites accessible via sub-domains.
 *
 * DO NOT EDIT UNLESS YOU KNOW WHAT YOU ARE DOING!
 */

use Grav\Common\Utils;

// Get subsite name from sub-domain
$environment = isset($_SERVER['HTTP_HOST'])
    ? $_SERVER['HTTP_HOST']
    : (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost');
// Remove port from HTTP_HOST generated $environment
$environment = strtolower(Utils::substrToString($environment, ':'));
$folder = "env/{$environment}";

if ($environment === 'localhost' || !is_dir(ROOT_DIR . "user/{$folder}")) {
    return [];
}

return [
    'environment' => $environment,
    'streams' => [
        'schemes' => [
            'user' => [
               'type' => 'ReadOnlyStream',
               'prefixes' => [
                   '' => ["user/{$folder}"],
               ]
            ]
        ]
    ]
];

setup_subdirectory.php:

<?php
/**
 * Multisite setup for sub-directories or path based
 * URLs for subsites.
 *
 * DO NOT EDIT UNLESS YOU KNOW WHAT YOU ARE DOING!
 */

use Grav\Common\Filesystem\Folder;

// Get relative path from Grav root.
$path = isset($_SERVER['PATH_INFO'])
   ? $_SERVER['PATH_INFO']
   : Folder::getRelativePath($_SERVER['REQUEST_URI'], ROOT_DIR);

// Extract name of subsite from path
$name = Folder::shift($path);
$folder = "env/{$name}";
$prefix = "/{$name}";

if (!$name || !is_dir(ROOT_DIR . "user/{$folder}")) {
    return [];
}

// Prefix all pages with the name of the subsite
$container['pages']->base($prefix);

return [
    'environment' => $name,
    'streams' => [
        'schemes' => [
            'user' => [
               'type' => 'ReadOnlyStream',
               'prefixes' => [
                   '' => ["user/{$folder}"],
               ]
            ]
        ]
    ]
];

言語の文脈を切り替えるためにサブディレクトリを使う場合、言語によって異なる設定を読み込む必要があるかもしれません。 以下の setup_subdir_config_switch.php の例を使って、 config/<lang-context>/site.yaml ファイルに言語固有の設定を置くことができます。 このようにして、 yoursite.com/de-AT/index.html により config/de-AT/site.yaml が読み込まれ、 yoursite.com/de-CH/index.html により config/de-CH/site.yaml が読み込まれ、以下同様です。

setup_subdir_config_switch.php:

<?php
/**
 * Switch config based on the language context subdir
 *
 * DO NOT EDIT UNLESS YOU KNOW WHAT YOU ARE DOING!
 */

use Grav\Common\Filesystem\Folder;

$languageContexts = [
    'de-AT',
    'de-CH',
    'de-DE',
];

// Get relative path from Grav root.
$path = isset($_SERVER['PATH_INFO'])
    ? $_SERVER['PATH_INFO']
    : Folder::getRelativePath($_SERVER['REQUEST_URI'], ROOT_DIR);

// Extract name of subdir from path
$name = Folder::shift($path);

if (in_array($name, $languageContexts)) {
    return [
        'streams' => [
            'schemes' => [
                'config' => [
                    'type' => 'ReadOnlyStream',
                    'prefixes' => [
                        '' => [
                            'environment://config',
                            'user://config/' . $name,
                            'user://config',
                            'system/config',
                        ],
                    ],
                ],
            ],
        ],
    ];
}

return [];

GPM（Grav パッケージマネージャー）とマルチサイト設定

もし GPM によりサブサイトのプラグインやテーマを管理したい場合は、 user/themes と user/pluginsの両方をキープしてください。 GPM が1つの場所で取得や更新するためです。それから、必要なアイテムを user/env/my.site.com/themes もしくは user/env/my.site.com/plugins のフォルダ下にシムリンクしてください。そして、各サブサイトごとに個々の yaml 設定ファイル user/env/my.site.com/config/plugins をセットアップしてください。

発展的な設定（上級者向け）

一度 setup.php を作成すると、2つの重要な変数にアクセスします。

1. $container, これは、まだ適切に初期化されていないGrav インスタンス です。
2. $self, これは、 ConfigServiceProvider class のインスタンスです。

このスクリプト内では、何でもできます。ただし、気をつけてほしいのは、ページがリクエストされるたびに、常に setup.php が呼ばれるということです。つまり、メモリが必要だったり、時間のかかる初期化処理は、システム全体のスローダウンにつながるため、避けるべきです。

最終的に、 setup.php は、オプショナルな環境名 environment と、 stream のコレクションである streams を持つ連想配列を返さなければいけません。 （より詳細な情報と正しい設定方法については、 ストリーム セクションをお読みください）

return [
  'environment' => '<name>',            // A name for the environment
  'streams' => [
    'schemes' => [
      '<stream_name>' => [              // The name of the stream
        'type' => 'ReadOnlyStream',     // Stream object e.g. 'ReadOnlyStream' or 'Stream'
        'prefixes' => [
          '<prefix>' => [
            '<path1>',
            '<path2>',
            '<etc>'
          ]
        ],
        'paths' => [                    // Paths (optional)
          '<paths1>',
          '<paths2>',
          '<etc>'
        ]
      ]
    ]
  ]
]

[!Warning]
非常に初期のステージでは、config 設定にも、 URI インスタンスにも、アクセスしていないことに注意してください。このため、初期化されていない class を呼び出すと、システムがフリーズしたり、予期しないエラーが出たり、データが（完全に）消えることが起こりえます。

ストリーム

Grav は、Grav 内のすべてのファイルパスを定義するため、 URI をストリームのように使います。ストリームを使うことにより、あらゆるファイルのパスのカスタマイズが簡単になります。

デフォルトでは、ストリームは次のように設定されています：

• user:// - user folder. e.g. user/
• page:// - pages folder. e.g. user://pages/
• image:// - images folder. e.g. user://images/, system://images/
• account:// - accounts folder. e.g. user://accounts/
• environment:// - current multi-site location.
• asset:// - compiled JS/CSS folder. e.g. assets/
• blueprints:// - blueprints folder. e.g. environment://blueprints/, user://blueprints/, system://blueprints/
• config:// - configuration folder. e.g. environment://config/, user://config/, system://config/
• plugins:// - plugins folder. e.g. user://plugins/
• themes:// - current theme. e.g. user://themes/
• theme:// - current theme. e.g. themes://antimatter/
• languages:// - languages folder. e.g. environment://languages/, user://languages/, system://languages/
• user-data:// - data folder. e.g. user/data/
• system:// - system folder. e.g. system/
• cache:// - cache folder. e.g. cache/, images/
• log:// - log folder. e.g. logs/
• backup:// - backup folder. e.g. backups/
• tmp:// - temporary folder. e.g. tmp/

マルチサイト設定では、いくつかのデフォルト設定は期待通りになりません。 Grav は config/streams.yaml ファイルを使い、環境設定からストリームをカスタマイズする方法を提供します。加えて、必要な場合には、独自のストリームを作成したり使ったりすることもできます。

実際のディレクトリを論理デバイスにマッピングするには、 prefixes を設定します。ここでは、具体例として、 pages, images, accounts, data, cache そして logs をサイトから分離し、その他すべてをデフォルトの場所から見つけられるようにします：

user/env/domain.com/config/streams.yaml:

schemes:
  account:
    type: ReadOnlyStream
    prefixes:
      '': ['environment://accounts']
  page:
    type: ReadOnlyStream
    prefixes:
      '': ['environment://user']
  image:
    type: Stream
    prefixes:
      '': ['environment://images', 'system://images/']
  'user-data':
    type: Stream
    prefixes:
      '': ['environment://data']
  cache:
    type: Stream
    prefixes:
      '': ['cache/domain.com']
      images: ['images/domain.com']
  log:
    type: Stream
    prefixes:
      '': ['logs/domain.com']

Grav では、 stream はオブジェクトであり、システムの物理デバイス設定を論理デバイスにマッピングするものです。これらは、 type 属性により分類されます。読み取り専用の stream に対しては、 ReadOnlyStream タイプとなり、読み書き可能な stream に対しては、 Stream タイプとなります。

たとえば、 image://mountain.jpg という stream を使う場合、 Grav は environment://images （user/env/domain.com/images） と、 system://images （system/images） を探します。つまり、 stream は他の stream の定義に使えます。

Prefixes により、いくつかの物理パス（実際のパス）をひとつの論理 stream にまとめることができます。 cache stream をよく見ると、少しだけ違うことに気づくでしょう。この場合、 cache:// は cache を解決し、 cache://images は images を解決します。

サーバー設定をもとにしたマルチサイト設定

Grav 1.7 からは、サーバー設定から初期の環境変数をカスタマイズできるようになりました。

この機能は、 たとえば docker コンテナを利用したい場合に、使用するドメインから独立させたい場合に便利です。もしくは、設定に機密事項を保存したくない場合で、サーバー設定に保存したい場合に便利です。

以下の環境変数は、 Grav が環境設定に使用するデフォルトパスのカスタマイズに使えます。初期化後、 stream は異なる場所を指し示すかもしれません。

[!Note]
環境変数もしくは PHP 定数を利用可能ですが、それらは Grav 実行される前に設定される必要があります。

変数	デフォルト	説明
GRAV_SETUP_PATH	AUTO DETECT	setup.php ファイルへのファイル名を含むカスタムパス。デフォルトでは、 Grav は GRAV_ROOT/setup.php 及び GRAV_ROOT/GRAV_USER_PATH/setup.php を探します。
GRAV_USER_PATH	user	user:// stream への相対パス
GRAV_CACHE_PATH	cache	cache:// stream への相対パス
GRAV_LOG_PATH	logs	log:// stream への相対パス
GRAV_TMP_PATH	tmp	tmp:// stream への相対パス
GRAV_BACKUP_PATH	backup	backup:// stream への相対パス

加えて、環境変数をカスタマイズする変数もあります。これらについて、より詳しいドキュメントは、 サーバー設定をもとにした環境設定 にあります。

[!Note]
これらは、 setup.php ファイルからも機能します。 define() 関数で定数にしたり、 putenv() 関数で環境変数にしたりできます。定数は、環境変数より望ましいです。 These work also from setup.php file. You can either make them constants by using define() or environment variables with putenv(). Constants are preferred over environment variables.

変数	デフォルト	説明
GRAV_ENVIRONMENT	DOMAIN NAME	環境名。たとえば、 Docker コンテナでカスタム環境をドメイン名によらず設定するのに使います。たとえば、 production や develop など。
GRAV_ENVIRONMENTS_PATH	user://env	全環境を探すパス。 user://sites のようにしたい場合に使います。 stream もしくは GRAV_ROOT からの相対パスが使えます。
GRAV_ENVIRONMENT_PATH	user://env/ENVIRONMENT	あなたの環境にカスタムロケーションを持たせたい場合にときどき便利かもしれません。

サーバー設定をもとにした config 設定の上書き

設定内に、秘密のクレデンシャル情報を保存したくない場合に、サーバーから環境変数を使って提供することもできます。

環境変数には、厳密な命名要件（ A-Z, a-z, 0-9 そして _ のみを使う）があるので、設定の上書きを機能させるには、いくつかのトリッキーなやり方が必要です。

以下は、 YAML フォーマットを使った、シンプルな設定上書きの例です：

GRAV_CONFIG: true                           # If false, the configuration here will be ignored.

GRAV_CONFIG_ALIAS__GITHUB: plugins.github   # Create alias GITHUB='plugins.github' to shorten the variable names below

GRAV_CONFIG__GITHUB__auth__method: api      # Override config.plugins.github.auth.method = api
GRAV_CONFIG__GITHUB__auth__token: xxxxxxxx  # Override config.plugins.github.auth.token = xxxxxxxx

上記の例で、 __ （2つのアンダースコア） は、変数のネスト構造を表しており、 twig 内では . （ドット）で表されるものです。

また、 setup.php 内でも環境変数を利用可能です。これにより、たとえば設定外に機密情報を保存できるようになります：

user/setup.php:

<?php

// Use following environment variables in your server configuration:
//
// DYNAMODB_SESSION_KEY: DynamoDb server key for the PHP session storage
// DYNAMODB_SESSION_SECRET: DynamoDb server secret
// DYNAMODB_SESSION_REGION: DynamoDb server region
// GOOGLE_MAPS_KEY: Google Maps secret key

return [
    'plugins' => [
        // This plugin does not exist
        'dynamodb_session' => [
            'credentials' => [
                'key' => getenv('DYNAMODB_SESSION_KEY') ?: null,
                'secret' => getenv('DYNAMODB_SESSION_SECRET') ?: null
            ],
            'region' => getenv('DYNAMODB_SESSION_REGION') ?: null
        ],
        // This plugin does not exist
        'google_maps' => [
            'key' => getenv('GOOGLE_MAPS_KEY') ?: null
        ]
    ]
];

[!Warning]
setup.php は、最初の設定に使われます。プラグインや後の設定でこれらの設定を上書きする場合、初期の値は失われます。

変数を setup.php で定義後、サーバ0にそれらを設定できます：

Apache2:

<VirtualHost 127.0.0.1:80>
    ...

    SetEnv GRAV_SETUP_PATH         user/setup.php
    SetEnv GRAV_ENVIRONMENT        production
    SetEnv DYNAMODB_SESSION_KEY    JBGARDQ06UNJV00DL0R9
    SetEnv DYNAMODB_SESSION_SECRET CVjwH+QkfnPhKgVvJvrG24s0ABi343cJ7WTPxvb7
    SetEnv DYNAMODB_SESSION_REGION us-east-1
    SetEnv GOOGLE_MAPS_KEY         XWIozB2R2GmYInTqZ6jnKuUrdELounUb4BIxYmp
</VirtualHost>

NGINX php-fpm:

location / {
    ...

    fastcgi_param GRAV_SETUP_PATH         user/setup.php;
    fastcgi_param GRAV_ENVIRONMENT        production;
    fastcgi_param DYNAMODB_SESSION_KEY    JBGARDQ06UNJV00DL0R9;
    fastcgi_param DYNAMODB_SESSION_SECRET CVjwH+QkfnPhKgVvJvrG24s0ABi343cJ7WTPxvb7;
    fastcgi_param DYNAMODB_SESSION_REGION us-east-1;
    fastcgi_param GOOGLE_MAPS_KEY         XWIozB2R2GmYInTqZ6jnKuUrdELounUb4BIxYmp;
}

NGINX php-cgi:

location / {
...

    env[GRAV_SETUP_PATH]          = user/setup.php
    env[GRAV_ENVIRONMENT]         = production
    env[DYNAMODB_SESSION_KEY]     = JBGARDQ06UNJV00DL0R9
    env[DYNAMODB_SESSION_SECRET]  = CVjwH+QkfnPhKgVvJvrG24s0ABi343cJ7WTPxvb7
    env[GDYNAMODB_SESSION_REGION] = us-east-1
    env[GGOOGLE_MAPS_KEY]         = XWIozB2R2GmYInTqZ6jnKuUrdELounUb4BIxYmp
}

Docker:

web:
  environment:
    - GRAV_SETUP_PATH=user/setup.php
    - GRAV_ENVIRONMENT=production
    - DYNAMODB_SESSION_KEY=JBGARDQ06UNJV00DL0R9
    - DYNAMODB_SESSION_SECRET=CVjwH+QkfnPhKgVvJvrG24s0ABi343cJ7WTPxvb7
    - DYNAMODB_SESSION_REGION=us-east-1
    - GOOGLE_MAPS_KEY=XWIozB2R2GmYInTqZ6jnKuUrdELounUb4BIxYmp

PHP:

putenv('GRAV_SETUP_PATH', 'user/setup.php');
putenv('GRAV_ENVIRONMENT', 'production');
putenv('DYNAMODB_SESSION_KEY', 'JBGARDQ06UNJV00DL0R9');
putenv('DYNAMODB_SESSION_SECRET', 'CVjwH+QkfnPhKgVvJvrG24s0ABi343cJ7WTPxvb7');
putenv('DYNAMODB_SESSION_REGION', 'us-east-1');
putenv('GOOGLE_MAPS_KEY', 'XWIozB2R2GmYInTqZ6jnKuUrdELounUb4BIxYmp');

この例では、サーバーは user/env/production フォルダに保存された production 環境変数も使います。