diff --git a/doc/book/README b/doc/book/README
new file mode 100644
index 00000000..2a543888
--- /dev/null
+++ b/doc/book/README
@@ -0,0 +1,3 @@
+These are the sources for the documentation but not the whole website.
+The website templates and other things are in garage_website, which
+uses this as a submodule.
diff --git a/doc/book/_index.md b/doc/book/_index.md
new file mode 100644
index 00000000..283c8f3c
--- /dev/null
+++ b/doc/book/_index.md
@@ -0,0 +1,5 @@
++++
+template = "documentation.html"
+page_template = "documentation.html"
+redirect_to = "documentation/quick-start/"
++++
diff --git a/doc/book/book.toml b/doc/book/book.toml
deleted file mode 100644
index 3e163990..00000000
--- a/doc/book/book.toml
+++ /dev/null
@@ -1,6 +0,0 @@
-[book]
-authors = ["Quentin Dufour"]
-language = "en"
-multilingual = false
-src = "src"
-title = "Garage Documentation"
diff --git a/doc/book/src/connect/index.md b/doc/book/connect/_index.md
similarity index 79%
rename from doc/book/src/connect/index.md
rename to doc/book/connect/_index.md
index 60a3b03b..b4868b9f 100644
--- a/doc/book/src/connect/index.md
+++ b/doc/book/connect/_index.md
@@ -1,14 +1,20 @@
-# Integrations
++++
+title = "Integrations"
+weight = 3
+sort_by = "weight"
+template = "documentation.html"
++++
+
Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs.
In particular, you will find here instructions to connect it with:
- - [web applications](./apps.md)
- - [website hosting](./websites.md)
- - [software repositories](./repositories.md)
- - [CLI tools](./cli.md)
- - [your own code](./code.md)
+ - [web applications](@/documentation/connect/apps/index.md)
+ - [website hosting](@/documentation/connect/websites.md)
+ - [software repositories](@/documentation/connect/repositories.md)
+ - [CLI tools](@/documentation/connect/cli.md)
+ - [your own code](@/documentation/connect/code.md)
### Generic instructions
@@ -25,7 +31,7 @@ you will need the following parameters:
like this: `GK3515373e4c851ebaad366558` (access key),
`7d37d093435a41f2aab8f13c19ba067d9776c90215f56614adad6ece597dbb34` (secret key).
These keys are created and managed using the `garage` CLI, as explained in the
- [quick start](../quick_start/index.md) guide.
+ [quick start](@/documentation/quick-start/_index.md) guide.
Most S3 clients can be configured easily with these parameters,
provided that you follow the following guidelines:
diff --git a/doc/book/src/connect/cli-nextcloud-gui.png b/doc/book/connect/apps/cli-nextcloud-gui.png
similarity index 100%
rename from doc/book/src/connect/cli-nextcloud-gui.png
rename to doc/book/connect/apps/cli-nextcloud-gui.png
diff --git a/doc/book/src/connect/apps.md b/doc/book/connect/apps/index.md
similarity index 98%
rename from doc/book/src/connect/apps.md
rename to doc/book/connect/apps/index.md
index 14d69ef8..84f46891 100644
--- a/doc/book/src/connect/apps.md
+++ b/doc/book/connect/apps/index.md
@@ -1,4 +1,7 @@
-# Apps (Nextcloud, Peertube...)
++++
+title = "Apps (Nextcloud, Peertube...)"
+weight = 5
++++
In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix)
@@ -66,7 +69,7 @@ To test your new configuration, just reload your Nextcloud webpage and start sen
**From the GUI.** Activate the "External storage support" app from the "Applications" page (click on your account icon on the top right corner of your screen to display the menu). Go to your parameters page (also located below your account icon). Click on external storage (or the corresponding translation in your language).
-[](./cli-nextcloud-gui.png)
+[](cli-nextcloud-gui.png)
*Click on the picture to zoom*
Add a new external storage. Put what you want in "folder name" (eg. "shared"). Select "Amazon S3". Keep "Access Key" for the Authentication field.
@@ -253,7 +256,7 @@ Make sure you (will) have a corresponding DNS entry for them.
Now we will configure a reverse proxy in front of Garage.
This is required as we have no other way to serve CORS headers yet.
-Check the [Configuring a reverse proxy](/cookbook/reverse_proxy.html) section to know how.
+Check the [Configuring a reverse proxy](@/documentation/cookbook/reverse-proxy.md) section to know how.
Now make sure that your 2 dns entries are pointing to your reverse proxy.
diff --git a/doc/book/src/connect/backup.md b/doc/book/connect/backup.md
similarity index 91%
rename from doc/book/src/connect/backup.md
rename to doc/book/connect/backup.md
index a0af3833..9fa72964 100644
--- a/doc/book/src/connect/backup.md
+++ b/doc/book/connect/backup.md
@@ -1,4 +1,8 @@
-# Backups (restic, duplicity...)
++++
+title = "Backups (restic, duplicity...)"
+weight = 25
++++
+
Backups are essential for disaster recovery but they are not trivial to manage.
Using Garage as your backup target will enable you to scale your storage as needed while ensuring high availability.
@@ -21,7 +25,7 @@ If you still want to use Borg, you can use it with `rclone mount`.
## Duplicati
-*External links:* [Duplicati Documentation > Storage Providers](https://github.com/kees-z/DuplicatiDocs/blob/master/docs/05-storage-providers.md#s3-compatible)
+*External links:* [Duplicati Documentation > Storage Providers](https://github.com/kees-z/DuplicatiDocs/blob/master/docs/05-storage-providers.md#user-content-s3-compatible)
## knoxite
diff --git a/doc/book/src/connect/cli.md b/doc/book/connect/cli.md
similarity index 98%
rename from doc/book/src/connect/cli.md
rename to doc/book/connect/cli.md
index f7e0b22f..a62594a7 100644
--- a/doc/book/src/connect/cli.md
+++ b/doc/book/connect/cli.md
@@ -1,4 +1,7 @@
-# CLI tools
++++
+title = "CLI tools"
+weight = 20
++++
CLI tools allow you to query the S3 API without too many abstractions.
These tools are particularly suitable for debug, backups, website deployments or any scripted task that need to handle data.
diff --git a/doc/book/src/connect/code.md b/doc/book/connect/code.md
similarity index 98%
rename from doc/book/src/connect/code.md
rename to doc/book/connect/code.md
index 3d7acd58..4b2c4cb0 100644
--- a/doc/book/src/connect/code.md
+++ b/doc/book/connect/code.md
@@ -1,4 +1,7 @@
-# Your code (PHP, JS, Go...)
++++
+title = "Your code (PHP, JS, Go...)"
+weight = 30
++++
If you are developping a new application, you may want to use Garage to store your user's media.
diff --git a/doc/book/src/connect/fs.md b/doc/book/connect/fs.md
similarity index 87%
rename from doc/book/src/connect/fs.md
rename to doc/book/connect/fs.md
index be8a3402..6d9a5a68 100644
--- a/doc/book/src/connect/fs.md
+++ b/doc/book/connect/fs.md
@@ -1,4 +1,7 @@
-# FUSE (s3fs, goofys, s3backer...)
++++
+title = "FUSE (s3fs, goofys, s3backer...)"
+weight = 25
++++
**WARNING! Garage is not POSIX compatible.
Mounting S3 buckets as filesystems will not provide POSIX compatibility.
@@ -11,7 +14,7 @@ Ideally, avoid these solutions at all for any serious or production use.
## rclone mount
-rclone uses the same configuration when used [in CLI](/connect/cli.html) and mount mode.
+rclone uses the same configuration when used [in CLI](@/documentation/connect/cli.md) and mount mode.
We suppose you have the following entry in your `rclone.ini` (mine is located in `~/.config/rclone/rclone.conf`):
```toml
@@ -53,11 +56,11 @@ fusermount -u /tmp/my-bucket
## s3fs
-*External link:* [s3fs github > README.md](https://github.com/s3fs-fuse/s3fs-fuse#examples)
+*External link:* [s3fs github > README.md](https://github.com/s3fs-fuse/s3fs-fuse#user-content-examples)
## goofys
-*External link:* [goofys github > README.md](https://github.com/kahing/goofys#usage)
+*External link:* [goofys github > README.md](https://github.com/kahing/goofys#user-content-usage)
## s3backer
diff --git a/doc/book/src/connect/repositories.md b/doc/book/connect/repositories.md
similarity index 96%
rename from doc/book/src/connect/repositories.md
rename to doc/book/connect/repositories.md
index 8a3dce14..eb06e360 100644
--- a/doc/book/src/connect/repositories.md
+++ b/doc/book/connect/repositories.md
@@ -1,4 +1,7 @@
-# Repositories (Docker, Nix, Git...)
++++
+title = "Repositories (Docker, Nix, Git...)"
+weight = 15
++++
Whether you need to store and serve binary packages or source code, you may want to deploy a tool referred as a repository or registry.
Garage can also help you serve this content.
@@ -89,8 +92,8 @@ garage bucket website nix.example.com --allow
```
If you need more information about exposing buckets as websites on Garage,
-check [Exposing buckets as websites](/cookbook/exposing_websites.html)
- and [Configuring a reverse proxy](/cookbook/reverse_proxy.html).
+check [Exposing buckets as websites](@/documentation/cookbook/exposing-websites.md)
+ and [Configuring a reverse proxy](@/documentation/cookbook/reverse-proxy.md).
Next, we want to check that our bucket works:
diff --git a/doc/book/src/connect/websites.md b/doc/book/connect/websites.md
similarity index 88%
rename from doc/book/src/connect/websites.md
rename to doc/book/connect/websites.md
index 6f66c8d0..3f62c9a6 100644
--- a/doc/book/src/connect/websites.md
+++ b/doc/book/connect/websites.md
@@ -1,4 +1,7 @@
-# Websites (Hugo, Jekyll, Publii...)
++++
+title = "Websites (Hugo, Jekyll, Publii...)"
+weight = 10
++++
Garage is also suitable to host static websites.
While they can be deployed with traditional CLI tools, some static website generators have integrated options to ease your workflow.
@@ -50,7 +53,7 @@ Currently, the proposed workaround is to deploy your website manually:
- Click on Get website files
- You need to synchronize the output folder you see in your file explorer, we will use minio client.
-Be sure that you [configured minio client](cli.html#minio-client-recommended).
+Be sure that you [configured minio client](@/documentation/connect/cli.md#minio-client-recommended).
Then copy this output folder
@@ -63,7 +66,7 @@ mc mirror --overwrite output garage/my-site
Some tools do not support sending to a S3 backend but output a compiled folder on your system.
We can then use any CLI tool to upload this content to our S3 target.
-First, start by [configuring minio client](cli.html#minio-client-recommended).
+First, start by [configuring minio client](@/documentation/connect/cli.md#minio-client-recommended).
Then build your website:
diff --git a/doc/book/cookbook/_index.md b/doc/book/cookbook/_index.md
new file mode 100644
index 00000000..6e279363
--- /dev/null
+++ b/doc/book/cookbook/_index.md
@@ -0,0 +1,31 @@
++++
+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](@/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!
+
+- **[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.
+
+- **[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.
diff --git a/doc/book/cookbook/exposing-websites.md b/doc/book/cookbook/exposing-websites.md
new file mode 100644
index 00000000..be462dc9
--- /dev/null
+++ b/doc/book/cookbook/exposing-websites.md
@@ -0,0 +1,69 @@
++++
+title = "Exposing buckets as websites"
+weight = 25
++++
+
+## Configuring a bucket for website access
+
+There are two methods to expose buckets as website:
+
+1. using the PutBucketWebsite S3 API call, which is allowed for access keys that have the owner permission bit set
+
+2. from the Garage CLI, by an adminstrator of the cluster
+
+The `PutBucketWebsite` API endpoint [is documented](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) in the official AWS docs.
+This endpoint can also be called [using `aws s3api`](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-bucket-website.html) on the command line.
+The website configuration supported by Garage is only a subset of the possibilities on Amazon S3: redirections are not supported, only the index document and error document can be specified.
+
+If you want to expose your bucket as a website from the CLI, use this simple command:
+
+```bash
+garage bucket website --allow my-website
+```
+
+Now it will be **publicly** exposed on the web endpoint (by default listening on port 3902).
+
+## How exposed websites work
+
+Our website serving logic is as follow:
+
+ - Supports only static websites (no support for PHP or other languages)
+ - Does not support directory listing
+ - The index file is defined per-bucket and can be specified in the `PutBucketWebsite` call
+ or on the CLI using the `--index-document` parameter (default: `index.html`)
+ - A custom error document for 404 errors can be specified in the `PutBucketWebsite` call
+ or on the CLI using the `--error-document` parameter
+
+Now we need to infer the URL of your website through your bucket name.
+Let assume:
+ - we set `root_domain = ".web.example.com"` in `garage.toml` ([ref](@/documentation/reference-manual/configuration.md#root_domain))
+ - our bucket name is `garagehq.deuxfleurs.fr`.
+
+Our bucket will be served if the Host field matches one of these 2 values (the port is ignored):
+
+ - `garagehq.deuxfleurs.fr.web.example.com`: you can dedicate a subdomain to your users (here `web.example.com`).
+
+ - `garagehq.deuxfleurs.fr`: your users can bring their own domain name, they just need to point them to your Garage cluster.
+
+You can try this logic locally, without configuring any DNS, thanks to `curl`:
+
+```bash
+# prepare your test
+echo hello world > /tmp/index.html
+mc cp /tmp/index.html garage/garagehq.deuxfleurs.fr
+
+curl -H 'Host: garagehq.deuxfleurs.fr' http://localhost:3902
+# should print "hello world"
+
+curl -H 'Host: garagehq.deuxfleurs.fr.web.example.com' http://localhost:3902
+# should also print "hello world"
+```
+
+Now that you understand how website logic works on Garage, you can:
+
+ - make the website endpoint listens on port 80 (instead of 3902)
+ - use iptables to redirect the port 80 to the port 3902:
+ `iptables -t nat -A PREROUTING -p tcp -dport 80 -j REDIRECT -to-port 3902`
+ - or configure a [reverse proxy](@/documentation/cookbook/reverse-proxy.md) in front of Garage to add TLS (HTTPS), CORS support, etc.
+
+You can also take a look at [Website Integration](@/documentation/connect/websites.md) to see how you can add Garage to your workflow.
diff --git a/doc/book/src/cookbook/from_source.md b/doc/book/cookbook/from-source.md
similarity index 95%
rename from doc/book/src/cookbook/from_source.md
rename to doc/book/cookbook/from-source.md
index 167f01db..84c0d514 100644
--- a/doc/book/src/cookbook/from_source.md
+++ b/doc/book/cookbook/from-source.md
@@ -1,4 +1,7 @@
-# Compiling Garage from source
++++
+title = "Compiling Garage from source"
+weight = 10
++++
Garage is a standard Rust project.
diff --git a/doc/book/src/cookbook/gateways.md b/doc/book/cookbook/gateways.md
similarity index 90%
rename from doc/book/src/cookbook/gateways.md
rename to doc/book/cookbook/gateways.md
index f03671a4..62ed0fe2 100644
--- a/doc/book/src/cookbook/gateways.md
+++ b/doc/book/cookbook/gateways.md
@@ -1,4 +1,7 @@
-# Gateways
++++
+title = "Configuring a gateway node"
+weight = 20
++++
Gateways allow you to expose Garage endpoints (S3 API and websites) without storing data on the node.
@@ -12,9 +15,6 @@ You can configure Garage as a gateway on all nodes that will consume your S3 API
- **It simplifies security.** Instead of having to maintain and renew a TLS certificate, you leverage the Secret Handshake protocol we use for our cluster. The S3 API protocol will be in plain text but limited to your local machine.
-## Limitations
-
-Currently it will not work with minio client. Follow issue [#64](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/64) for more information.
## Spawn a Gateway
diff --git a/doc/book/src/cookbook/real_world.md b/doc/book/cookbook/real-world.md
similarity index 95%
rename from doc/book/src/cookbook/real_world.md
rename to doc/book/cookbook/real-world.md
index 906fe31f..1178ded5 100644
--- a/doc/book/src/cookbook/real_world.md
+++ b/doc/book/cookbook/real-world.md
@@ -1,10 +1,13 @@
-# Deploying Garage on a real-world cluster
++++
+title = "Deployment on a cluster"
+weight = 5
++++
To run Garage in cluster mode, we recommend having at least 3 nodes.
This will allow you to setup Garage for three-way replication of your data,
the safest and most available mode proposed by Garage.
-We recommend first following the [quick start guide](../quick_start/index.md) in order
+We recommend first following the [quick start guide](@/documentation/quick-start/_index.md) in order
to get familiar with Garage's command line and usage patterns.
@@ -23,7 +26,7 @@ To run a real-world deployment, make sure the following conditions are met:
to drastically reduce Garage's response times.
- This guide will assume you are using Docker containers to deploy Garage on each node.
- Garage can also be run independently, for instance as a [Systemd service](systemd.md).
+ Garage can also be run independently, for instance as a [Systemd service](@/documentation/cookbook/systemd.md).
You can also use an orchestrator such as Nomad or Kubernetes to automatically manage
Docker containers on a fleet of nodes.
@@ -278,15 +281,15 @@ garage layout apply
```
**WARNING:** if you want to use the layout modification commands in a script,
-make sure to read [this page](/reference_manual/layout.html) first.
+make sure to read [this page](@/documentation/reference-manual/layout.md) first.
## Using your Garage cluster
Creating buckets and managing keys is done using the `garage` CLI,
-and is covered in the [quick start guide](../quick_start/index.md).
+and is covered in the [quick start guide](@/documentation/quick-start/_index.md).
Remember also that the CLI is self-documented thanks to the `--help` flag and
the `help` subcommand (e.g. `garage help`, `garage key --help`).
Configuring S3-compatible applicatiosn to interact with Garage
-is covered in the [Integrations](/connect/index.html) section.
+is covered in the [Integrations](@/documentation/connect/_index.md) section.
diff --git a/doc/book/src/cookbook/recovering.md b/doc/book/cookbook/recovering.md
similarity index 97%
rename from doc/book/src/cookbook/recovering.md
rename to doc/book/cookbook/recovering.md
index 279d574c..2424558c 100644
--- a/doc/book/src/cookbook/recovering.md
+++ b/doc/book/cookbook/recovering.md
@@ -1,4 +1,7 @@
-# Recovering from failures
++++
+title = "Recovering from failures"
+weight = 35
++++
Garage is meant to work on old, second-hand hardware.
In particular, this makes it likely that some of your drives will fail, and some manual intervention will be needed.
@@ -91,7 +94,7 @@ might be faster but most of the pieces will be deleted anyway from the disk and
First, set up a new drive to store the metadata directory for the replacement node (a SSD is recommended),
and for the data directory if necessary. You can then start Garage on the new node.
-The restarted node should generate a new node ID, and it should be shown as `NOT CONFIGURED` in `garage status`.
+The restarted node should generate a new node ID, and it should be shown with `NO ROLE ASSIGNED` in `garage status`.
The ID of the lost node should be shown in `garage status` in the section for disconnected/unavailable nodes.
Then, replace the broken node by the new one, using:
diff --git a/doc/book/src/cookbook/reverse_proxy.md b/doc/book/cookbook/reverse-proxy.md
similarity index 97%
rename from doc/book/src/cookbook/reverse_proxy.md
rename to doc/book/cookbook/reverse-proxy.md
index 14633ae8..63ba4bbe 100644
--- a/doc/book/src/cookbook/reverse_proxy.md
+++ b/doc/book/cookbook/reverse-proxy.md
@@ -1,4 +1,7 @@
-# Configuring a reverse proxy
++++
+title = "Configuring a reverse proxy"
+weight = 30
++++
The main reason to add a reverse proxy in front of Garage is to provide TLS to your users.
@@ -118,7 +121,7 @@ server {
### Exposing the web endpoint
The web endpoint is a bit more complicated to configure as it listens on many different `Host` fields.
-To better understand the logic involved, you can refer to the [Exposing buckets as websites](/cookbook/exposing_websites.html) section.
+To better understand the logic involved, you can refer to the [Exposing buckets as websites](@/documentation/cookbook/exposing-websites.md) section.
Also, for some applications, you may need to serve CORS headers: Garage can not serve them directly but we show how we can use nginx to serve them.
You can use the following example as your starting point:
diff --git a/doc/book/src/cookbook/systemd.md b/doc/book/cookbook/systemd.md
similarity index 96%
rename from doc/book/src/cookbook/systemd.md
rename to doc/book/cookbook/systemd.md
index ff3541f5..b271010b 100644
--- a/doc/book/src/cookbook/systemd.md
+++ b/doc/book/cookbook/systemd.md
@@ -1,4 +1,7 @@
-# Starting Garage with systemd
++++
+title = "Starting Garage with systemd"
+weight = 15
++++
We make some assumptions for this systemd deployment.
diff --git a/doc/book/src/design/index.md b/doc/book/design/_index.md
similarity index 67%
rename from doc/book/src/design/index.md
rename to doc/book/design/_index.md
index 2e3b5fd9..f3a08aaf 100644
--- a/doc/book/src/design/index.md
+++ b/doc/book/design/_index.md
@@ -1,15 +1,20 @@
-# Design
++++
+title = "Design"
+weight = 5
+sort_by = "weight"
+template = "documentation.html"
++++
The design section helps you to see Garage from a "big picture"
perspective. It will allow you to understand if Garage is a good fit for
you, how to better use it, how to contribute to it, what can Garage could
and could not do, etc.
-- **[Goals and use cases](goals.md):** This page explains why Garage was concieved and what practical use cases it targets.
+- **[Goals and use cases](@/documentation/design/goals.md):** This page explains why Garage was concieved and what practical use cases it targets.
-- **[Related work](related_work.md):** This pages presents the theoretical background on which Garage is built, and describes other software storage solutions and why they didn't work for us.
+- **[Related work](@/documentation/design/related-work.md):** This pages presents the theoretical background on which Garage is built, and describes other software storage solutions and why they didn't work for us.
-- **[Internals](internals.md):** This page enters into more details on how Garage manages data internally.
+- **[Internals](@/documentation/design/internals.md):** This page enters into more details on how Garage manages data internally.
## Talks
diff --git a/doc/book/src/design/img/endpoint-latency-dc.png b/doc/book/design/benchmarks/endpoint-latency-dc.png
similarity index 100%
rename from doc/book/src/design/img/endpoint-latency-dc.png
rename to doc/book/design/benchmarks/endpoint-latency-dc.png
diff --git a/doc/book/src/design/img/endpoint-latency.png b/doc/book/design/benchmarks/endpoint-latency.png
similarity index 100%
rename from doc/book/src/design/img/endpoint-latency.png
rename to doc/book/design/benchmarks/endpoint-latency.png
diff --git a/doc/book/src/design/benchmarks.md b/doc/book/design/benchmarks/index.md
similarity index 97%
rename from doc/book/src/design/benchmarks.md
rename to doc/book/design/benchmarks/index.md
index 6e5580e5..c2215a4a 100644
--- a/doc/book/src/design/benchmarks.md
+++ b/doc/book/design/benchmarks/index.md
@@ -1,4 +1,7 @@
-# Benchmarks
++++
+title = "Benchmarks"
+weight = 10
++++
With Garage, we wanted to build a software defined storage service that follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle),
that is suitable for geo-distributed deployments and more generally that would work well for community hosting (like a Mastodon instance).
@@ -25,7 +28,7 @@ We selected 5 standard endpoints that are often in the critical path: ListBucket
In this first benchmark, we consider 5 instances that are located in a different place each. To simulate the distance, we configure mknet with a RTT between each node of 100 ms +/- 20 ms of jitter. We get the following graph, where the colored bars represent the mean latency while the error bars the minimum and maximum one:
-
+
Compared to garage, minio latency drastically increases on 3 endpoints: GetObject, PutObject, RemoveObject.
@@ -43,7 +46,7 @@ We consider that intra-DC communications are now very cheap with a latency of 0.
The inter-DC remains costly with the same value as before (100ms +/- 20ms of jitter).
We plot a similar graph as before:
-
+
This new graph is very similar to the one before, neither minio or garage seems to benefit from this new topology, but they also do not suffer from it.
diff --git a/doc/book/src/design/goals.md b/doc/book/design/goals.md
similarity index 98%
rename from doc/book/src/design/goals.md
rename to doc/book/design/goals.md
index 10ef6a8f..dea1d2c8 100644
--- a/doc/book/src/design/goals.md
+++ b/doc/book/design/goals.md
@@ -1,4 +1,7 @@
-# Goals and use cases
++++
+title = "Goals and use cases"
+weight = 5
++++
## Goals and non-goals
diff --git a/doc/book/src/design/internals.md b/doc/book/design/internals.md
similarity index 97%
rename from doc/book/src/design/internals.md
rename to doc/book/design/internals.md
index 0b31584c..05d852e2 100644
--- a/doc/book/src/design/internals.md
+++ b/doc/book/design/internals.md
@@ -1,4 +1,7 @@
-# Internals
++++
+title = "Internals"
+weight = 20
++++
## Overview
@@ -14,7 +17,7 @@ In the meantime, you can find some information at the following links:
- [this presentation (in French)](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main/doc/talks/2020-12-02_wide-team/talk.pdf)
-- [an old design draft](/working_documents/design_draft.md)
+- [an old design draft](@/documentation/working-documents/design-draft.md)
## Garbage collection
diff --git a/doc/book/src/design/related_work.md b/doc/book/design/related-work.md
similarity index 96%
rename from doc/book/src/design/related_work.md
rename to doc/book/design/related-work.md
index da3f807e..ade298ec 100644
--- a/doc/book/src/design/related_work.md
+++ b/doc/book/design/related-work.md
@@ -1,4 +1,7 @@
-# Related work
++++
+title = "Related work"
+weight = 15
++++
## Context
@@ -21,7 +24,7 @@ Openstack Cinder proxy previous solution to provide an uniform API.
File storage provides a higher abstraction, they are one filesystem among others, which means they don't necessarily have all the exotic features of every filesystem.
Often, they relax some POSIX constraints while many applications will still be compatible without any modification.
As an example, we are able to run MariaDB (very slowly) over GlusterFS...
-We can also mention CephFS (read [RADOS](https://ceph.com/wp-content/uploads/2016/08/weil-rados-pdsw07.pdf) whitepaper), Lustre, LizardFS, MooseFS, etc.
+We can also mention CephFS (read [RADOS](https://doi.org/10.1145/1374596.1374606) whitepaper [[pdf](https://ceph.com/assets/pdfs/weil-rados-pdsw07.pdf)]), Lustre, LizardFS, MooseFS, etc.
OpenStack Manila proxy previous solutions to provide an uniform API.
Finally object storages provide the highest level abstraction.
diff --git a/doc/book/src/development/index.md b/doc/book/development/_index.md
similarity index 91%
rename from doc/book/src/development/index.md
rename to doc/book/development/_index.md
index 09147ece..662ec358 100644
--- a/doc/book/src/development/index.md
+++ b/doc/book/development/_index.md
@@ -1,4 +1,9 @@
-# Development
++++
+title = "Development"
+weight = 6
+sort_by = "weight"
+template = "documentation.html"
++++
Now that you are a Garage expert, you want to enhance it, you are in the right place!
We discuss here how to hack on Garage, how we manage its development, etc.
diff --git a/doc/book/src/development/devenv.md b/doc/book/development/devenv.md
similarity index 98%
rename from doc/book/src/development/devenv.md
rename to doc/book/development/devenv.md
index 78affa48..c2ef4e7d 100644
--- a/doc/book/src/development/devenv.md
+++ b/doc/book/development/devenv.md
@@ -1,4 +1,7 @@
-# Setup your development environment
++++
+title = "Setup your environment"
+weight = 5
++++
Depending on your tastes, you can bootstrap your development environment in a traditional Rust way or through Nix.
diff --git a/doc/book/src/development/miscellaneous_notes.md b/doc/book/development/miscellaneous-notes.md
similarity index 98%
rename from doc/book/src/development/miscellaneous_notes.md
rename to doc/book/development/miscellaneous-notes.md
index 1adc5744..f0083ae5 100644
--- a/doc/book/src/development/miscellaneous_notes.md
+++ b/doc/book/development/miscellaneous-notes.md
@@ -1,4 +1,7 @@
-# Miscellaneous Notes
++++
+title = "Miscellaneous notes"
+weight = 20
++++
## Quirks about cargo2nix/rust in Nix
diff --git a/doc/book/src/development/release_process.md b/doc/book/development/release-process.md
similarity index 98%
rename from doc/book/src/development/release_process.md
rename to doc/book/development/release-process.md
index e6f9e608..eee45e24 100644
--- a/doc/book/src/development/release_process.md
+++ b/doc/book/development/release-process.md
@@ -1,4 +1,7 @@
-# Release process
++++
+title = "Release process"
+weight = 15
++++
Before releasing a new version of Garage, our code pass through a succession of checks and transformations.
We define them as our release process.
@@ -31,7 +34,7 @@ We generate the following binary artifacts for now:
Additionnaly we also build two web pages:
- the documentation (this website)
- - [the release page](https://garagehq.deuxfleurs.fr/releases.html)
+ - [the release page](https://garagehq.deuxfleurs.fr/_releases.html)
We publish the static binaries on our own garage cluster (you can access them through the releases page)
and the docker containers on Docker Hub.
diff --git a/doc/book/src/development/scripts.md b/doc/book/development/scripts.md
similarity index 85%
rename from doc/book/src/development/scripts.md
rename to doc/book/development/scripts.md
index 387cb349..498419e2 100644
--- a/doc/book/src/development/scripts.md
+++ b/doc/book/development/scripts.md
@@ -1,4 +1,7 @@
-# Development scripts
++++
+title = "Development scripts"
+weight = 10
++++
We maintain a `script/` folder that contains some useful script to ease testing on Garage.
@@ -31,7 +34,7 @@ You can inspect the detailed configuration, including ports, by inspecting `/tmp
This script also spawns a simple HTTPS reverse proxy through `socat` for the S3 endpoint that listens on port `4443`.
Some libraries might require a TLS endpoint to work, refer to our issue [#64](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/64) for more detailed information on this subject.
-This script covers the [Launching the garage server](/quick_start/index.html#launching-the-garage-server) section of our Quick start page.
+This script covers the [Launching the garage server](@/documentation/quick-start/_index.md#launching-the-garage-server) section of our Quick start page.
### 2. Make them join the cluster
@@ -41,7 +44,7 @@ This script covers the [Launching the garage server](/quick_start/index.html#lau
This script will configure each instance by assigning them a zone (`dc1`) and a weight (`1`).
-This script covers the [Configuring your Garage node](/quick_start/index.html#configuring-your-garage-node) section of our Quick start page.
+This script covers the [Creating a cluster layout](@/documentation/quick-start/_index.md#creating-a-cluster-layout) section of our Quick start page.
### 3. Create a key and a bucket
@@ -52,7 +55,7 @@ This script covers the [Configuring your Garage node](/quick_start/index.html#co
This script will create a bucket named `eprouvette` with a key having read and write rights on this bucket.
The key is stored in a filed named `/tmp/garage.s3` and can be used by the following tools to pre-configure them.
-This script covers the [Creating buckets and keys](/quick_start/index.html#creating-buckets-and-keys) section of our Quick start page.
+This script covers the [Creating buckets and keys](@/documentation/quick-start/_index.md#creating-buckets-and-keys) section of our Quick start page.
## Handlers for generic tools
diff --git a/doc/book/src/quick_start/index.md b/doc/book/quick-start/_index.md
similarity index 91%
rename from doc/book/src/quick_start/index.md
rename to doc/book/quick-start/_index.md
index ffb3ebbe..53ef00b4 100644
--- a/doc/book/src/quick_start/index.md
+++ b/doc/book/quick-start/_index.md
@@ -1,4 +1,9 @@
-# Quick Start
++++
+title = "Quick Start"
+weight = 0
+sort_by = "weight"
+template = "documentation.html"
++++
Let's start your Garage journey!
In this chapter, we explain how to deploy Garage as a single-node server
@@ -6,7 +11,7 @@ and how to interact with it.
Our goal is to introduce you to Garage's workflows.
Following this guide is recommended before moving on to
-[configuring a multi-node cluster](../cookbook/real_world.md).
+[configuring a multi-node cluster](@/documentation/cookbook/real-world.md).
Note that this kind of deployment should not be used in production,
as it provides no redundancy for your data!
@@ -23,10 +28,12 @@ or in `~/.local/bin`).
If a binary of the last version is not available for your architecture,
or if you want a build customized for your system,
-you can [build Garage from source](../cookbook/from_source.md).
+you can [build Garage from source](@/documentation/cookbook/from-source.md).
-## Writing a first configuration file
+## Configuring and starting Garage
+
+### Writing a first configuration file
This first configuration file should allow you to get started easily with the simplest
possible Garage deployment.
@@ -68,12 +75,12 @@ Garage server will not be persistent. Change these to locations on your local di
your data to be persisted properly.
-## Launching the Garage server
+### Launching the Garage server
Use the following command to launch the Garage server with our configuration file:
```
-RUST_LOG=garage=info garage server
+garage server
```
You can tune Garage's verbosity as follows (from less verbose to more verbose):
@@ -84,11 +91,11 @@ RUST_LOG=garage=debug garage server
RUST_LOG=garage=trace garage server
```
-Log level `info` is recommended for most use cases.
+Log level `info` is the default value and is recommended for most use cases.
Log level `debug` can help you check why your S3 API calls are not working.
-## Checking that Garage runs correctly
+### Checking that Garage runs correctly
The `garage` utility is also used as a CLI tool to configure your Garage deployment.
It uses values from the TOML configuration file to find the Garage daemon running on the
@@ -147,7 +154,7 @@ garage help
garage bucket allow --help
```
-#### Create a bucket
+### Create a bucket
Let's take an example where we want to deploy NextCloud using Garage as the
main data storage.
@@ -165,7 +172,7 @@ garage bucket list
garage bucket info nextcloud-bucket
```
-#### Create an API key
+### Create an API key
The `nextcloud-bucket` bucket now exists on the Garage server,
however it cannot be accessed until we add an API key with the proper access rights.
@@ -195,7 +202,7 @@ garage key list
garage key info nextcloud-app-key
```
-#### Allow a key to access a bucket
+### Allow a key to access a bucket
Now that we have a bucket and a key, we need to give permissions to the key on the bucket:
@@ -224,7 +231,7 @@ Before reading the following, you need a working `mc` command on your path.
Note that on certain Linux distributions such as Arch Linux, the Minio client binary
is called `mcli` instead of `mc` (to avoid name clashes with the Midnight Commander).
-#### Configure `mc`
+### Configure `mc`
You need your access key and secret key created above.
We will assume you are invoking `mc` on the same machine as the Garage server,
@@ -252,7 +259,7 @@ or `$HOME/.bashrc` file:
export MC_REGION=garage
```
-#### Use `mc`
+### Use `mc`
You can not list buckets from `mc` currently.
@@ -266,7 +273,7 @@ mc mirror localdir/ my-garage/another-bucket
```
-#### Other tools for interacting with Garage
+### Other tools for interacting with Garage
The following tools can also be used to send and recieve files from/to Garage:
@@ -275,5 +282,5 @@ The following tools can also be used to send and recieve files from/to Garage:
- [Cyberduck](https://cyberduck.io/)
- [`s3cmd`](https://s3tools.org/s3cmd)
-Refer to the ["Integrations" section](../connect/index.md) to learn how to
+Refer to the ["Integrations" section](@/documentation/connect/_index.md) to learn how to
configure application and command line utilities to integrate with Garage.
diff --git a/doc/book/src/reference_manual/index.md b/doc/book/reference-manual/_index.md
similarity index 74%
rename from doc/book/src/reference_manual/index.md
rename to doc/book/reference-manual/_index.md
index 0d4bd6f3..62716df8 100644
--- a/doc/book/src/reference_manual/index.md
+++ b/doc/book/reference-manual/_index.md
@@ -1,4 +1,9 @@
-# Reference Manual
++++
+title = "Reference Manual"
+weight = 4
+sort_by = "weight"
+template = "documentation.html"
++++
A reference manual contains some extensive descriptions about the features and the behaviour of the software.
Reading of this chapter is recommended once you have a good knowledge/understanding of Garage.
diff --git a/doc/book/src/reference_manual/cli.md b/doc/book/reference-manual/cli.md
similarity index 76%
rename from doc/book/src/reference_manual/cli.md
rename to doc/book/reference-manual/cli.md
index 80789b9d..43a0c823 100644
--- a/doc/book/src/reference_manual/cli.md
+++ b/doc/book/reference-manual/cli.md
@@ -1,4 +1,7 @@
-# Garage CLI
++++
+title = "Garage CLI"
+weight = 15
++++
The Garage CLI is mostly self-documented. Make use of the `help` subcommand
and the `--help` flag to discover all available options.
diff --git a/doc/book/src/reference_manual/configuration.md b/doc/book/reference-manual/configuration.md
similarity index 94%
rename from doc/book/src/reference_manual/configuration.md
rename to doc/book/reference-manual/configuration.md
index 9f88b232..662b00f9 100644
--- a/doc/book/src/reference_manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -1,4 +1,7 @@
-# Garage configuration file format reference
++++
+title = "Configuration file format"
+weight = 5
++++
Here is an example `garage.toml` configuration file that illustrates all of the possible options:
@@ -44,7 +47,7 @@ The following gives details about each available configuration option.
## Available configuration options
-#### `metadata_dir`
+### `metadata_dir`
The directory in which Garage will store its metadata. This contains the node identifier,
the network configuration and the peer list, the list of buckets and keys as well
@@ -52,14 +55,14 @@ as the index of all objects, object version and object blocks.
Store this folder on a fast SSD drive if possible to maximize Garage's performance.
-#### `data_dir`
+### `data_dir`
The directory in which Garage will store the data blocks of objects.
This folder can be placed on an HDD. The space available for `data_dir`
should be counted to determine a node's capacity
-when [configuring it](../getting_started/05_cluster.md).
+when [configuring it](@/documentation/cookbook/real-world.md).
-#### `block_size`
+### `block_size`
Garage splits stored objects in consecutive chunks of size `block_size`
(except the last one which might be smaller). The default size is 1MB and
@@ -71,7 +74,7 @@ means that chunks from existing files will not be deduplicated with chunks
from newly uploaded files, meaning you might use more storage space that is
optimally possible.
-#### `replication_mode`
+### `replication_mode`
Garage supports the following replication modes:
@@ -124,7 +127,7 @@ Compression is done synchronously, setting a value too high will add latency to
This value can be different between nodes, compression is done by the node which receive the
API call.
-#### `rpc_secret`
+### `rpc_secret`
Garage uses a secret key that is shared between all nodes of the cluster
in order to identify these nodes and allow them to communicate together.
@@ -132,7 +135,7 @@ This key should be specified here in the form of a 32-byte hex-encoded
random string. Such a string can be generated with a command
such as `openssl rand -hex 32`.
-#### `rpc_bind_addr`
+### `rpc_bind_addr`
The address and port on which to bind for inter-cluster communcations
(reffered to as RPC for remote procedure calls).
@@ -141,14 +144,14 @@ the node, even in the case of a NAT: the NAT should be configured to forward the
port number to the same internal port nubmer. This means that if you have several nodes running
behind a NAT, they should each use a different RPC port number.
-#### `rpc_public_addr`
+### `rpc_public_addr`
The address and port that other nodes need to use to contact this node for
RPC calls. **This parameter is optional but recommended.** In case you have
a NAT that binds the RPC port to a port that is different on your public IP,
this field might help making it work.
-#### `bootstrap_peers`
+### `bootstrap_peers`
A list of peer identifiers on which to contact other Garage peers of this cluster.
These peer identifiers have the following syntax:
@@ -164,7 +167,7 @@ be obtained by running `garage node id` and then included directly in the
key will be returned by `garage node id` and you will have to add the IP
yourself.
-#### `consul_host` and `consul_service_name`
+### `consul_host` and `consul_service_name`
Garage supports discovering other nodes of the cluster using Consul.
This works only when nodes are announced in Consul by an orchestrator such as Nomad,
@@ -174,7 +177,7 @@ The `consul_host` parameter should be set to the hostname of the Consul server,
and `consul_service_name` should be set to the service name under which Garage's
RPC ports are announced.
-#### `sled_cache_capacity`
+### `sled_cache_capacity`
This parameter can be used to tune the capacity of the cache used by
[sled](https://sled.rs), the database Garage uses internally to store metadata.
@@ -182,7 +185,7 @@ Tune this to fit the RAM you wish to make available to your Garage instance.
More cache means faster Garage, but the default value (128MB) should be plenty
for most use cases.
-#### `sled_flush_every_ms`
+### `sled_flush_every_ms`
This parameters can be used to tune the flushing interval of sled.
Increase this if sled is thrashing your SSD, at the risk of losing more data in case
@@ -190,20 +193,21 @@ of a power outage (though this should not matter much as data is replicated on o
nodes). The default value, 2000ms, should be appropriate for most use cases.
+
## The `[s3_api]` section
-#### `api_bind_addr`
+### `api_bind_addr`
The IP and port on which to bind for accepting S3 API calls.
This endpoint does not suport TLS: a reverse proxy should be used to provide it.
-#### `s3_region`
+### `s3_region`
Garage will accept S3 API calls that are targetted to the S3 region defined here.
API calls targetted to other regions will fail with a AuthorizationHeaderMalformed error
message that redirects the client to the correct region.
-#### `root_domain`
+### `root_domain` {#root_domain}
The optionnal suffix to access bucket using vhost-style in addition to path-style request.
Note path-style requests are always enabled, whether or not vhost-style is configured.
@@ -213,18 +217,20 @@ but might be required by softwares not supporting path-style requests.
If `root_domain` is `s3.garage.eu`, a bucket called `my-bucket` can be interacted with
using the hostname `my-bucket.s3.garage.eu`.
+
+
## The `[s3_web]` section
Garage allows to publish content of buckets as websites. This section configures the
behaviour of this module.
-#### `bind_addr`
+### `bind_addr`
The IP and port on which to bind for accepting HTTP requests to buckets configured
for website access.
This endpoint does not suport TLS: a reverse proxy should be used to provide it.
-#### `root_domain`
+### `root_domain`
The optionnal suffix appended to bucket names for the corresponding HTTP Host.
@@ -232,6 +238,3 @@ For instance, if `root_domain` is `web.garage.eu`, a bucket called `deuxfleurs.f
will be accessible either with hostname `deuxfleurs.fr.web.garage.eu`
or with hostname `deuxfleurs.fr`.
-#### `index`
-
-The name of the index file to return for requests ending with `/` (usually `index.html`).
diff --git a/doc/book/src/reference_manual/layout.md b/doc/book/reference-manual/layout.md
similarity index 96%
rename from doc/book/src/reference_manual/layout.md
rename to doc/book/reference-manual/layout.md
index 80c71d60..7debbf33 100644
--- a/doc/book/src/reference_manual/layout.md
+++ b/doc/book/reference-manual/layout.md
@@ -1,10 +1,13 @@
-# Creating and updating a cluster layout
++++
+title = "Cluster layout management"
+weight = 10
++++
The cluster layout in Garage is a table that assigns to each node a role in
the cluster. The role of a node in Garage can either be a storage node with
a certain capacity, or a gateway node that does not store data and is only
used as an API entry point for faster cluster access.
-An introduction to building cluster layouts can be found in the [production deployment](/cookbook/real_world.md) page.
+An introduction to building cluster layouts can be found in the [production deployment](@/documentation/cookbook/real-world.md) page.
## How cluster layouts work in Garage
diff --git a/doc/book/src/reference_manual/s3_compatibility.md b/doc/book/reference-manual/s3-compatibility.md
similarity index 98%
rename from doc/book/src/reference_manual/s3_compatibility.md
rename to doc/book/reference-manual/s3-compatibility.md
index e6f32f6a..fdac06ab 100644
--- a/doc/book/src/reference_manual/s3_compatibility.md
+++ b/doc/book/reference-manual/s3-compatibility.md
@@ -1,4 +1,7 @@
-# S3 Compatibility status
++++
+title = "S3 Compatibility status"
+weight = 20
++++
## Global S3 features
diff --git a/doc/book/src/SUMMARY.md b/doc/book/src/SUMMARY.md
deleted file mode 100644
index d9b76e96..00000000
--- a/doc/book/src/SUMMARY.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Summary
-
-[The Garage Data Store](./intro.md)
-
-- [Quick start](./quick_start/index.md)
-
-- [Cookbook](./cookbook/index.md)
- - [Multi-node deployment](./cookbook/real_world.md)
- - [Building from source](./cookbook/from_source.md)
- - [Integration with systemd](./cookbook/systemd.md)
- - [Configuring a gateway node](./cookbook/gateways.md)
- - [Exposing buckets as websites](./cookbook/exposing_websites.md)
- - [Configuring a reverse proxy](./cookbook/reverse_proxy.md)
- - [Recovering from failures](./cookbook/recovering.md)
-
-- [Integrations](./connect/index.md)
- - [Apps (Nextcloud, Peertube...)](./connect/apps.md)
- - [Websites (Hugo, Jekyll, Publii...)](./connect/websites.md)
- - [Repositories (Docker, Nix, Git...)](./connect/repositories.md)
- - [CLI tools (rclone, awscli, mc...)](./connect/cli.md)
- - [Backups (restic, duplicity...)](./connect/backup.md)
- - [Your code (PHP, JS, Go...)](./connect/code.md)
- - [FUSE (s3fs, goofys, s3backer...)](./connect/fs.md)
-
-
-- [Reference Manual](./reference_manual/index.md)
- - [Garage configuration file](./reference_manual/configuration.md)
- - [Cluster layout management](./reference_manual/layout.md)
- - [Garage CLI](./reference_manual/cli.md)
- - [S3 compatibility status](./reference_manual/s3_compatibility.md)
-
-- [Design](./design/index.md)
- - [Goals and use Cases](./design/goals.md)
- - [Benchmarks](./design/benchmarks.md)
- - [Related work](./design/related_work.md)
- - [Internals](./design/internals.md)
-
-- [Development](./development/index.md)
- - [Setup your environment](./development/devenv.md)
- - [Development scripts](./development/scripts.md)
- - [Release process](./development/release_process.md)
- - [Miscellaneous notes](./development/miscellaneous_notes.md)
-
-- [Working Documents](./working_documents/index.md)
- - [S3 compatibility target](./working_documents/compatibility_target.md)
- - [Load balancing data](./working_documents/load_balancing.md)
- - [Migrating from 0.5 to 0.6](./working_documents/migration_06.md)
- - [Migrating from 0.3 to 0.4](./working_documents/migration_04.md)
- - [Design draft](./working_documents/design_draft.md)
diff --git a/doc/book/src/cookbook/exposing_websites.md b/doc/book/src/cookbook/exposing_websites.md
deleted file mode 100644
index 0cbb1150..00000000
--- a/doc/book/src/cookbook/exposing_websites.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# Exposing buckets as websites
-
-You can expose your bucket as a website with this simple command:
-
-```bash
-garage bucket website --allow my-website
-```
-
-Now it will be **publicly** exposed on the web endpoint (by default listening on port 3902).
-
-Our website serving logic is as follow:
- - Supports only static websites (no support for PHP or other languages)
- - Does not support directory listing
- - The index is defined in your `garage.toml`. ([ref](/reference_manual/configuration.html#index))
-
-Now we need to infer the URL of your website through your bucket name.
-Let assume:
- - we set `root_domain = ".web.example.com"` in `garage.toml` ([ref](/reference_manual/configuration.html#root_domain))
- - our bucket name is `garagehq.deuxfleurs.fr`.
-
-Our bucket will be served if the Host field matches one of these 2 values (the port is ignored):
-
- - `garagehq.deuxfleurs.fr.web.example.com`: you can dedicate a subdomain to your users (here `web.example.com`).
-
- - `garagehq.deuxfleurs.fr`: your users can bring their own domain name, they just need to point them to your Garage cluster.
-
-You can try this logic locally, without configuring any DNS, thanks to `curl`:
-
-```bash
-# prepare your test
-echo hello world > /tmp/index.html
-mc cp /tmp/index.html garage/garagehq.deuxfleurs.fr
-
-curl -H 'Host: garagehq.deuxfleurs.fr' http://localhost:3902
-# should print "hello world"
-
-curl -H 'Host: garagehq.deuxfleurs.fr.web.example.com' http://localhost:3902
-# should also print "hello world"
-```
-
-Now that you understand how website logic works on Garage, you can:
-
- - make the website endpoint listens on port 80 (instead of 3902)
- - use iptables to redirect the port 80 to the port 3902:
- `iptables -t nat -A PREROUTING -p tcp -dport 80 -j REDIRECT -to-port 3902`
- - or configure a [reverse proxy](reverse_proxy.html) in front of Garage to add TLS (HTTPS), CORS support, etc.
-
-You can also take a look at [Website Integration](/connect/websites.html) to see how you can add Garage to your workflow.
diff --git a/doc/book/src/cookbook/index.md b/doc/book/src/cookbook/index.md
deleted file mode 100644
index 792a5e6e..00000000
--- a/doc/book/src/cookbook/index.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# 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.
diff --git a/doc/book/src/cookbook/website.md b/doc/book/src/cookbook/website.md
deleted file mode 100644
index 53488ac4..00000000
--- a/doc/book/src/cookbook/website.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Hosting a website
-
-TODO
diff --git a/doc/book/src/img/eu-flag-logo.png b/doc/book/src/img/eu-flag-logo.png
deleted file mode 100644
index eab9e833..00000000
Binary files a/doc/book/src/img/eu-flag-logo.png and /dev/null differ
diff --git a/doc/book/src/img/logo.svg b/doc/book/src/img/logo.svg
deleted file mode 100644
index fb02c40b..00000000
--- a/doc/book/src/img/logo.svg
+++ /dev/null
@@ -1,44 +0,0 @@
-
-
diff --git a/doc/book/src/img/map.svg b/doc/book/src/img/map.svg
deleted file mode 100644
index 7b38b2d8..00000000
--- a/doc/book/src/img/map.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/doc/book/src/img/ngi-logo.png b/doc/book/src/img/ngi-logo.png
deleted file mode 100644
index ee0f0c29..00000000
Binary files a/doc/book/src/img/ngi-logo.png and /dev/null differ
diff --git a/doc/book/src/img/software.svg b/doc/book/src/img/software.svg
deleted file mode 100644
index 178c5810..00000000
--- a/doc/book/src/img/software.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/doc/book/src/img/usage.svg b/doc/book/src/img/usage.svg
deleted file mode 100644
index c861f6ac..00000000
--- a/doc/book/src/img/usage.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/doc/book/src/intro.md b/doc/book/src/intro.md
deleted file mode 100644
index 5d6e2cf0..00000000
--- a/doc/book/src/intro.md
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-Garage implements the **[Amazon S3 API](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)** and thus is already **compatible** with many applications:
-
-
-
-Did you notice that *this website* is hosted and served by Garage?
-
-## Keeping requirements low
-
-We worked hard to keep requirements as low as possible as we target the largest possible public.
-
- * **CPU:** any x86\_64 CPU from the last 10 years, ARMv7 or ARMv8.
- * **RAM:** 1GB
- * **Disk Space:** at least 16GB
- * **Network:** 200ms or less, 50 Mbps or more
- * **Heterogeneous hardware:** build a cluster with whatever second-hand machines are available
-
-*For the network, as we do not use consensus algorithms like Paxos or Raft, Garage is not as latency sensitive.*
-*Thanks to Rust and its zero-cost abstractions, we keep CPU and memory low.*
-
-## Built on the shoulder of giants
-
- - [Dynamo: Amazon’s Highly Available Key-value Store ](https://dl.acm.org/doi/abs/10.1145/1323293.1294281) by DeCandia et al.
- - [Conflict-Free Replicated Data Types](https://link.springer.com/chapter/10.1007/978-3-642-24550-3_29) by Shapiro et al.
- - [Maglev: A Fast and Reliable Software Network Load Balancer](https://www.usenix.org/conference/nsdi16/technical-sessions/presentation/eisenbud) by Eisenbud et al.
-
-## Talks
-
- - [(fr, 2021-11-13, video) Garage : Mille et une façons de stocker vos données](https://video.tedomum.net/w/moYKcv198dyMrT8hCS5jz9) and [slides (html)](https://rfid.deuxfleurs.fr/presentations/2021-11-13/garage/) - during [RFID#1](https://rfid.deuxfleurs.fr/programme/2021-11-13/) event
-
- - [(en, 2021-04-28, pdf) Distributed object storage is centralised](https://git.deuxfleurs.fr/Deuxfleurs/garage/raw/commit/b1f60579a13d3c5eba7f74b1775c84639ea9b51a/doc/talks/2021-04-28_spirals-team/talk.pdf)
-
- - [(fr, 2020-12-02, pdf) Garage : jouer dans la cour des grands quand on est un hébergeur associatif](https://git.deuxfleurs.fr/Deuxfleurs/garage/raw/commit/b1f60579a13d3c5eba7f74b1775c84639ea9b51a/doc/talks/2020-12-02_wide-team/talk.pdf)
-
-## Community
-
-If you want to discuss with us, you can join our Matrix channel at [#garage:deuxfleurs.fr](https://matrix.to/#/#garage:deuxfleurs.fr).
-Our code repository and issue tracker, which is the place where you should report bugs, is managed on [Deuxfleurs' Gitea](https://git.deuxfleurs.fr/Deuxfleurs/garage).
-
-## License
-
-Garage's source code, is released under the [AGPL v3 License](https://www.gnu.org/licenses/agpl-3.0.en.html).
-Please note that if you patch Garage and then use it to provide any service over a network, you must share your code!
-
-# Sponsors and funding
-
-The Deuxfleurs association has received a grant from [NGI POINTER](https://pointer.ngi.eu/), to fund 3 people working on Garage full-time for a year: from October 2021 to September 2022.
-
-
-
-_This project has received funding from the European Union’s Horizon 2020 research and innovation programme within the framework of the NGI-POINTER Project funded under grant agreement N° 871528._
diff --git a/doc/book/src/working_documents/index.md b/doc/book/working-documents/_index.md
similarity index 83%
rename from doc/book/src/working_documents/index.md
rename to doc/book/working-documents/_index.md
index a9e7f899..9871d206 100644
--- a/doc/book/src/working_documents/index.md
+++ b/doc/book/working-documents/_index.md
@@ -1,4 +1,9 @@
-# Working Documents
++++
+title = "Working Documents"
+weight = 7
+sort_by = "weight"
+template = "documentation.html"
++++
Working documents are documents that reflect the fact that Garage is a software that evolves quickly.
They are a way to communicate our ideas, our changes, and so on before or while we are implementing them in Garage.
diff --git a/doc/book/src/working_documents/compatibility_target.md b/doc/book/working-documents/compatibility-target.md
similarity index 98%
rename from doc/book/src/working_documents/compatibility_target.md
rename to doc/book/working-documents/compatibility-target.md
index 3f121e47..836f3e30 100644
--- a/doc/book/src/working_documents/compatibility_target.md
+++ b/doc/book/working-documents/compatibility-target.md
@@ -1,4 +1,7 @@
-# S3 compatibility target
++++
+title = "S3 compatibility target"
+weight = 5
++++
If there is a specific S3 functionnality you have a need for, feel free to open
a PR to put the corresponding endpoints higher in the list. Please explain
diff --git a/doc/book/src/working_documents/design_draft.md b/doc/book/working-documents/design-draft.md
similarity index 98%
rename from doc/book/src/working_documents/design_draft.md
rename to doc/book/working-documents/design-draft.md
index 06ed46bd..44849a41 100644
--- a/doc/book/src/working_documents/design_draft.md
+++ b/doc/book/working-documents/design-draft.md
@@ -1,4 +1,7 @@
-# Design draft
++++
+title = "Design draft"
+weight = 25
++++
**WARNING: this documentation is a design draft which was written before Garage's actual implementation.
The general principle are similar, but details have not been updated.**
@@ -159,4 +162,4 @@ Number K of tokens per node: decided by the operator & stored in the operator's
- CDC:
- Erasure coding:
- [Openstack Storage Concepts](https://docs.openstack.org/arch-design/design-storage/design-storage-concepts.html)
-- [RADOS](https://ceph.com/wp-content/uploads/2016/08/weil-rados-pdsw07.pdf)
+- [RADOS](https://doi.org/10.1145/1374596.1374606) [[pdf](https://ceph.com/assets/pdfs/weil-rados-pdsw07.pdf)]
diff --git a/doc/book/src/working_documents/load_balancing.md b/doc/book/working-documents/load-balancing.md
similarity index 99%
rename from doc/book/src/working_documents/load_balancing.md
rename to doc/book/working-documents/load-balancing.md
index 99271add..87298ae6 100644
--- a/doc/book/src/working_documents/load_balancing.md
+++ b/doc/book/working-documents/load-balancing.md
@@ -1,4 +1,7 @@
-# Load Balancing Data (planned for version 0.2)
++++
+title = "Load balancing data"
+weight = 10
++++
**This is being yet improved in release 0.5. The working document has not been updated yet, it still only applies to Garage 0.2 through 0.4.**
diff --git a/doc/book/src/working_documents/migration_04.md b/doc/book/working-documents/migration-04.md
similarity index 98%
rename from doc/book/src/working_documents/migration_04.md
rename to doc/book/working-documents/migration-04.md
index 05e7eafd..d9d3ede1 100644
--- a/doc/book/src/working_documents/migration_04.md
+++ b/doc/book/working-documents/migration-04.md
@@ -1,4 +1,7 @@
-# Migrating from 0.3 to 0.4
++++
+title = "Migrating from 0.3 to 0.4"
+weight = 20
++++
**Migrating from 0.3 to 0.4 is unsupported. This document is only intended to
document the process internally for the Deuxfleurs cluster where we have to do
diff --git a/doc/book/src/working_documents/migration_06.md b/doc/book/working-documents/migration-06.md
similarity index 97%
rename from doc/book/src/working_documents/migration_06.md
rename to doc/book/working-documents/migration-06.md
index 687f7458..28e2c32e 100644
--- a/doc/book/src/working_documents/migration_06.md
+++ b/doc/book/working-documents/migration-06.md
@@ -1,4 +1,7 @@
-# Migrating from 0.5 to 0.6
++++
+title = "Migrating from 0.5 to 0.6"
+weight = 15
++++
**This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster.
We don't recommend trying to migrate directly from 0.4 or older to 0.6.**
-
-
-
-
-
- 
-