Heroku での Symfony 4/5/6 アプリのデプロイ

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2023年03月16日(木)

前提条件
初期設定
ログ記録
環境変数
URL 書き換え
Heroku ルーターを信頼する
Nginx Web サーバーの使用
参考情報

このガイドでは、Heroku で Symfony バージョン 4 以降のアプリケーションをデプロイする手順について説明します。Heroku での PHP の使用方法については、「Heroku スターターガイド (PHP)」を参照してください。

この記事は、Symfony バージョン 4 以降に関するものです。Symfony 3 アプリケーションのデプロイを検討している場合は、「Deploying Symfony 3 apps on Heroku」(Heroku での Symfony 3 アプリのデプロイ) を参照してください。

前提条件

PHP 言語の知識
Heroku ユーザーアカウント (無料ですぐにサインアップ)
「Heroku スターターガイド (PHP)」の内容をよく理解しており、PHP、Composer、Heroku CLI がコンピュータにインストールされていること
デプロイする既存の Symfony 4 以降のアプリケーション (または、後述する空のスケルトンアプリ)

Symfony アプリケーションの作成

このガイドに沿って簡単に行いたい場合は、次の手順を使用して空の Symfony アプリケーションを作成できます。

このチュートリアルのアプリケーションは、Symfony Quick Tour (Symfony クイックツアー) ガイドに登場するものがベースになっています。この記事の手順に従う前に (または手順を進めながら) 一読することをお勧めします。

Symfony Web サイトスケルトンプロジェクトのインストール

composer create-project symfony/website-skeleton symfony-heroku コマンドを使用し、Symfony Web サイトアプリケーションスケルトンに基づいて新しいプロジェクトを作成します。これにより、Web サイトアプリケーションの基本構造が提供されます。下のコマンドは、最新バージョンの Symfony を使用して、symfony-heroku という名前のディレクトリ内にこれを設定します。

スケルトンの依存関係をダウンロードした後、インストーラーの指示に従い、データベース接続とメーラートランスポートに関するいくつかの詳細を入力します。ここでは、各プロンプトで Enter キーを押してデフォルト値を受け入れるだけでかまいません。これらの値は後からいつでも変更できます。

完了すると、Composer により、完全に機能する Symfony Web サイトプロジェクトが指定したディレクトリに設定されているので、このディレクトリに cd します。

$ composer create-project symfony/website-skeleton symfony-heroku/
Installing symfony/website-skeleton (v4.3.1.4)
  - Installing symfony/website-skeleton (v4.3.1.4): Downloading (100%)

Created project in symfony-heroku/
Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
…

$ cd symfony-heroku

Git リポジトリの初期化

ここで、Get リポジトリを初期化し、現在の状態をコミットします。

$ git init -b main
Initialized empty Git repository in ~/symfony-heroku/.git/
$ git add .
$ git commit -m "initial import"
[main (root-commit) 241cbc8] initial import
 42 files changed, 4397 insertions(+)
…

初期設定

ここからは、Heroku でアプリケーションを作成し、使用する Symfony 環境を設定した後、git push を使用して最初のデプロイを行います。

Heroku での新しいアプリケーションの作成

プッシュ先として使用できる新しい Heroku アプリケーションを作成するには、CLI の create コマンドを使用します。

$ heroku create
Creating app... done, stack is heroku-18
https://floating-badlands-41656.herokuapp.com/ | https://git.heroku.com/floating-badlands-41656.git

これでアプリケーションをデプロイする準備がほとんど整いました。次のセクションに進み、適切な環境用の設定で Symfony アプリが実行されることを確認します。

`Procfile` の作成

アプリケーションを Heroku にデプロイするには、多くの場合、正しい設定で Web サーバーを起動するために使用するコマンドを Heroku に指示する Procfile を最初に作成する必要があります。デフォルトで、Heroku は、PHP と共に Apache Web サーバーを起動して、アプリケーションを提供します。

ただし、今回の Symfony アプリケーションには特別な状況が当てはまります。ドキュメントルートは、アプリケーションのルートディレクトリではなく public/ ディレクトリにあります。

Symfony の一部の古いバージョンでは、このファイルが自動的に作成される場合がありましたが、今回はこの Procfile を明示的にアプリケーションの一部として作成する必要があります。これはいずれにしても、追加のプロセスタイプを使用し始めれば必要になることです。

web プロセスタイプ用の正しいコマンドを使用してファイルを作成し、コミットするだけです。

$ echo 'web: heroku-php-apache2 public/' > Procfile
$ git add Procfile
$ git commit -m "Heroku Procfile"

`prod` 環境で実行するための Symfony の設定

