aboutsummaryrefslogblamecommitdiff
path: root/doc/book/cookbook/_index.md
blob: 07bf6ebf4d58c02ad8da59e82e1cc5b08de5735a (plain) (tree)
1
2
3
4
5
6
7
8
9






                                                      
                                                                                          







                                                                                                                           


                                                                               








                                                                                                                                                                                                                                                 


                                                                                                                                                         


                                                                           

                                                                                                                    
+++
title="Cookbook"
template = "documentation.html"
weight = 2
sort_by = "weight"
+++

A cookbook, when you cook, is a collection of recipes.
Similarly, Garage's cookbook contains a collection of recipes that are known to work well!
This chapter could also be referred as "Tutorials" or "Best practices".

- **[Multi-node deployment](@/documentation/cookbook/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](@/documentation/cookbook/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!

- **[Binary packages](@/documentation/cookbook/binary-packages.md):** This page
  lists the different platforms that provide ready-built software packages for
  Garage.

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

- **[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.

- **[Hosting a website](@/documentation/cookbook/exposing-websites.md):** This page explains how to use Garage
  to host a static website.

- **[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.

- **[Deploying on Kubernetes](@/documentation/cookbook/kubernetes.md):** This page explains how to deploy Garage on Kubernetes using our Helm chart.

- **[Deploying with Ansible](@/documentation/cookbook/ansible.md):** This page lists available Ansible roles developed by the community to deploy Garage.

- **[Monitoring Garage](@/documentation/cookbook/monitoring.md)** This page
  explains the Prometheus metrics available for monitoring the Garage
  cluster/nodes.

- **[Recovering from failures](@/documentation/cookbook/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.