dotenv gemの使い方

Gem Rails

GitHubにアップしたくないAPIキーやパスワード等を環境変数として設定するgem。

bkeepers/dotenv: A Ruby gem to load environment variables from `.env`.

インストール

Gemfile に追記後bundle install するだけ。

# Gemfile
...
# 追記
gem 'dotenv-rails', groups: [:development, :test]

.envファイル作成

環境変数を設定する.env ファイルを作成。

$ cd project_root_path
$ touch .env

# .env

# 設定例
GOOGLE_MAIL_ADDRESS = 'メールアドレス'
GOOGLE_APP_PASSWORD = 'パスワード'

.gitignore設定

.env ファイルがGitHubにアップされてしまっては意味が無いので.gitignore でGit管理下から除外する。

# .gitignore

...
# 追記
.env

Git管理下から.env ファイルが除外されているか確認。

$ git status --ignored
...

Ignored files:
  ...
  # git管理化から除外されている
    .env

コンソールで動作確認

環境変数が設定されるかコンソールで確認してみます。

# .env

# 追記
TEST = 'test'

$ rails c
> ENV['TEST']
=> "test"

まとめ

今後良く使うことになりそうなgemなので使い方に慣れておこうと思います。