2022-02-02 10:05:27 +01:00
+++
title="Cookbook"
template = "documentation.html"
weight = 2
sort_by = "weight"
+++
2021-03-17 17:24:11 +01:00
A cookbook, when you cook, is a collection of recipes.
Similarly, Garage's cookbook contains a collection of recipes that are known to works well!
2021-04-06 00:01:49 +02:00
This chapter could also be referred as "Tutorials" or "Best practices".
2021-05-31 17:13:36 +02:00
2022-02-02 11:43:28 +01:00
- **[Multi-node deployment ](@/documentation/cookbook/real-world.md ):** This page will walk you through all of the necessary
2021-05-31 23:55:51 +02:00
steps to deploy Garage in a real-world setting.
2021-05-31 17:13:36 +02:00
2022-02-02 11:43:28 +01:00
- **[Building from source ](@/documentation/cookbook/from-source.md ):** This page explains how to build Garage from
2021-12-06 16:10:32 +01:00
source in case a binary is not provided for your architecture, or if you want to
hack with us!
2021-05-31 17:13:36 +02:00
2022-02-02 11:43:28 +01:00
- **[Integration with Systemd ](@/documentation/cookbook/systemd.md ):** This page explains how to run Garage
2021-12-06 16:10:32 +01:00
as a Systemd service (instead of as a Docker container).
2022-02-02 11:43:28 +01:00
- **[Configuring a gateway node ](@/documentation/cookbook/gateways.md ):** This page explains how to run a gateway node in a Garage cluster, i.e. a Garage node that doesn't store data but accelerates access to data present on the other nodes.
2021-12-06 16:10:32 +01:00
2022-02-02 11:43:28 +01:00
- **[Hosting a website ](@/documentation/cookbook/exposing-websites.md ):** This page explains how to use Garage
2021-05-31 17:13:36 +02:00
to host a static website.
2022-02-02 11:43:28 +01:00
- **[Configuring a reverse-proxy ](@/documentation/cookbook/reverse-proxy.md ):** This page explains how to configure a reverse-proxy to add TLS support to your S3 api endpoint.
2021-12-06 16:10:32 +01:00
2022-02-02 11:43:28 +01:00
- **[Recovering from failures ](@/documentation/cookbook/recovering.md ):** Garage's first selling point is resilience
2021-05-31 17:13:36 +02:00
to hardware failures. This section explains how to recover from such a failure in the
best possible way.