diff options
| author | Alex Auvolat <alex@adnab.me> | 2021-12-06 16:10:32 +0100 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2021-12-06 16:33:01 +0100 |
| commit | 224c89ad6ed532d0d7d07309e72894dcdab1da1f (patch) | |
| tree | d07e0104bad5f7007468766894ec504a5a2c45ab /doc/book/src/cookbook/index.md | |
| parent | 7c2037ba87ef4735efa2700d79c8a5782e30a55f (diff) | |
| download | garage-224c89ad6ed532d0d7d07309e72894dcdab1da1f.tar.gz garage-224c89ad6ed532d0d7d07309e72894dcdab1da1f.zip | |
Reorganize and improve documentation
Diffstat (limited to 'doc/book/src/cookbook/index.md')
| -rw-r--r-- | doc/book/src/cookbook/index.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/book/src/cookbook/index.md b/doc/book/src/cookbook/index.md index da915f85..792a5e6e 100644 --- a/doc/book/src/cookbook/index.md +++ b/doc/book/src/cookbook/index.md @@ -4,22 +4,23 @@ 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". -- **[Deploying Garage](real_world.md):** This page will walk you through all of the necessary +- **[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. -- **[Configuring S3 clients](clients.md):** This page will explain how to configure - popular S3 clients to interact with a Garage server. +- **[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! -- **[Hosting a website](website.md):** This page explains how to use Garage +- **[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. - -- **[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! - -- **[Starting with Systemd](from_source.md):** This page explains how to run Garage - as a Systemd service (instead of as a Docker container). |