將 Flask 應用程式部署到 Heroku
使用加密的 .env.vault 檔案將 Flask 應用程式部署到 Heroku。
在本指南中，請在 GitHub 上找到完整的程式碼範例。
初始設定
pip install --upgrade flask gunicorn
建立一個包含 Web 伺服器程式碼的 index.py 檔案。
index.py
import os
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello():
hello = os.getenv("HELLO")
return f"Hello {hello}"
建立您的 wsgi.py 檔案。
wsgi.py
from index import app
if __name__ == '__main__':
app.run(debug=False)
新增一個 Procfile 以在 Heroku 上執行您的應用程式。
Procfile
web: gunicorn --workers 4 --bind 0.0.0.0:${PORT} wsgi:app
建立 runtime.txt。
runtime.txt
python-3.9.13
凍結您的 requirements.txt。
pip freeze > requirements.txt
設定您的 .gitignore 檔案。
.gitignore
.DS_Store
.env
.flaskenv
*.pyc
*.pyo
env/
venv/
.venv/
env*
dist/
build/
將程式碼提交並推送到 Heroku。
heroku create
git push heroku
部署後，您的應用程式會顯示 'Hello None'，因為它尚未有存取環境變數的方式。接下來讓我們執行此操作。
安裝 python-dotenv-vault
pip install --upgrade python-dotenv-vault
在您的專案根目錄中建立一個 .env 檔案。
.env
# .env
HELLO="World"
盡可能在您的應用程式中提前匯入並設定 dotenv-vault。
index.py
from dotenv_vault import load_dotenv
load_dotenv()
import os
from flask import Flask
...
嘗試在本地執行它。
gunicorn --workers 4 --bind 0.0.0.0:3000 wsgi:app
[2023-07-31 10:20:35 -0700] [49163] [INFO] Starting gunicorn 20.1.0
[2023-07-31 10:20:35 -0700] [49163] [INFO] Listening at: http://0.0.0.0:3001 (49163)
它應該會顯示 Hello World。
太棒了！os.environ 現在具有您在 .env 檔案中定義的金鑰和值。這涵蓋了本地開發。接下來，讓我們解決生產環境的問題。
建立 .env.vault
推送您最新的 .env 檔案變更並編輯您的生產機密。瞭解更多關於同步的資訊
npx dotenv-vault@latest push
npx dotenv-vault@latest open production
使用 UI 為每個環境設定這些機密。
然後建立您加密的 .env.vault 檔案。
npx dotenv-vault@latest build
其內容應如下所示。
.env.vault
#/-------------------.env.vault---------------------/
#/ cloud-agnostic vaulting standard /
#/ [how it works](https://dotenv.org/env-vault) /
#/--------------------------------------------------/
# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2
# production
DOTENV_VAULT_PRODUCTION="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_PRODUCTION_VERSION=2
設定 DOTENV_KEY
擷取您的生產 DOTENV_KEY。
npx dotenv-vault@latest keys production
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=production
使用 CLI 在 Heroku 上設定 DOTENV_KEY。
heroku config:set DOTENV_KEY='dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production'
或使用 Heroku 的 UI。
部署
將這些變更安全地提交至程式碼並部署。
就是這樣！在部署時，您的 .env.vault 檔案將會解密，其生產機密會及時注入為環境變數。
當您在記錄中看到 Loading env from encrypted .env.vault 時，您就會知道一切都正常運作。如果未設定 DOTENV_KEY（例如在您的本機電腦上開發時），它將會回退到標準的 dotenv 功能。
您已成功使用新的 .env.vault 標準來加密並部署您的機密。這比將您的機密分散在多個第三方平台和工具上安全得多。每當您需要新增或變更機密時，只需重建您的 .env.vault 檔案並重新部署。