使用する環境 (dev、prod など) を明示的に設定しない場合、Symfony はコンソールコマンドで、また実行時に dev 環境をデフォルトで使用します。

常に prod 環境を使用する必要があることを認識するために、Symfony は APP_ENV 環境変数から読み取ります。heroku config 機能を使用して環境変数を設定できます。次のコマンドを実行して設定する環境設定によって、本番モードで実行することを Symfony が認識します。

$ heroku config:set APP_ENV=prod
Setting config vars and restarting floating-badlands-41656... done
APP_ENV: prod

Heroku にデプロイする

次はいよいよ、Heroku への初めてのデプロイを行います。

$ git push heroku main
…
remote: Compressing source files... done.
remote: Building source:
remote:
remote: -----> PHP app detected
remote: -----> Bootstrapping...
remote: -----> Installing system packages...
…
remote: -----> Installing dependencies...
remote:        Composer version 1.8.6
remote:        Loading composer repositories with package information
remote:        Installing dependencies from lock file
…
remote: -----> Preparing runtime environment...
remote: -----> Checking for additional extensions to install...
remote: -----> Discovering process types
remote:        Procfile declares types -> web
remote:
remote: -----> Compressing... done, 87.3MB
remote: -----> Launching...
remote:        Released v4
remote:        https://floating-badlands-41656.herokuapp.com/ deployed to Herok
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/floating-badlands-41656.git
 * [new branch]      main -> main

以上です。heroku create により提供された URL を手動で指定するか、Heroku CLI を使用して新しいブラウザウィンドウを立ち上げることによって、現在ブラウザを開いている場合、アプリケーションが応答します。

$ heroku open
Opening floating-badlands-41656... done

前に空のアプリケーションスケルトンを作成した場合は、赤色の文字で “Oops! An Error Occurred” (エラーが発生しました) を示す 404 エラーページが表示されます。これは予期される動作です。アプリケーションは完全に空であり、結果として Symfony は 404 ページを適切に表示しています。

多くの場合、アプリケーションが正しく機能するためには、追加の環境変数を設定したり、ログ記録を有効にしたりする必要があります。そのため、以下の手順に従ってデプロイの仕上げに入ります。

ログ記録

Symfony はデフォルトで、メッセージを STDERR に書き込む組み込みの簡素な PSR-3 準拠ロガーを使用するため、メッセージは Heroku のログに正しく記録されます。

代わりに Monolog をログ記録に使用している場合、デフォルトの設定では、アプリケーションの var/log/ ディレクトリにログが書き込まれますが、これは理想的ではありません。Heroku では一時的なファイルシステムを使用し、実行中のすべての dyno にわたってイベントのストリームとしてログを扱うからです。

本番用ログ記録先の変更

Monolog の出力書き込み先を STDERR にするために必要なのは、config/packages/prod/monolog.yaml を変更することのみです。stream ロガーを使用しているセクションをこのファイルから 1 つずつ見つけ出して、次のように path の値を "php://stderr" に変更します。

monolog:
    handlers:
        main:
            type: fingers_crossed
            action_level: error
            handler: nested
            excluded_http_codes: [404, 405]
        nested:
            type: stream
            path: "php://stderr"
            level: debug

git add、git commit、git push heroku main で通常どおりの変更ができるようになります。

アプリケーションログの表示

次に、heroku logs --tail を実行して、Heroku からのログのストリームをターミナルで開いたままにします。ブラウザに戻って Heroku アプリケーションに移動します。ページを更新すると、ターミナルでの Web サーバーのアクセスログと、アプリケーションがログに記録している可能性があるすべての情報が表示されます。

heroku logs --tail コマンドを終了するには、キーボードの Ctrl+C をもう一度押します。

環境変数

データベースに接続する、メールゲートウェイと通信する、あるいは単に、設定に動的に反応するなどの動作がアプリケーションに必要になります。この目的のために、Heroku ではあらゆる環境設定を、それを設定したのが開発者かアドオンかにかかわらず、PHP コードで $_ENV スーパーグローバル変数から、または getenv() を使用して読み取ることができる環境変数として公開します。

データベース資格情報、ログレベル、メールゲートウェイ情報などの環境固有情報を環境設定を使用して定義することは、Twelve-Factor App の基本原則の 1 つです。

APP_SECRET や DATABASE_URL などの一部の環境変数は、新しいアプリケーションのデフォルト設定で使用されます。たとえば、config/packages/doctrine.yaml はおそらく、次のようになります。

doctrine:
    dbal:
        # configure these for your database server
        driver: 'pdo_mysql'
        server_version: '5.7'
        charset: utf8mb4
        default_table_options:
            charset: utf8mb4
            collate: utf8mb4_unicode_ci
        url: '%env(resolve:DATABASE_URL)%'

