将 FastAPI 应用部署到 Heroku
将具有加密 .env.vault 文件的 FastAPI 应用部署到 Heroku。
在此指南中，您可以在 GitHub 上找到完整的代码示例。
初始设置
安装 fastapi、uvicorn 和 gunicorn。
pip install --upgrade fastapi "uvicorn[standard]" gunicorn
创建一个包含 Web 服务器代码的 main.py 文件。
main.py
import os
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
hello = os.getenv("HELLO")
return {"Hello": hello}
添加一个 Procfile 以在 Heroku 上运行您的应用。
Procfile
web: gunicorn --workers 4 -k uvicorn.workers.UvicornWorker main:app
创建 runtime.txt。
runtime.txt
python-3.9.13
冻结您的 requirements.txt。
pip freeze > requirements.txt
设置您的 .gitignore 文件。
.gitignore
.DS_Store
.env
*.pyc
*.pyo
env/
venv/
.venv/
env*
dist/
build/
将代码提交并推送到 Heroku。
heroku create
git push heroku
部署后，您的应用将显示 { "Hello": null }，因为它还没有访问环境变量的方法。让我们在下一步中进行操作。
安装 python-dotenv-vault
pip install --upgrade python-dotenv-vault
在项目的根目录中创建一个 .env 文件。
.env
# .env
HELLO="World"
尽早地在您的应用程序中导入并配置 dotenv-vault。
main.py
from dotenv_vault import load_dotenv
load_dotenv()
import os
from fastapi import FastAPI
...
尝试在本地运行它。
uvicorn main:app --reload
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
它应该显示 { "Hello": "World" }。
太棒了！现在，os.environ 包含您在 .env 文件中定义的键和值。这涵盖了本地开发。让我们下一步解决生产环境问题。
构建 .env.vault
推送最新的 .env 文件更改，并编辑您的生产密钥。了解有关同步的更多信息
npx dotenv-vault@latest new
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 文件并重新部署即可。