Skip to content

Document backup storage config in README #1414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milos-lk merged 2 commits into from
Sep 28, 2026
Merged

Document backup storage config in README #1414

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
232008b
Document backup storage config in README
milos-lk Sep 28, 2026
0a600ea
Clarify backup failover scope and local prefix in README
milos-lk Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ logging:
level: debug, info, warn, or error (default info)
json: true
template_base: can be used to host custom templates (default http://localhost:<template_port>/)
backup_storage: files will be moved here when uploads fail. location must have write access granted for all users
enable_chrome_sandbox: if true, egress will run Chrome with sandboxing enabled. This requires a specific Docker setup, see below.
psrpc: # optional gzip compression of psrpc bus payloads, see the compatibility note below
compression:
Expand Down Expand Up @@ -123,6 +122,16 @@ storage:
endpoint: (optional) custom endpoint
bucket: bucket to upload files to

# backup upload config, used when an upload to the primary storage fails. Same fields as storage.
# after the first failed upload, the remaining files for that output go to backup storage.
# with no provider set, files are written to the local filesystem under prefix (resolved from /).
backup:
prefix: (optional) prefix applied to all filenames. with no provider set, this is a local directory, e.g. /backup, which must be writable by the egress user
s3: (optional) same as storage.s3 above
azure: (optional) same as storage.azure above
gcp: (optional) same as storage.gcp above
alioss: (optional) same as storage.alioss above

# dev/debugging fields
insecure: can be used to connect to an insecure websocket (default false)
debug:
Expand Down
Loading