また config/packages/framework.yaml では、APP_SECRET 環境変数が使用されます。

framework:
    secret: '%env(APP_SECRET)%'

環境変数を使用して Symfony を設定する方法は以上のとおりであり、一部の変数には、アプリの .env ファイルで事前定義されたデフォルト値があります。このファイル内の値で実行時にカスタムの値が必要なものは必ず、heroku config:set を実行することによって上書きしてください。

たとえば、本番環境で APP_SECRET を変更するには、次のようにします (これによって、32 文字のランダム文字列に設定されます)。

$ heroku config:set APP_SECRET=$(php -r 'echo bin2hex(random_bytes(16));')

一方、DATABASE_URL 環境変数は、アプリに Heroku Postgres インスタンスを追加したときに自動的に設定されます。

本番環境では symfony/dotenv パッケージを使用せず、その代わりに、すべての必要な環境変数を明示的に heroku config を使用して設定することをお勧めします。composer.json で symfony/dotenv を require から require-dev に移動すると、アプリケーションルートの .env ファイルが最初に選ばれないことが保証されます。これは、Symfony のドキュメントにあるデプロイ後の手順 B の 2 番目のオプションに対応しています。

URL 書き換え

Symfony 4 以降のアプリケーションには .htaccess やその他の設定が含まれなくなったため、パス内に index.php スクリプトを必要としない方法で URL を書き換えることができます。

Apache Web サーバー用の書き換えをすばやく有効にするために、symfony/apache-pack レシピをインストールできます。これにより、適切な .htaccess ファイルが public/ ディレクトリに配置されます。

$ composer require symfony/apache-pack
$ git add composer.json composer.lock symfony.lock public/.htaccess
$ git commit -m "apache-pack"

git push heroku main を使用してこの変更をデプロイした後は、/index.php をパスに含めなくてもアプリケーションの任意の URL にアクセスできるようになります。

Heroku ルーターを信頼する

Heroku の HTTP ルーティングは、特にロードバランシングと SSL 接続の終了を担っているリバースプロキシのレイヤーを通過するように各リクエストをルーティングします。これは、dyno が受信したリクエストの REMOTE_ADDR 環境変数には最後のルーターの IP アドレスが含まれ、元のリクエストが HTTPS で送信されるようになっていても、内部リクエストは常に HTTP プロトコルを使用するように強制されるということを意味します。

ほとんどの一般的なロードバランサーまたはリバースプロキシと同様に、Heroku は元のリクエスト情報を X-Forwarded-… ヘッダーで提供します (ここ)を参照)。Symfony では簡単に、そのようなヘッダーを信頼することを設定できます。

Heroku はすべてのリクエストを最初にロードバランサーを通じてアプリケーションに送信し、そのロードバランサーが常にヘッダーを設定するので (クライアントがそれらの値を偽造することを不可能にします)、index.php で信頼されるプロキシとして現在のリモートアドレス (これが Heroku ルーター) を扱うように Symfony を設定できます。

Heroku のルーターは Forwarded および X-Forwarded-Host ヘッダーを設定しないので、Symfony がこれらのヘッダーを信頼できないようにすることも重要ですが、Symfony は信頼されるプロキシが設定された後、すぐにそれらを信頼します。

これは、プロキシ信頼方式を HEADER_X_FORWARDED_AWS_ELB に設定することによって実現できます。この設定値は、代替表記 Request::HEADER_X_FORWARDED_ALL ^ Request::HEADER_X_FORWARDED_HOST の短縮形です。

デフォルトでは、public/index.php にはすでに、TRUSTED_PROXIES 環境変数を使用してアプリケーションのこの側面をすばやく設定するセクションが含まれており、許容されるヘッダーの正しい組み合わせである Request::HEADER_X_FORWARDED_ALL ^ Request::HEADER_X_FORWARDED_HOST を使用します。

…
if ($trustedProxies = $_SERVER['TRUSTED_PROXIES'] ?? $_ENV['TRUSTED_PROXIES'] ?? false) {
    Request::setTrustedProxies(explode(',', $trustedProxies), Request::HEADER_X_FORWARDED_ALL ^ Request::HEADER_X_FORWARDED_HOST);
}
…

ただし、リクエストを dyno に転送する、Heroku ルーティングノードの内部リモートアドレスは毎回異なったものになるので、prod 環境でアプリケーションを実行している場合は、信頼済みプロキシのリストにこのアドレスを手動で追加する必要があります。

