dahjah/vaultwarden
1
0
Fork 0
mirror of https://github.com/dani-garcia/vaultwarden.git synced 2026-04-25 20:25:16 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

docs: document S3-compatible URI parameters and examples

Browse Source
This commit is contained in:
g-roliveira 2026-02-16 10:58:37 -03:00
parent 63b25380d8
commit 7c95c8c5c3
2 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.env.template
View File

@ -18,7 +18,23 @@
## This can be a path to local folder or a path to an external location
## depending on features enabled at build time. Possible external locations:
##
## - AWS S3 Bucket (via `s3` feature): s3://bucket-name/path/to/folder
## - S3-compatible bucket (via `s3` feature): s3://bucket-name/path/to/folder
##
## Optional query parameters are supported for S3-compatible providers:
## - endpoint (MinIO/R2/Ceph RGW): ?endpoint=https%3A%2F%2Fs3.example.internal
## - enable_virtual_host_style (set false for path-style): ?enable_virtual_host_style=false
## - default_storage_class: ?default_storage_class=STANDARD
## Use an empty value to omit the storage-class header:
## ?default_storage_class=
## - region (provider/signing specific): ?region=us-east-1
##
## Examples:
## - AWS S3 defaults: s3://bucket-name/path/to/folder
## - MinIO path-style: s3://bucket-name/path/to/folder?endpoint=http%3A%2F%2Fminio%3A9000&enable_virtual_host_style=false&default_storage_class=STANDARD
## - Cloudflare R2: s3://bucket-name/path/to/folder?endpoint=https%3A%2F%2F<accountid>.r2.cloudflarestorage.com&region=auto&default_storage_class=
##
## Credentials in URI query params are supported as a last resort, but it is
## strongly recommended to use environment credentials/IAM instead.
##
## When using an external location, make sure to set TMP_FOLDER,
## TEMPLATES_FOLDER, and DATABASE_URL to local paths and/or a remote database

30
README.md
View File

@ -111,6 +111,36 @@ services:
<br>
### S3-Compatible Object Storage
When built with the `s3` feature, storage paths like `DATA_FOLDER`, `ATTACHMENTS_FOLDER`, `ICON_CACHE_FOLDER` and `SENDS_FOLDER` can use `s3://` URIs with query parameters:
```text
s3://bucket/prefix?endpoint=https%3A%2F%2Fs3.example.internal&enable_virtual_host_style=false&default_storage_class=STANDARD
```
- AWS S3 works with defaults (no extra parameters required).
- MinIO/Ceph usually require `endpoint` and `enable_virtual_host_style=false`.
- Cloudflare R2 usually requires `endpoint` and often `region=auto`.
- To omit `x-amz-storage-class`, set `default_storage_class=` (empty value).
Kubernetes example:
```yaml
env:
- name: DATA_FOLDER
value: "s3://vaultwarden-data/prod?endpoint=https%3A%2F%2Fs3.example.internal&enable_virtual_host_style=false&default_storage_class=STANDARD"
- name: DATABASE_URL
valueFrom:
secretKeyRef:
name: vaultwarden-db
key: url
```
Use IAM/service account/environment credentials when possible. URI credentials are supported as a last resort.
<br>
## Get in touch
Have a question, suggestion or need help? Join our community on [Matrix](https://matrix.to/#/#vaultwarden:matrix.org), [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [Discourse Forums](https://vaultwarden.discourse.group/).