garage/doc/book/cookbook/_index.md
Alex 1c0ba930b8 Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.

- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization

Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
2022-02-07 11:51:12 +01:00

1.6 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 works 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.

  • 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.