.envファイルは、このタブの中でのみ読み込まれます。アップロードも保存もされません。本物の.envファイルを、値を取り除きコメントを残した、コミットしても安全な.env.exampleに変換します。無料で、ブラウザー上で動作します。
.env.exampleの作り方
- ファイルを「.env」のボックスに貼り付けるか、「.envファイルを開く」を押します。「例を試す」で、サンプルが読み込まれます。
- 「値の置き換え」を選びます：なし（KEY=）、ヒント（KEY=your_key）、空の引用符（KEY=""）。
- 残すものを選びます：コメント行を残す、値の後のコメントを残す、グループ間の空行を残す、PORT=3000などの無害な値を残す。
- 必要なら、現在のファイルを「既存の.env.example」に貼り付けて、比較します。
- 「コピー」または「.env.exampleをダウンロード」を押します。
.env.exampleを残す理由
.envファイルには、アプリが必要とする設定とシークレットが入っていて、コミットしてはいけません。.env.exampleは、値を取り除いた同じキーを並べたもので、プロジェクトをセットアップする人が何を入力すべきかがわかります。ご自身のファイルのコメントを残すと、各値の用途の説明になります。
残るものと取り除かれるもの
秘密鍵のような引用符付きや複数行の値を含め、すべての値がデフォルトで取り除かれます。コメント行、値のあとのコメント、exportの接頭辞、設定をグループ分けする空行は、書いたとおりに残ります。何も追加されません。KEY=valueの形でない行と重複したキーは除外され、元のファイルを修正できるように一覧表示されます。
ヒント
- 各キーの上に、値の入手先を説明する短いコメントを追加しましょう。
- データベース、メール、決済など、関連するキーを空行でまとめましょう。
- 本物の.envが.gitignoreに記載されていることを確認してください。.gitignoreジェネレーターで作成できます。
- 設定を追加するたびに例を更新して、新しいチームメンバーが迷わないようにしましょう。
- シークレットを一度でもコミットしたことがあるなら、変更してください。あとで行を削除しても、履歴からは消えません。
こんな方に
開発者、プロジェクトを共有する学生、コードベースをクライアントに渡すフリーランサー、パスワードやキーを公開せずにセットアップ手順を伝えたい人向けです。
よくある質問
ここに本物の秘密情報を貼り付けても安全ですか？
このページはすべて端末上で動作し、貼り付けた内容をどこかに送る手段はありません。それでも、秘密情報は慎重に扱い、作業が終わったらタブを閉じてください。
一部の値を残せますか？
「無害な値を残す」をオンにすると、PORT=3000、DEBUG=false、NODE_ENV=developmentなどが残ります。キーにsecret、token、password、keyが含まれる値、URLの中にパスワードがある値、ランダムに見える長い文字列は、引き続き削除されます。
ダウンロードがenv.exampleという名前なのはなぜですか？
ブラウザは、ドットで始まる名前のファイルを保存しないため、ダウンロードはenv.exampleという名前になります。プロジェクトに追加するときに.env.exampleに名前を変えるか、コピーして新しいファイルに貼り付けてください。
古い.env.exampleが最新かどうか、どう確認しますか？
既存の.env.exampleと「比較」を開いて貼り付けます。.envにあって例にないキーと、例にあって.envにないキーが一覧表示されます。