ご利用中のプロジェクトに対する環境変数の設定は、Webの管理画面のプロジェクト詳細画面からご利用いただけます。 また、アプリケーションサイドでdotenvライブラリを利用する設定方法もございます。併せてご検討ください。
- 管理画面からの設定手順
- dotenvを利用した設定手順 (Ruby on Rails プロジェクトの場合)
- dotenvを利用した設定手順 (Node.js プロジェクトの場合)
- dotenvを利用した設定手順 (PHP プロジェクトの場合)
管理画面からの設定手順
環境変数設定機能は、Ruby on Rails、Node.js、Python、Golangプロジェクトでご利用いただけます。
管理画面にログインし、プロジェクト一覧からご利用中のプロジェクト名をクリックしてプロジェクト詳細ページを開いてください。
環境変数の設定と管理 の欄から、 設定・管理する ボタンをクリックすると、環境変数の設定ページが開きます。
追加する場合
環境変数の名前と値を入力の上、右側の + ボタンを押してください。
登録内容を反映する ボタンをクリックしてください。
ダイアログ画面が表示されますので、注意文をよくお読みの上 実行 をクリックしてください。
以上で、設定は完了です。 設定後は、ご入力いただいた環境変数が設定された状態でコンテナが起動します。
削除する場合
削除したい環境変数の右側のゴミ箱ボタンをクリックしてください。
登録内容を反映する ボタンをクリックし、ダイアログ画面の注意文をよくお読みの上 実行 をクリックしてください。
更新する場合
更新したい環境変数の値をフォームに記入してください。
登録内容を反映する ボタンをクリックし、ダイアログ画面の注意文をよくお読みの上 実行 をクリックしてください。
dotenvを利用した設定手順 (Ruby on Rails プロジェクトの場合)
使用方法
dotenv-rails という gem を使用します。 使用するにはまず、下記のような記載を Gemfile に追記してください。
gem 'dotenv-rails'
次に、 bundler で gem をインストールします。
$ bundle
SSHでログインし、ホームディレクトリ直下に下記のようなスクリプトを user_command.sh として設置してください。
#!/bin/sh
test -f ~/shared/.env && ln -s ~/shared/.env ./.env || true
export RAILS_ENV=production
bundle install --deployment --without development,test --path vendor/bundle
bin/rails db:create
bin/rails db:migrate
bin/rails assets:precompile
最後に .env ファイルをホームディレクトリ配下の shared に配置します。
touch shared/.env
使用するための基本的な設定と準備は以上です。アプリケーションをデプロイして環境変数が反映されるか確認しましょう。
なお、読み込まれるタイミングは Rails の before_configuration フックが発火するタイミングのため、それよりも前に .env を読み込む必要がある、もしくは依存している gem が事前に環境変数の設定を要求するなどの場合は、gem のドキュメント をご覧ください。
使用例
下記のように .env ファイルを用意します。
EXAMPLE='hello world!'
続いて rails console から環境変数が参照できるかを確認してみましょう。 下記のように記載した内容が出力されれば正常に動作しています。
$ cd current
$ bundle exec rails console
irb(main):001:0> ENV['EXAMPLE']
=> "hello world!"
dotenvを利用した設定手順 (Node.js プロジェクトの場合)
使用方法
dotenv というパッケージを使用します。 使用するにはまず、パッケージのインストールを行います。
npm install dotenv
次にアプリケーションの起動スクリプトや設定ファイルに下記のように dotenv を読み込む処理を追加します。
require('dotenv').config()
SSHでログインし、ホームディレクトリ直下に下記のようなスクリプトを user_command.sh として設置してください。
#!/bin/sh
test -f ~/shared/.env && ln -s ~/shared/.env ./.env || true
npm install --production
最後に .env ファイルをホームディレクトリ配下の shared に配置します。
touch shared/.env
使用するための基本的な設定と準備は以上です。アプリケーションをデプロイして環境変数が反映されるか確認しましょう。 そのほか詳細な設定については パッケージのドキュメント をご覧ください。
使用例
下記のように .env ファイルを用意します。
EXAMPLE='hello world!'
続いて node コマンドから、環境変数が参照できるかを確認してみましょう。 下記のように記載した内容が出力されれば正常に動作しています。
$ cd current
$ node
# dotenv の読み込み
> require('dotenv').config()
{ parsed: { EXAMPLE: 'hello world!' } }
# 環境変数の参照
> process.env.EXAMPLE
'hello world!'
dotenvを利用した設定手順 (PHP プロジェクトの場合)
使用方法
phpdotenv というライブラリを使用します。 使用するにはまず composer とライブラリのインストールを行います。
PHPプロジェクトでは git push によるデプロイをサポートしていないため設定はリモートのみで行います。 SSHでログインし、下記のコマンドを実行してください。
# composer のインストール (すでにご利用中の場合はスキップ)
$ curl -s http://getcomposer.org/installer | php
# vlucas/phpdotenv をインストール
$ php composer.phar require vlucas/phpdotenv
# .env ファイルを作成
touch .env
次にアプリケーションの起動スクリプトや設定ファイルに下記のように phpdotenv を読み込む処理を追加します。
(例: ホームディレクトリ直下に .env を配置して、html/index.php から使用する場合)
<?php
require_once __DIR__ . '/../vendor/autoload.php';
$dotenv = new Dotenv\Dotenv(__DIR__ . '/..');
$dotenv->load();
使用するための基本的な設定と準備は以上です。 そのほか詳細な設定については ライブラリのドキュメント をご覧ください。
使用例
下記のように .env ファイルを用意します。
EXAMPLE='hello world!'
続いて php の対話シェルを使用して、環境変数が参照できるかを確認してみましょう。 下記のように記載した内容が出力されれば正常に動作しています。
$ php -a
Interactive shell
php > require_once __DIR__ . "/vendor/autoload.php";
php > $dotenv = new Dotenv\Dotenv(__DIR__);
php > $dotenv->load();
php > echo($_ENV['EXAMPLE']);
hello world!