danvics/zerobyte
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

updated README files

Browse source
This commit is contained in:
Jakub Trávník 2026-01-05 17:44:01 +01:00
parent 92ba5f9706
commit bfbbea3db5
2 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -86,10 +86,12 @@ Zerobyte can be customized using environment variables. Below are the available
### Secret References ### Secret References
For enhanced security, Zerobyte supports dynamic secret resolution for sensitive fields (like passwords, access keys, etc.) in volume and repository configurations. Instead of storing the encrypted secret in the database, you can use one of the following prefixes: Zerobyte supports dynamic secret resolution for **any configuration field** in volumes, repositories, and notifications. Instead of storing secrets directly, you can use:
- `env://VAR_NAME`: Reads the secret from the environment variable `VAR_NAME`. - `env://VAR_NAME`: Reads the value from environment variable `VAR_NAME`
- `file://SECRET_NAME`: Reads the secret from `/run/secrets/SECRET_NAME` (standard Docker Secrets path). - `file://SECRET_NAME`: Reads from `/run/secrets/SECRET_NAME` (Docker Secrets)
This works for passwords, access keys, private keys, webhook URLs, or any other field.
**Example:** **Example:**
When configuring an S3 repository, you can set the Secret Access Key to `env://S3_SECRET_KEY` and then provide that variable in your `docker-compose.yml`. When configuring an S3 repository, you can set the Secret Access Key to `env://S3_SECRET_KEY` and then provide that variable in your `docker-compose.yml`.

2
examples/secrets-placeholders/README.md
View file

@ -1,6 +1,6 @@
# Secret placeholders (env:// and file://) + Docker secrets # Secret placeholders (env:// and file://) + Docker secrets
Zerobyte supports **secret placeholders** in many configuration fields (repositories, volumes, notifications). Zerobyte supports **secret placeholders** in **any configuration field** (repositories, volumes, notifications).
Instead of storing raw secrets in the database, you can store a reference that gets resolved at runtime. Instead of storing raw secrets in the database, you can store a reference that gets resolved at runtime.
Supported formats: Supported formats: