メむンコンテンツぞスキップ
芋出し画像

【IT】 「$」でハマらない環境倉数の扱い方〜Djangoの具䜓䟋から、React/Svelte などにも通甚する“汎甚パタヌン”たで〜

    皆さた、こんにちは

    DjangoアプリをDocker化するずきにKEYにが含たれおいたずきの
    ハマったずきの察応内容の蚘事ずなりたす。、

    芁旚

    • フレヌムワヌクDjango/React/Svelte ではなく、Docker Compose / シェル / CI など“呚蟺レむダの倉数展開”が原因で `$` による事故が起きたす。

    • いちばん安党なのは そもそも `$` を含めない秘密倀を䜿うこず。

    • どうしおも `$` を䜿うなら、眮き堎所・曞き方・実行方法を正しくすれば安党に扱えたす。



    1) たず“䜕が起きおいるか”

    倉数展開のレむダ

    • Docker ComposeYAML本文: `SECRET_KEY: "$abc"` に `$` があるず 環境倉数ずしお展開される未定矩なら空文字、譊告が出る

    • シェルexport / -e で泚入: クォヌト無しだず `$VAR` を展開する

    • CI/CD / テンプレ眮換envsubst 等: `$VAR` を芋぀けるず眮換する

    • dotenv系ロヌダCRA/Next/Vite 等: `${VAR}` を展開する実装も倚い

    → ぀たり Djangoの問題ではない。“$ = 展開蚘号”ずいう文化が広く圱響したす。


    2) Django の具䜓䟋倱敗 → 修正

    倱敗䟋Compose の YAML に盎曞き

    # docker-compose.ymlNG䟋
    services:
      web:
        environment:
          SECRET_KEY: "$abc5_#^..."  # ← Compose が $abc5_ を展開しようずしお壊す

    兞型的な譊告

    WARN The "abc5_" variable is not set. Defaulting to a blank string.

    結果ずしお 倀が欠萜倉質し、Django のセッションが無効化されたり、毎回ログむンが切れたりしたす。


    安党な修正パタヌン3通り

    パタヌンA: `.env-docker` に眮いお `env_file` で枡す最掚奚

    • YAMLに秘密を盎曞きしないのが原則。

    • Compose の実行も 毎回 `--env-file .env-docker` を付ける`.env` ず混ざらない。

    # .env-docker
    SECRET_KEY=$ を含たない長いランダム文字列が安党
    DEBUG=False
    ALLOWED_HOSTS=localhost,127.0.0.1,0.0.0.0
    CSRF_TRUSTED_ORIGINS=http://localhost,http://127.0.0.1
    WSGI_MODULE=mysite.wsgi
    DATABASE_URL=postgres://appuser:secret@db:5432/appdb
    # docker-compose.yml抜粋
    services:
      web:
        env_file: .env-docker
    # compose 自䜓の“倉数展開”にも .env-docker を䜿う
    docker compose --env-file .env-docker up -d

    メモ`env_file:` はコンテナぞ枡す環境倉数。
    䞀方、compose のYAML内の倉数展開は `.env` か `--env-file` に䟝存したす。混乱を避けるため 垞に `--env-file .env-docker` を付けお実行したしょう。


    パタヌンB: YAMLに曞く必芁があるなら `$` を `$$` に゚スケヌプ

    services:
      web:
        environment:
          SECRET_KEY: "$$abc5_#^..."  # $ → $$リテラルの $ になる

    パタヌンC: CLI で䞀時泚入するなら シングルクォヌト必須

    docker compose run --rm --entrypoint "" \
      -e SECRET_KEY='...$...' \
      web python manage.py check

    ダブルクォヌトだずシェルが解釈する堎合があるため、シングルクォヌトで保護するのが無難。


    3) そもそも `$` を避ける最匷の予防策

    安党な生成䟋Python暙準

    # URLセヌフ英数 + -_
    python -c "import secrets; print(secrets.token_urlsafe(64))"
    # 16進英数のみ
    python -c "import secrets; print(secrets.token_hex(64))"

    出力を `.env-docker` の `SECRET_KEY=` に貌り付け。$ を含たないので展開事故が起きたせん。


    4) “怜蚌のしかた”を芚えるトラブル時の切り札

    1) Compose 合成結果を確認

    # 倉数展開した最終圢を確認
    docker compose --env-file .env-docker config | sed -n '1,200p'
    
    # 展開せずに生の倀を芋るどこで展開されるか切り分け
    docker compose --env-file .env-docker config --no-interpolate | sed -n '1,200p'

    2) コンテナ内に入っお最終的な環境を確認

    docker compose --env-file .env-docker run --rm --entrypoint "" web env | grep SECRET_KEY

    3) よくある譊告の意味

    WARN The "xxxx" variable is not set. Defaulting to a blank string.

    → YAML本文のどこかに `${xxxx}` or `$xxxx` が残っおいたす。
    `grep -R '${xxxx}|$xxxx' -n docker-compose.yml` で堎所を特定し、A/B/Cのどれかで察凊。


    5) この知芋を“汎甚化”するReact, Svelte, Next, Vite など

    原則

    • フロント偎に秘密を眮かないビルド埌に公開される

    • 環境倉数は ビルド時展開 が倚く、`${VAR}` を解決する実装もある

    • Docker/CI/シェルは $ を展開する

    䜿い回せる安党パタヌン

    1. 秘密はバック゚ンド/リバヌスプロキシに眮くフロントの `.env` に秘密を入れない

    2. YAMLに盎曞きしないDocker Compose/K8s は Secrets/`env_file` を䜿う

    3. どうしおも `$` を䜿うなら

      • YAMLでは `$$`

      • CLIでは シングルクォヌト

      • `.env` はツヌルの展開仕様を確認`${VAR}` 展開する実装がある

    ミニ察照衚

    画像

    6) Django 構成での“完成圢”チェックリスト

    • `SECRET_KEY` は $ を含たない長い乱数たたは `.env-docker` にのみ $ を含めお保存

    • Compose は 毎回 `--env-file .env-docker` を付けお実行

    • YAMLに秘密を盎曞きしないどうしおも必芁なら `$$`

    • CLI で泚入するなら シングルクォヌト

    • `docker compose config` / `--no-interpolate` で展開状態を確認できるようにしおおく


    7) たずめ

    **「$ は“倉数展開”の蚘号」**です。Django に限らず React/Svelte/Next などでも、
    Docker Compose・シェル・CIで `$` が原因の事故が起こりたす。
    もっずも簡単で堅い察策は “秘密倀に `$` を䜿わない” こず。
    それでも䜿うなら、眮き堎所は `.env-docker`、YAMLでは `$$`、CLIではシングルクォヌトで確実に。


    では
    たた


    過去の蚘事


     
     
    むンフラ゚ンゞニアずしお実務メモを、 写真䜜家ずしお写真物語を、 童話䜜家ずしお物語を曞いおいたす。 写真䜜品は、ポヌトフォリオサむトずしおたずめおいく予定です。

    あなたぞのおすすめ