Skip to content

Commit

Permalink
#397 Adding a note for sensitive values
Browse files Browse the repository at this point in the history
Adding a blurb instructing the user how to configure and secure values with sensitive information.
  • Loading branch information
tim-chaffin authored and PacoVK committed Apr 27, 2024
1 parent 4bea632 commit 786109b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ Available storage backends are:
* Local filestorage `local`
* You can mount a volume into the container under ``/tapir`` to persist your data. This is highly recommended. Otherwise, you loose the data if the container gets removed.

#### Note Regarding Sensitive Data
Configuring secrets for Tapir is largely at the users discretion. It is recommended to use a secret manager like [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) or [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/) to store sensitive data like keys, passwords, connection strings, etc. Tapir needs the secret values set as environment variables, and depending on the actual runtime there are different approaches.

For example, if you're using Kubernetes, you can use [Opaque Kubernetes Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to store and manage sensitive information manually. Each secret store solution like AWS Secrets Manager, Azure Key Vault, Hashicorp Vault, etc. has its own way of injecting said secrets into Kubernetes as well. Or furthermore, you could use a [Kubernetes external secrets operator](https://external-secrets.io/latest/). It's important to follow the best practices and guidelines provided by the respective service.

You can configure Tapir passing the following environment variables:

| Variable | Description | Required | Default |
Expand Down

0 comments on commit 786109b

Please sign in to comment.