Let's start your Garage journey! In this chapter, we explain how to deploy Garage as a single-node server and how to interact with it.
Our goal is to introduce you to Garage's workflows. Following this guide is recommended before moving on to configuring a real-world deployment.
Note that this kind of deployment should not be used in production, as it provides no redundancy for your data! We will also skip intra-cluster TLS configuration, meaning that if you add nodes to your cluster, communication between them will not be secure.
Download the latest Garage binary from the release pages on our repository:
Place this binary somewhere in your
$PATH so that you can invoke the
command directly (for instance you can copy the binary in
If a binary of the last version is not available for your architecture, you can build Garage from source.
This first configuration file should allow you to get started easily with the simplest possible Garage deployment:
metadata_dir = "/tmp/meta" data_dir = "/tmp/data" replication_mode = "none" rpc_bind_addr = "[::]:3901" bootstrap_peers = [ "127.0.0.1:3901", ] [s3_api] s3_region = "garage" api_bind_addr = "[::]:3900" [s3_web] bind_addr = "[::]:3902" root_domain = ".web.garage" index = "index.html"
Save your configuration file as
As you can see in the
data_dir parameters, we are saving Garage's data
/tmp which gets erased when your system reboots. This means that data stored on this
Garage server will not be persistent. Change these to locations on your local disk if you want
your data to be persisted properly.
Use the following command to launch the Garage server with our configuration file:
RUST_LOG=garage=info garage server -c garage.toml
You can tune Garage's verbosity as follows (from less verbose to more verbose):
RUST_LOG=garage=info garage server -c garage.toml RUST_LOG=garage=debug garage server -c garage.toml RUST_LOG=garage=trace garage server -c garage.toml
info is recommended for most use cases.
debug can help you check why your S3 API calls are not working.
garage utility is also used as a CLI tool to configure your Garage deployment.
It tries to connect to a Garage server through the RPC protocol, by default looking
for a Garage server at
Since our deployment already binds to port 3901, the following command should be sufficient to show Garage's status:
This should show something like this:
Healthy nodes: 2a638ed6c775b69a… linuxbox 127.0.0.1:3901 UNCONFIGURED/REMOVED
Configuring the nodes in a Garage deployment means informing Garage of the disk space available on each node of the cluster as well as the zone (e.g. datacenter) each machine is located in.
For our test deployment, we are using only one node. The way in which we configure it does not matter, you can simply write:
garage node configure -z dc1 -c 1 <node_id>
<node_id> corresponds to the identifier of the node shown by
garage status (first column).
You can enter simply a prefix of that identifier.
For instance here you could write just
garage node configure -z dc1 -c 1 2a63.
In this section, we will suppose that we want to create a bucket named
that will be accessed through a key named
Don't forget that
help command and
--help subcommands can help you anywhere,
the CLI tool is self-documented! Two examples:
garage help garage bucket allow --help
Let's take an example where we want to deploy NextCloud using Garage as the main data storage.
First, create a bucket with the following command:
garage bucket create nextcloud-bucket
Check that everything went well:
garage bucket list garage bucket info nextcloud-bucket
nextcloud-bucket bucket now exists on the Garage server,
however it cannot be accessed until we add an API key with the proper access rights.
Note that API keys are independent of buckets: one key can access multiple buckets, multiple keys can access one bucket.
Create an API key using the following command:
garage key new --name nextcloud-app-key
The output should look as follows:
Key name: nextcloud-app-key Key ID: GK3515373e4c851ebaad366558 Secret key: 7d37d093435a41f2aab8f13c19ba067d9776c90215f56614adad6ece597dbb34 Authorized buckets:
Check that everything works as intended:
garage key list garage key info nextcloud-app-key
Now that we have a bucket and a key, we need to give permissions to the key on the bucket:
garage bucket allow \ --read \ --write nextcloud-bucket \ --key nextcloud-app-key
You can check at any time the allowed keys on your bucket with:
garage bucket info nextcloud-bucket
We recommend the use of MinIO Client to interact with Garage files (
Instructions to install it and use it are provided on the
Before reading the following, you need a working
mc command on your path.
Note that on certain Linux distributions such as Arch Linux, the Minio client binary
mcli instead of
mc (to avoid name clashes with the Midnight Commander).
You need your access key and secret key created above.
We will assume you are invoking
mc on the same machine as the Garage server,
your S3 API endpoint is therefore
For this whole configuration, you must set an alias name: we chose
my-garage, that you will used for all commands.
Adapt the following command accordingly and run it:
mc alias set \ my-garage \ http://127.0.0.1:3900 \ <access key> \ <secret key> \ --api S3v4
You must also add an environment variable to your configuration to
inform MinIO of our region (
garage by default, corresponding to the
in the configuration file).
The best way is to add the following snippet to your
You can not list buckets from
But the following commands and many more should work:
mc cp image.png my-garage/nextcloud-bucket mc cp my-garage/nextcloud-bucket/image.png . mc ls my-garage/nextcloud-bucket mc mirror localdir/ my-garage/another-bucket
The following tools can also be used to send and recieve files from/to Garage:
Refer to the "configuring clients" page to learn how to configure these clients to interact with a Garage server.