Deploy a FastAPI App to Heroku

Deploy a FastAPI app with an encrypted .env.vault file to Heroku.

Initial setup

Install fastapi, uvicorn, and gunicorn.

pip install --upgrade fastapi "uvicorn[standard]" gunicorn

Create a main.py file with the web server code.

import os
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    hello = os.getenv("HELLO")
    return {"Hello": hello}

Add a Procfile to run your app on Heroku.

web: gunicorn --workers 4 -k uvicorn.workers.UvicornWorker main:app

Create runtime.txt.

python-3.9.13

Freeze your requirements.txt.

pip freeze > requirements.txt

Set up your .gitignore file.

.DS_Store
.env
*.pyc
*.pyo
env/
venv/
.venv/
env*
dist/
build/

Commit that to code and push it to Heroku.

heroku create
git push heroku

yourapp.herokuapp.com

Once deployed, your app will say { "Hello": null } as it doesn't have a way to access the environment variable yet. Let's do that next.

Install python-dotenv-vault

Install python-dotenv-vault.

pip install --upgrade python-dotenv-vault

Create a .env file in the root of your project.

# .env
HELLO="World"

As early as possible in your application, import and configure dotenv-vault.

from dotenv_vault import load_dotenv
load_dotenv()

import os
from fastapi import FastAPI
...

Try running it locally.

uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

It should say { "Hello": "World" }.

Great! os.environ now has the keys and values you defined in your .env file. That covers local development. Let's solve for production next.

Build .env.vault

Push your latest .env file changes and edit your production secrets. Learn more about syncing

npx dotenv-vault@latest new
npx dotenv-vault@latest push
npx dotenv-vault@latest open production

Use the UI to configure those secrets per environment.

www.dotenv.org

Then build your encrypted .env.vault file.

npx dotenv-vault@latest build

Its contents should look something like this.

#/-------------------.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

Set DOTENV_KEY

Fetch your production DOTENV_KEY.

npx dotenv-vault@latest keys production
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=production

Set DOTENV_KEY on Heroku using the CLI.

heroku config:set DOTENV_KEY='dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production'

Or use Heroku's UI.

www.heroku.com

Deploy

Commit those changes safely to code and deploy.

That's it! On deploy, your .env.vault file will be decrypted and its production secrets injected as environment variables‚ just in time.

yourapp.herokuapp.com

You'll know things worked correctly when you see Loading env from encrypted .env.vault in your logs. If a DOTENV_KEY is not set (for example when developing on your local machine) it will fall back to standard dotenv functionality.

heroku logs --tail