aboutsummaryrefslogtreecommitdiff
path: root/content/documentation/cookbook
diff options
context:
space:
mode:
authorsptaule <lecas83@gmail.com>2022-01-26 14:44:47 +0100
committersptaule <lecas83@gmail.com>2022-01-26 14:44:47 +0100
commite0977c983abff89ac3a9e37f616399dc0b6c61c7 (patch)
tree51aec127e129ad291063d745904bbe43d906a44d /content/documentation/cookbook
parentee4d6a01e16ac53fa3e48340a47455281d5f6bc0 (diff)
downloadgaragehq.deuxfleurs.fr-e0977c983abff89ac3a9e37f616399dc0b6c61c7.tar.gz
garagehq.deuxfleurs.fr-e0977c983abff89ac3a9e37f616399dc0b6c61c7.zip
Fix doc links & added noJS support for the doc
Diffstat (limited to 'content/documentation/cookbook')
-rw-r--r--content/documentation/cookbook/exposing_websites.md8
-rw-r--r--content/documentation/cookbook/real_world.md10
-rw-r--r--content/documentation/cookbook/reverse_proxy.md2
3 files changed, 10 insertions, 10 deletions
diff --git a/content/documentation/cookbook/exposing_websites.md b/content/documentation/cookbook/exposing_websites.md
index e592e6c..91ade7d 100644
--- a/content/documentation/cookbook/exposing_websites.md
+++ b/content/documentation/cookbook/exposing_websites.md
@@ -16,11 +16,11 @@ Now it will be **publicly** exposed on the web endpoint (by default listening on
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))
+ - The index is defined in your `garage.toml`. ([ref](/documentation/reference-manual/configuration/#garage-configuration-file-format-reference))
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))
+ - we set `root_domain = ".web.example.com"` in `garage.toml` ([ref](/documentation/reference-manual/configuration/#garage-configuration-file-format-reference))
- 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):
@@ -48,6 +48,6 @@ 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.
+ - or configure a [reverse proxy](/documentation/cookbook/reverse-proxy/) 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.
+You can also take a look at [Website Integration](/documentation/connect/websites/) to see how you can add Garage to your workflow.
diff --git a/content/documentation/cookbook/real_world.md b/content/documentation/cookbook/real_world.md
index 049a54a..a010d29 100644
--- a/content/documentation/cookbook/real_world.md
+++ b/content/documentation/cookbook/real_world.md
@@ -9,7 +9,7 @@ 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/) in order
to get familiar with Garage's command line and usage patterns.
@@ -28,7 +28,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/).
You can also use an orchestrator such as Nomad or Kubernetes to automatically manage
Docker containers on a fleet of nodes.
@@ -283,15 +283,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/) 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/).
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/) section.
diff --git a/content/documentation/cookbook/reverse_proxy.md b/content/documentation/cookbook/reverse_proxy.md
index 36b9ea3..7fca5e6 100644
--- a/content/documentation/cookbook/reverse_proxy.md
+++ b/content/documentation/cookbook/reverse_proxy.md
@@ -123,7 +123,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/) 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: