aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/cookbook/index.md
blob: 792a5e6ecd1f21215c88aac6ee683f53bab3d9f9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Cookbook

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!
This chapter could also be referred as "Tutorials" or "Best practices".

- **[Multi-node deployment](real_world.md):** This page will walk you through all of the necessary
  steps to deploy Garage in a real-world setting.

- **[Building from source](from_source.md):** This page explains how to build Garage from
  source in case a binary is not provided for your architecture, or if you want to
  hack with us!

- **[Integration with Systemd](systemd.md):** This page explains how to run Garage
  as a Systemd service (instead of as a Docker container).

- **[Configuring a gateway node](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.

- **[Hosting a website](exposing_websites.md):** This page explains how to use Garage
  to host a static website.

- **[Configuring a reverse-proxy](reverse_proxy.md):** This page explains how to configure a reverse-proxy to add TLS support to your S3 api endpoint.

- **[Recovering from failures](recovering.md):** Garage's first selling point is resilience
  to hardware failures. This section explains how to recover from such a failure in the
  best possible way.