garage/doc/book/cookbook/_index.md
2023-03-01 09:24:13 +01:00

2.1 KiB

+++ 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: This page will walk you through all of the necessary steps to deploy Garage in a real-world setting.

  • Building from source: 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: This page explains how to run Garage as a Systemd service (instead of as a Docker container).

  • Configuring a gateway node: 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: This page explains how to use Garage to host a static website.

  • Configuring a reverse-proxy: This page explains how to configure a reverse-proxy to add TLS support to your S3 api endpoint.

  • Deploying on Kubernetes: This page explains how to deploy Garage on Kubernetes using our Helm chart.

  • Deploying with Ansible: This page lists available Ansible roles developed by the community to deploy Garage.

  • Monitoring Garage This page explains the Prometheus metrics available for monitoring the Garage cluster/nodes.

  • Recovering from failures: 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.