将 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 文件并重新部署即可。