読み方 : ドットイーエヌブイファイル

.envファイル【.env file】

概要

.envファイルとは、アプリケーションの動作に必要な環境変数をキーと値のペアで記述したテキストファイルAPIキーデータベースの接続情報など、ソースコードに直接書くべきでない環境依存の設定や機密情報を管理するために広く用いられる。
.envファイルのイメージ画像

ファイルの形式はシンプルで、「項目名=値」という形式で項目名と値の対を一行ずつ記述する。例えば、「DATABASE_URL=postgresql://localhost:5432/myapp」や「API_KEY=myapikey1234」といった具合である。注釈などのコメントは先頭がナンバーサイン(#)で始まる行に記述でき、空行は無視される。

アプリケーションは起動時にこのファイルを読み込み、記述された値を環境変数として利用する。記載するのはアプリケーションの動作に必要な設定内容で、データベース接続情報、外部サービスのAPIキー、アプリケーションの動作モードなどである。プログラム本体と分けて.envファイルを作成することで、ソースコードに設定値を直接書き込む必要がなくなり、開発環境、テスト環境本番環境など異なる実行環境ごとに設定を切り替えやすくなる。

この仕組みは多くの開発フレームワークやソフトウェア開発ツールで利用されており、設定管理の方法として広く普及している。多くのプログラミング言語では、.envファイルを読み込むためのライブラリが提供されている。Node.jsの「dotenv」やPythonの「python-dotenv」などのモジュールがよく利用され、ファイルに定義された値を実行環境の環境変数として展開できる。

Dockerなどのコンテナ技術クラウド環境でも、コンテナ起動時に環境変数を指定する方法が一般的であり、.envファイルはその設定をまとめて管理する手段としてよく利用される。アプリケーションの設定を環境変数として外部から注入するという考え方は、「The Twelve-Factor App」と呼ばれるクラウドアプリケーション設計原則の中でも推奨されている。

セキュリティ上の重要な原則として、.envファイルはGitなどのバージョン管理システムリポジトリに含めてはならないというものがある。Gitの場合は .gitignore に.envファイルを追加して追跡対象から除外するのが標準的な運用とされる。代わりに、記述すべき変数名の一覧を示した.env.exampleファイルリポジトリに含め、開発者が各自の環境に合わせて.envファイルを作成する方法が用いられる。

この記事の著者 : (株)インセプト IT用語辞典 e-Words 編集部
1997年8月より「IT用語辞典 e-Words」を執筆・編集しています。累計公開記事数は1万ページ以上、累計サイト訪問者数は1億人以上です。学術論文や官公庁の資料などへも多数の記事が引用・参照されています。