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

docs(readme): remove section about secrets and env (not released yet)

Browse source
This commit is contained in:
Nicolas Meienberger 2025-12-17 07:27:47 +01:00
parent 4ecb21e4ca
commit 1ea5c042f5
1 changed files with 0 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -148,23 +148,6 @@ Repositories are optimized for storage efficiency and data integrity, leveraging
To create a repository, navigate to the "Repositories" section in the web interface and click on "Create repository". Fill in the required details such as repository name, type, and connection settings. To create a repository, navigate to the "Repositories" section in the web interface and click on "Create repository". Fill in the required details such as repository name, type, and connection settings.
## Secret references (env:// and file://)
Any field that is normally stored encrypted in Zerobyte (passwords, tokens, access keys, etc.) also accepts secret references.
- `env://VAR_NAME` reads the value from `process.env.VAR_NAME` inside the Zerobyte container.
- `file://secret_name` reads the value from `/run/secrets/secret_name` (Docker secrets).
If you enter a normal value (not starting with `env://` or `file://`), Zerobyte will encrypt it before storing it in the database (values will look like `encv1:...`).
Examples:
In the web UI, enter the following values in the corresponding fields:
| Field | Value to enter | Description |
|-------------------|------------------------------|---------------------------------------------|
| password | `env://SMB_PASSWORD` | SMB volume password from an environment variable |
| secretAccessKey | `file://s3-secret-access-key`| S3 secret access key from a Docker secret |
### Using rclone for cloud storage ### Using rclone for cloud storage
Zerobyte can use [rclone](https://rclone.org/) to support 40+ cloud storage providers including Google Drive, Dropbox, OneDrive, Box, pCloud, Mega, and many more. This gives you the flexibility to store your backups on virtually any cloud storage service. Zerobyte can use [rclone](https://rclone.org/) to support 40+ cloud storage providers including Google Drive, Dropbox, OneDrive, Box, pCloud, Mega, and many more. This gives you the flexibility to store your backups on virtually any cloud storage service.