ストーリー
PHPをインストールしたら必ず行う php.ini の設定ですが、
ネット上ではPHP5系の情報がたくさん出回っており、非推奨または削除された設定例が数多く困り果てていました。
良い感じにまとめてくれてるサイトが見つからなかったので、最強でベストプラクティスな php.ini 推奨設定を考えました。
異論は受け付けますので、ぜひコメントください。
参考設定
PHPでは、開発用と本番用の設定例を用意してくれています。
なんと素晴らしいことなんでしょうか。これをベースに設定します。
- https://github.com/php/php-src/blob/master/php.ini-development
- https://github.com/php/php-src/blob/master/php.ini-production
予め以前の記事で設定の差分を調べておきましたので、よかったらご覧ください。
環境
- PHP 7.4.5 (執筆時のバージョンです。)
※バージョンが異なる場合は公式サイトで有効な設定か確認してください。
開発用 php.ini
zend.exception_ignore_args = off
expose_php = on
max_execution_time = 30
max_input_vars = 1000
upload_max_filesize = 64M
post_max_size = 128M
memory_limit = 256M
error_reporting = E_ALL
display_errors = on
display_startup_errors = on
log_errors = on
error_log = /var/log/php/php-error.log
default_charset = UTF-8
[Date]
date.timezone = Asia/Tokyo
[mysqlnd]
mysqlnd.collect_memory_statistics = on
[Assertion]
zend.assertions = 1
[mbstring]
mbstring.language = Japanese
本番用 php.ini
zend.exception_ignore_args = on
expose_php = off
max_execution_time = 30
max_input_vars = 1000
upload_max_filesize = 64M
post_max_size = 128M
memory_limit = 256M
error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT
display_errors = off
display_startup_errors = off
log_errors = on
error_log = /var/log/php/php-error.log
default_charset = UTF-8
[Date]
date.timezone = Asia/Tokyo
[mysqlnd]
mysqlnd.collect_memory_statistics = off
[Assertion]
zend.assertions = -1
[mbstring]
mbstring.language = Japanese
[opcache]
opcache.enable = 1
opcache.memory_consumption = 128
opcache.interned_strings_buffer = 8
opcache.max_accelerated_files = 4000
opcache.validate_timestamps = 0
opcache.huge_code_pages = 0
opcache.preload = /var/www/preload.php
opcache.preload_user = www-data
オプションの補足
設定値だけだと何を設定しているかわからないので、各項目の補足を付け加えました。
zend.exception_ignore_args
- 開発 は
off、本番 はon - 有効にすると例外のスタックトレースに引数情報が出なくなる
- PHP7.4以降の設定
expose_php
- 開発 は
on、本番 はoff - 有効にするとHTTPヘッダに
X-Powered-By: PHP/7.4.5とPHPのバージョン情報が表示されます。
max_execution_time
- 設定値: 30(秒) デフォルト: 30(秒)
- 1リクエストあたりの最大実行時間（秒）
- コマンドラインから実行する場合のデフォルト設定は 0 です。
- サーバーの負荷を上げることを防止するのに役立ちます。
重たい処理を実行するとこの設定で引っかかるので、その場合はそのコードだけ特別にset_time_limitを呼んであげると良いかもです。
max_input_vars
- 設定値: 1000(個) デフォルト: 1000(個)
- 1リクエストで受け付ける最大の入力変数の数
-
$_GET,$_POST,$_COOKIEそれぞれ個別に適用されます。 - 設定値を超える場合は
E_WARNINGが発生し、以降の入力変数はリクエストから削除されます。
入力フォームが気が狂ったように多い画面とかは1000超えるかも😇
upload_max_filesize
- 設定値: 20M デフォルト: 2M
- 設定する単位に短縮表記を使えます
- アップロードされるファイルの最大サイズ。
スマホの写真サイズも大きいので多めにした方が良き
post_max_size
- 設定値: 128M デフォルト: 8M
- upload_max_filesize の設定値より大きくする必要がある。
- POSTデータに許可される最大サイズを設定します。
- ファイルアップロードにも影響します。
memory_limit
- 設定値: 256M デフォルト: 128M
- post_max_size の設定値より大きくする必要がある。
- memory_limit > post_max_size > upload_max_filesize
- 1リクエストあたりの最大メモリ使用量
メモリ設定はサーバーやプロジェクトによるかと思います。
最初から大量に確保するのではなく、必要に応じて上げていくのが良いのかなと思います。
error_reporting
- 開発 は
E_ALL、本番 はE_ALL & ~E_DEPRECATED & ~E_STRICT -
E_ALLは 全ての PHP エラーを表示する -
E_ALL & ~E_DEPRECATED & ~E_STRICTは 非推奨の警告エラーを除く PHP エラーを表示する。-
E_DEPRECATEDは コードの相互運用性や互換性を維持するために PHP がコードの変更を提案する。 -
E_STRICTは 実行時の注意、将来のバージョンで動作しなくなるコードについて警告する。
-
display_errors
- 開発 は
on、本番 はoff - エラーをHTML出力の一部として画面に出力するかどうかを定義します。
- セキュリティ上、本番では
off推奨
display_startup_errors
- 開発 は
on、本番 はoff -
display_errorsをonにした場合でも、PHPの起動シーケンスにおいて発生したエラーは表示されません。 - セキュリティ上、本番では
off推奨
log_errors
- エラーメッセージを、サーバーのエラーログまたはerror_logに記録するかどうかを指します。
- このオプションはサーバーに依存します。
error_log
- スクリプトエラーが記録されるファイル名です。
default_charset = UTF-8
- 設定値: UTF-8 デフォルト: UTF-8
- デフォルト文字コード設定
PHP 5.6.0 以降は "UTF-8" がデフォルトになりますが、念のため明示的に指定します。
date.timezone
- 設定値: Asia/Tokyo デフォルト: GMT
- 全ての日付/時刻関数で使用されるデフォルトのタイムゾーン。
mysqlnd.collect_memory_statistics
- 開発 は
on、本番 はoff - さまざまなメモリ統計情報の収集を有効にします。
-
phpinfo()でmysqliの統計情報を出力するかどうか
zend.assertions
- 開発 は
1、本番 は-1 - アサーションのコードを生成して実行します
- 1 アサーションのコードを生成して実行します (開発モード)
- 0 アサーションのコードは生成しますが実行時にはスキップします (実行しません)
- -1 アサーションのコードを生成せず、アサーションのコストがゼロになります (実運用モード)
mbstring.language
- 設定値: Japanese デフォルト: neutral
- mbstring で使用される言語設定のデフォルト値。
opcache の設定
本番のみ有効にします。
opcacheするとソースコードのキャッシュ、最適化して高速化が見込めます。
ソースコードを変更してもサーバーを再起動しないと変更が反映されなくなるため開発時は使用しません。
opcache.enable
- オペコード・キャッシュを有効にします。
opcache.memory_consumption
- OPcache によって使用される共有メモリ・ストレージのサイズ(MB単位)
opcache.interned_strings_buffer
- インターン (intern) された文字列を格納するために使用されるメモリ量。（MB単位）
opcache.max_accelerated_files
- OPcache ハッシュテーブルのキー（すなわちスクリプト）の最大数
opcache.validate_timestamps
- 有効にすると、OPcache は、スクリプトが更新されたか opcache.revalidate_freq 秒ごとにチェックします。
- 無効にすると、スクリプトの更新をチェックしません。
opcache.huge_code_pages
- PHPコード(textセグメント)を HUGE PAGE にコピーする機能を有効にしたり、無効にしたりできます。
- これにより、パフォーマンスは向上するはずですが、適切なOSの設定が必要です。
※適切なOS設定がいまいちわからなかったので、この設定は無効化しています。
opcache.preload
- サーバが起動した際にコンパイルされ、実行されるPHPスクリプトを指定します。
- PHP7.4以降の設定
※ここはプロジェクトに合わせて自前で用意する必要があります。これは無理に設定しなくてもokと思います。
※Laravelの場合はこちらのコードを参考にしています。 https://github.com/brendt/laravel-preload/blob/master/preload.php
opcache.preload_user
- root ユーザでコードをあらかじめロードすることは、セキュリティ上の理由から禁止されています。
- PHPの実行ユーザーを指定します。
- PHP7.4以降の設定
- Fatal Error "opcache.preload_user" has not been defined
その他
論理値
設定で使用される論理値(true, false, on, off, yes, no)は大文字・小文字は区別しないようなので、True, On等でも認識されます。
とても柔軟で素敵だと思いました😇😇😇
私のphp.iniはどこ？
ここです。
$ php --ini
Configuration File (php.ini) Path: /usr/local/etc/php
Loaded Configuration File: (none)
Scan for additional .ini files in: /usr/local/etc/php/conf.d
Additional .ini files parsed: /usr/local/etc/php/conf.d/docker-php-ext-sodium.ini
環境変数を使いたい
普通に環境変数読み込めます。
date.timezone = $TZ
さいきょうのツール爆誕！
記事と照らし合わせて手元の環境のphp.iniをチェックできるツールができました。
— suin❄️TypeScript入門書執筆中 (@suin) April 21, 2020
## 本番環境としてチェック
```
curl -sS https://t.co/264zxsg83a | php
```
## 開発環境としてチェック
```
curl -sS https://t.co/264zxsg83a | INIENV=dev php
``` pic.twitter.com/MigmzN3W1W
お手元の環境と本記事の推奨設定を照らし合わせて、差分を表示する神ツールを @suin 氏が作成してくれました。
開発用の差分チェック
$ curl -sS https://raw.githubusercontent.com/suin/php-playground/master/UcanIniAdvisory/ucan-ini-advisory.php | INIENV=dev php
本番用の差分チェック
$ curl -sS https://raw.githubusercontent.com/suin/php-playground/master/UcanIniAdvisory/ucan-ini-advisory.php | php