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

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

前提条件

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

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

このガイドに沿って進めたい場合、以下の手順を使用して空の Symfony 3 アプリケーションを作成できます。

Symfony Standard Edition プロジェクトのインストール

composer create-project​ コマンドを使用して、Symfony Standard Edition に基づいた新しいプロジェクトをブートストラップします。これは、いくつかのサンプルコードを含む完全に機能する Symfony アプリケーションです。下記のコマンドは、最新バージョンの Symfony を使用して、symfony3-heroku​ という名前のディレクトリ内にこのプロジェクトを設定します。

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

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

$ composer create-project symfony/framework-standard-edition:^3.0 symfony3-heroku/
Installing symfony/framework-standard-edition (v3.4.28)
  - Installing symfony/framework-standard-edition (v3.4.28): Downloading: 100%

Created project in symfony3-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 ~/symfony3-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

このコマンドにより、"heroku" という名前の新しいリモートがローカル Git リポジトリに作成されます。

Procfile の作成

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

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

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

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

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

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

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

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

$ heroku config:set SYMFONY_ENV=prod
Setting config vars and restarting floating-badlands-41656... done
SYMFONY_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

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

ログ記録

デフォルトでは、Symfony アプリはアプリケーションの app/log/​ ディレクトリにログを記録しますが、Heroku では一時的なファイルシステム​を使用し、実行中のすべての dyno にわたるイベントのストリームとしてログ​を扱うので、これは理想的ではありません。Heroku では、Logplex を使用してログを処理するのが最も良い方法であり、STDERR​ または STDOUT​ に書き込むことによってログデータを Logplex に送るのが最も良い方法です。幸いにも、Symfony では優れた Monolog ライブラリをログ記録に使用するため、設定ファイルを変更するだけで新しいログの記録先を指定できます。

本番用ログ記録先の変更

Symfony で STDERR​ にログを記録するために必要なのは、app/config/config_prod.yml​ を変更することのみです。このファイルの monolog​/handlers​/nested​ セクションを探し、path​ の値を "%kernel.logs_dir%/%kernel.environment%.log"​ から "php://stderr"​ に変更します。これは次のようになります。

monolog:
    handlers:
        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()​ を使用して読み取ることができる環境変数として公開します。

バージョン 3.2 以降、Symfony では実行時における環境変数の動的解決​をサポートしているため、新しい構文を使用して環境変数を簡単に参照でき、キャッシュの心配をする必要はありません。

doctrine:
    dbal:
        url: "%env(DATABASE_URL)%"

Heroku ルーターを信頼する

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

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

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

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

これは、プロキシの信頼方式を HEADER_X_FORWARDED_AWS_ELB​ に設定することによって実現できます。

web/app.php​ で、最終的なコードは次のようになります。

…
$request = Request::createFromGlobals();
…
Request::setTrustedProxies(
    // trust *all* requests
    ['127.0.0.1', $request->server->get('REMOTE_ADDR')],

    // only trust X-Forwarded-Port/-Proto, not -Host
    Request::HEADER_X_FORWARDED_AWS_ELB
);
…

git add​、git commit​、git push heroku main​ の後、コードはリモートアドレス、サーバーポート、ホスト名、プロトコルの正しい値にアクセスできるようになります。

Nginx Web サーバーの使用

前に説明した初期デプロイ手順では、ユーザーが作成した Procfile​ が、heroku-php-apache2​ コマンドを使用してアプリケーションを起動します。Symfony Standard Edition アプリケーションにバンドルされている .htaccess​ ファイルは、URL が app.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 app.php
    rewrite ^(.*)$ /app.php/$1 last;
}

location ~ ^/(app|app_dev|config)\.php(/|$) {
    try_files @heroku-fcgi @heroku-fcgi;
    # ensure that /app.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 web/' > 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 カテゴリ​」を参照してください。