Secrets management

Introduction

If you are connecting to data sources, you will likely need to handle credentials or secrets. It's generally considered bad practice to store unencrypted secrets in a git repository. If your application needs access to sensitive credentials the recommended solution is to store those credentials in a file that is not committed to the repository and to pass them as environment variables.

Secrets management allows you to store secrets securely and access them in your Streamlit app as environment variables.

How to use Secrets Management

Deploy an app and set up secrets

From your workspace at share.streamlit.io, click "New app".
Fill out your app's information and click "Advanced settings..."
A modal will appear with an input box for your secrets.
Provide your secrets in the "Secrets" field using TOML format. For example:

# Everything in this section will be available as an environment variable db_username = "Jane" db_password = "12345qwerty" # You can also add other sections if you like. # The contents of sections as shown below will not become environment # variables, but they'll be easily accessible from within Streamlit anyway # as we show later in this doc. [my_cool_secrets] things_i_like = ["Streamlit", "Python"]

Use secrets in your app

Access your secrets as environment variables or by querying the st.secrets dict. For example, if you enter the secrets from the section above, the code below shows you how you can access them within your Streamlit app.

import streamlit as st
import os

# Everything is accessible via the st.secrets dict:
st.write("DB username:", st.secrets["db_username"])
st.write("DB password:", st.secrets["db_password"])
st.write("My cool secrets:", st.secrets["my_cool_secrets"]["things_i_like"])

# And the root-level secrets are also accessible as environment variables:
st.write(
    "Has environment variables been set:",
    os.environ["db_username"] == st.secrets["db_username"],
)

star

Tip

You can access st.secrets via attribute notation (e.g. st.secrets.key) or key notation (e.g. st.secrets["key"]) — just like st.session_state.

You can even use TOML sections to compactly pass multiple secrets as a single attribute.

Consider the following secrets:

[db_credentials]
username = "my_username"
password = "my_password"

Rather than passing each secret as attributes in a function, you can more compactly pass the section to achieve the same result. You can use Python's unpacking notation like the following example which uses the secrets above:

# Verbose version
my_db.connect(username=st.secrets.db_credentials.username, password=st.secrets.db_credentials.password)

# Far more compact version!
my_db.connect(**st.secrets.db_credentials)

Edit your app's secrets

If you need to add or edit your secrets for an app that is already deployed, you can access advanced setting from your admin panel.

Go to share.streamlit.io.
Click the overflow menu icon (more_vert) for your app.
Click "Settings".
A modal will appear. Click "Secrets" on the left.
After you edit your secrets, click "Save". It might take a minute for the update to be propagated to your app, but the new values will be reflected when the app re-runs.

Develop locally with secrets

When developing your app locally, add a file called secrets.toml in a folder called .streamlit at the root of your app repo, and copy/paste your secrets into that file. Further instructions are available in the Streamlit library Secrets management documentation.

priority_high

Important

Be sure to add this file to your .gitignore so you don't commit your secrets!

your-LOCAL-repository/
├── .streamlit/
│   ├── config.toml
│   └── secrets.toml # Make sure to gitignore this!
├── your_app.py
└── requirements.txt

Previous: App dependencies Next: Manage your app

forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.