1. はじめに
Ruby on Railsを使って開発を行う際、セキュリティの観点から公開すべきでない情報（APIキー、データベースのパスワードなど）を環境変数として扱うことが推奨されます。dotenv-railsは、環境変数を手軽に管理するためのgemです。
2. dotenv-railsのインストール
まずは、新しいまたは既存のRailsプロジェクトにdotenv-railsをインストールします。Gemfileに以下の行を追加します。
gem 'dotenv-rails', groups: [:development, :test]
そして、ターミナルでbundle installを実行します。
3. .envファイルの作成と設定
プロジェクトのルートディレクトリに.envファイルを作成します。このファイルに環境変数を設定します。例えば、APIキーを環境変数として設定する場合、以下のように記述します。
MY_API_KEY=your_api_key_here
4. 環境変数の使用
環境変数はENVオブジェクトを通じて参照します。例えば、上記で設定したAPIキーを参照するには以下のようにします。
api_key = ENV["MY_API_KEY"]
5. 安全な管理
.envファイルは重要な情報を含むため、公開リポジトリにチェックインすることは避けるべきです。.gitignoreファイルに.envを追加して、Gitのバージョン管理から除外します。
echo '.env' >> .gitignore
6. 開発環境と本番環境での環境変数の管理
開発環境と本番環境で異なる環境変数を設定する場合、それぞれ専用の.envファイルを作成します。例えば、開発環境専用のファイルは.env.developmentとし、本番環境専用のファイルは.env.productionとします。これらのファイルにそれぞれの環境で使用する環境変数を記述します。
7. トラブルシューティング
dotenv-railsの使用中に問題が発生した場合、以下の点を確認してみてください。
-
.envファイルがプロジェクトのルートディレクトリに存在しているか。 -
ENV["変数名"]の"変数名"が.envファイルに設定した変数名と一致しているか。 -
bundle installを実行した後にRailsサーバーを再起動しているか。