⚙️
Cloudflare Workers & Pages 環境変数周りの備忘録
はじめに
Cloudflare Workers & Pagesを扱う上で、環境変数の指定方法がいくつかあります。
毎回設定する際にこんがらがりそうなので、この記事で要点をまとめます。
※公式ドキュメント参照
開発環境における環境変数
.dev.varsに環境変数を書く
プロジェクトに.dev.varsというファイルを作成し、.env.localといった一般的に使われる環境変数管理ファイルと同じノリで環境変数を書く手法です。
個人的に開発時はこれがいいと思います。
ex.
DATABASE_URL="~~~"
SECRET_KEY="~~~"
wrangler.toml | wrangler.jsoncに書く
表題の通り、cloudflareで使うwrangler.toml | jsoncにも書くことができます。
ex.
[vars]
PUBLIC_URL = "~~~"
デプロイ環境における環境変数
開発環境では.dev.vars
や、wrangler.toml
といったファイル上での管理で環境変数が使えましたが、デプロイ環境では使えないので、下記の方法で設定します。
CloudflareのダッシュボードからGUIで設定する
https://dash.cloudflare.com/ から、Workers & Pages > [プロジェクト] > 設定の画面に行くと、「変数とシークレット」という項目があるので、そこから環境変数を追加、編集、削除といった設定できます。
また、「環境を選択」の項目からプロダクション、プレビューと切り替えることができます。
wranglerのコマンドから設定する
下記のコマンドで設定ができます。
npx wrangler secret put <KEY>
この<KEY>
のところに環境変数のキーを打ち込みます。(例:DATABASE_URL
)
すると下記が表示され、値の入力を求められるので入力してEnterを押しましょう。
⛅️ wrangler 3.83.0
-------------------
? Enter a secret value: ›
これで設定できます。
環境変数が複数ある場合はこれを繰り返して設定していきます。
消したい場合は下記のコマンドを実行します。
npx wrangler secret delete <KEY>
結論
私個人としては、開発環境では.dev.vars、デプロイ環境ではダッシュボードのGUIから設定するのがやりやすいと感じました。
Discussion