# garage ## Options ### services.garage.enable Whether to enable Garage S3-compatible object storage. *Type:* boolean *Default:* ```nix false ``` *Example:* ```nix true ``` *Declared by:* * ### services.garage.package Garage package to use. *Type:* package *Default:* ```nix pkgs.garage_2 ``` *Declared by:* * ### services.garage.adminAddress IP address and port of the admin API. *Type:* string *Default:* ```nix "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:* ```nix "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:* ```nix "" ``` *Example:* ```nix '' 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:* ```nix [ ] ``` *Declared by:* * ### services.garage.extraConfig Additional `garage.toml` snippet appended to the generated config. *Type:* strings concatenated with “\n” *Default:* ```nix "" ``` *Declared by:* * ### services.garage.region S3 region label reported by the server. Defaults to AWS’s canonical `us-east-1`. *Type:* string *Default:* ```nix "us-east-1" ``` *Declared by:* * ### services.garage.replicationFactor Cluster replication factor. Single-node devenv setups always use 1. *Type:* signed integer *Default:* ```nix 1 ``` *Declared 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:* ```nix "0000000000000000000000000000000000000000000000000000000000000000" ``` *Declared by:* * ### services.garage.s3Address IP address and port of the S3 API. *Type:* string *Default:* ```nix "127.0.0.1:3900" ``` *Declared by:* * ### services.garage.ui.enable Whether to enable a simple web UI. *Type:* boolean *Default:* ```nix false ``` *Example:* ```nix true ``` *Declared by:* * ### services.garage.ui.port On which port the UI should run. *Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive) *Default:* ```nix 3919 ``` *Example:* ```nix 3919 ``` *Declared 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:* ```nix false ``` *Declared by:* *