Docs

Browse releases →
OptionTypeDescription
admin.bindAddressstring matching [^[:space:]]+Socket address used by the administration API.
admin.enablebooleanEnable Garage's authenticated administration and metrics API.
admin.metrics.requireTokenbooleanRequire a bearer token when scraping metrics.
admin.metrics.tokensubmodule or nullOpaque reference for the metrics bearer token.
admin.tokensubmodule or nullOpaque reference for the administration bearer token.
configattribute set of attribute set of any valueDesired values for the package's declared config artifacts.
credentialsattribute set of submoduleOpaque references for the package's declared credentials.
dbEngineone of ["lmdb","sqlite"]Embedded metadata database engine.
enablebooleanWhether to enable the Garage object-storage service.
replicationFactorsigned integerNumber of copies Garage maintains for each object.
rpc.bindAddressstring matching [^[:space:]]+Socket address used for Garage cluster RPC.
rpc.bootstrapPeerslist of stringGarage node-ID and RPC-address peers used for cluster discovery.
rpc.publicAddressstring matching [^[:space:]]+ or nullExternally reachable cluster RPC address advertised to peers.
rpc.secretsubmodule or nullOpaque reference for the shared 32-byte hexadecimal RPC secret.
s3.bindAddressstring matching [^[:space:]]+Socket address used by the S3 API.
s3.regionstringS3 region returned to clients and used for request signing.
s3.rootDomainstring or nullOptional DNS suffix for virtual-host-style S3 requests.
web.bindAddressstring matching [^[:space:]]+Socket address used by the bucket website endpoint.
web.enablebooleanEnable Garage's public bucket website endpoint.
web.rootDomainstringDNS suffix used to select website buckets.