(たとえば、CDN の使用時に) 追加の信頼済みプロキシ IP 範囲を設定できるようにしたまま、同時に Heroku ルーターを信頼するために、TRUSTED_PROXIES 環境変数を読み取る既存のロジックを、アプリケーション環境に応じて REMOTE_ADDR を条件付きでリストに追加する動作と組み合わせることができます。次に例を示します。

...
$trustedProxies = $_SERVER['TRUSTED_PROXIES'] ?? $_ENV['TRUSTED_PROXIES'] ?? false;
$trustedProxies = $trustedProxies ? explode(',', $trustedProxies) : [];
if($_SERVER['APP_ENV'] == 'prod') $trustedProxies[] = $_SERVER['REMOTE_ADDR'];
if($trustedProxies) {
    Request::setTrustedProxies($trustedProxies, Request::HEADER_X_FORWARDED_AWS_ELB);
}
...

このアプローチは Heroku では安全です。アプリケーションへのすべてのトラフィックが Heroku のルーターを通過しなければならないことが、リモート IP アドレスが信頼できるプロキシであることの根拠になるからです。他の環境では、これに当てはまらない場合があります。

Nginx Web サーバーの使用

前に説明した初期デプロイ手順では、ユーザーが作成した Procfile が、heroku-php-apache2 コマンドを使用してアプリケーションを起動します。symfony/apache-pack Flex レシピによってインストールされた .htaccess ファイルは、URL が index.php の “フロントコントローラー” スクリプトに正しく書き換えられることを保証します。代わりに Nginx を使用してアプリケーションを実行できます。

Nginx 設定インクルードの作成

Nginx では、Apache の .htaccess 設定に似たメカニズムはサポートされていないため、専用の設定インクルードを作成して、それを使用するように Nginx に指示する必要があります。

Symfony アプリケーションの場合、必要な書き換えは非常に簡単です。次のディレクティブを、アプリケーションのルートディレクトリにある nginx_app.conf という名前のファイルに配置できます。

location / {
    # try to serve file directly, fallback to rewrite
    try_files $uri @rewriteapp;
}

location @rewriteapp {
    # rewrite all to index.php
    rewrite ^(.*)$ /index.php/$1 last;
}

location ~ ^/index\.php(/|$) {
    try_files @heroku-fcgi @heroku-fcgi;
    # ensure that /index.php isn't accessible directly, but only through a rewrite
    internal;
}

Nginx 用 `Procfile` の作成

今回は、heroku-php-nginx スクリプトを使用し、-C オプションを使用してカスタム設定スニペットをスクリプトに渡します。

$ echo 'web: heroku-php-nginx -C nginx_app.conf public/' > Procfile
$ git add Procfile nginx_app.conf
$ git commit -m "Nginx Procfile and config"

次回の git push heroku main 以後、アプリケーションは Nginx Web サーバーを使用して実行されます。

参考情報

Heroku リファレンス (PHP) を参照して、利用可能なバージョン、拡張機能、機能、および動作について学習します。
Apache、Nginx、および PHP の設定についての詳細は、PHP の Web サーバーおよびランタイム設定のカスタマイズに関する手順を確認してください。
その他のリソースについては、「Dev Center での PHP カテゴリ」を参照してください。

Categories

Heroku での Symfony 4/5/6 アプリのデプロイ

Table of Contents

前提条件

Symfony アプリケーションの作成

Symfony Web サイトスケルトンプロジェクトのインストール

Git リポジトリの初期化

初期設定

Heroku での新しいアプリケーションの作成

`Procfile` の作成

`prod` 環境で実行するための Symfony の設定

Heroku にデプロイする

ログ記録

本番用ログ記録先の変更

アプリケーションログの表示

環境変数

URL 書き換え

Heroku ルーターを信頼する

Nginx Web サーバーの使用

Nginx 設定インクルードの作成

Nginx 用 `Procfile` の作成

参考情報

関連カテゴリー

Categories

Heroku での Symfony 4/5/6 アプリのデプロイ

Table of Contents

前提条件

Symfony アプリケーションの作成

Symfony Web サイトスケルトンプロジェクトのインストール

Git リポジトリの初期化

初期設定

Heroku での新しいアプリケーションの作成

Procfile の作成

prod 環境で実行するための Symfony の設定

Heroku にデプロイする

ログ記録

本番用ログ記録先の変更

アプリケーションログの表示

環境変数

URL 書き換え

Heroku ルーターを信頼する

Nginx Web サーバーの使用

Nginx 設定インクルードの作成

Nginx 用 Procfile の作成

参考情報

関連カテゴリー

`Procfile` の作成

`prod` 環境で実行するための Symfony の設定

Nginx 用 `Procfile` の作成