garage
Options
services.garage.enable
Whether to enable Garage S3-compatible object storage.
Type: boolean
Default:
falseExample:
trueDeclared by:
services.garage.package
Garage package to use.
Type: package
Default:
pkgs.garage_2Declared by:
services.garage.adminAddress
IP address and port of the admin API.
Type: string
Default:
"127.0.0.1:3903"Declared by:
services.garage.adminToken
Admin API bearer token. Hard-coded for single-node dev; production deployments override this with a real secret.
Type: string
Default:
"devtoken"Declared by:
services.garage.afterStart
Bash code to execute after the server is running and the cluster layout is applied. The garage CLI in scope already points at the local instance via the generated config.
Type: strings concatenated with “\n”
Default:
""Example:
''
garage key new --name app-key
garage bucket allow --read --write --owner my-bucket --key app-key
''Declared by:
services.garage.buckets
List of buckets to ensure exist on startup.
Type: list of string
Default:
[ ]Declared by:
services.garage.extraConfig
Additional garage.toml snippet appended to the generated config.
Type: strings concatenated with “\n”
Default:
""Declared by:
services.garage.region
S3 region label reported by the server. Defaults to AWS’s canonical us-east-1.
Type: string
Default:
"us-east-1"Declared by:
services.garage.replicationFactor
Cluster replication factor. Single-node devenv setups always use 1.
Type: signed integer
Default:
1Declared by:
services.garage.rpcSecret
RPC secret as 64 hex characters. Hard-coded for single-node dev; production deployments override this with a real secret.
Type: string
Default:
"0000000000000000000000000000000000000000000000000000000000000000"Declared by:
services.garage.s3Address
IP address and port of the S3 API.
Type: string
Default:
"127.0.0.1:3900"Declared by:
services.garage.ui.enable
Whether to enable a simple web UI.
Type: boolean
Default:
falseExample:
trueDeclared by:
services.garage.ui.port
On which port the UI should run.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
3919Example:
3919Declared by:
services.garage.ui.start
Whether to start the web UI automatically. When false it can be started manually. Only applies when ui.enable = true.
Type: boolean
Default:
falseDeclared by:
Last updated Oct 11, 2026