diff options
Diffstat (limited to 'content/documentation')
31 files changed, 2 insertions, 36 deletions
diff --git a/content/documentation/connect/apps.md b/content/documentation/connect/apps.md index 82af8a6..4348286 100644 --- a/content/documentation/connect/apps.md +++ b/content/documentation/connect/apps.md @@ -3,8 +3,6 @@ title = "Apps (Nextcloud, Peertube...)" weight = 5 +++ -# Apps (Nextcloud, Peertube...) - In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix) ## Nextcloud diff --git a/content/documentation/connect/backup.md b/content/documentation/connect/backup.md index 36b894b..878660f 100644 --- a/content/documentation/connect/backup.md +++ b/content/documentation/connect/backup.md @@ -3,7 +3,6 @@ title = "Backups (restic, duplicity...)" weight = 25 +++ -# Backups (restic, duplicity...) 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. diff --git a/content/documentation/connect/cli.md b/content/documentation/connect/cli.md index 57664ac..77d0647 100644 --- a/content/documentation/connect/cli.md +++ b/content/documentation/connect/cli.md @@ -3,7 +3,6 @@ title = "CLI tools" weight = 20 +++ -# CLI tools 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/content/documentation/connect/code.md b/content/documentation/connect/code.md index 5c7f7fc..2351ab0 100644 --- a/content/documentation/connect/code.md +++ b/content/documentation/connect/code.md @@ -3,7 +3,6 @@ title = "Your code (PHP, JS, Go...)" weight = 30 +++ -# Your code (PHP, JS, Go...) If you are developping a new application, you may want to use Garage to store your user's media. diff --git a/content/documentation/connect/fs.md b/content/documentation/connect/fs.md index 7f10b60..792d5c5 100644 --- a/content/documentation/connect/fs.md +++ b/content/documentation/connect/fs.md @@ -3,7 +3,6 @@ title = "FUSE (s3fs, goofys, s3backer...)" weight = 25 +++ -# FUSE (s3fs, goofys, s3backer...) **WARNING! Garage is not POSIX compatible. Mounting S3 buckets as filesystems will not provide POSIX compatibility. diff --git a/content/documentation/connect/repositories.md b/content/documentation/connect/repositories.md index 53e3a51..90adc46 100644 --- a/content/documentation/connect/repositories.md +++ b/content/documentation/connect/repositories.md @@ -3,7 +3,6 @@ title = "Repositories (Docker, Nix, Git...)" weight = 15 +++ -# Repositories (Docker, Nix, Git...) 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. diff --git a/content/documentation/connect/websites.md b/content/documentation/connect/websites.md index 6710e91..2692196 100644 --- a/content/documentation/connect/websites.md +++ b/content/documentation/connect/websites.md @@ -3,7 +3,6 @@ title = "Websites (Hugo, Jekyll, Publii...)" weight = 10 +++ -# Websites (Hugo, Jekyll, Publii...) 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. diff --git a/content/documentation/cookbook/exposing_websites.md b/content/documentation/cookbook/exposing_websites.md index 91ade7d..1594ccc 100644 --- a/content/documentation/cookbook/exposing_websites.md +++ b/content/documentation/cookbook/exposing_websites.md @@ -3,8 +3,6 @@ title = "Exposing buckets as websites" weight = 25 +++ -# Exposing buckets as websites - You can expose your bucket as a website with this simple command: ```bash diff --git a/content/documentation/cookbook/from_source.md b/content/documentation/cookbook/from_source.md index f33b7ab..bf1958c 100644 --- a/content/documentation/cookbook/from_source.md +++ b/content/documentation/cookbook/from_source.md @@ -3,7 +3,6 @@ title = "Compiling Garage from source" weight = 10 +++ -# Compiling Garage from source Garage is a standard Rust project. diff --git a/content/documentation/cookbook/gateways.md b/content/documentation/cookbook/gateways.md index 8bd3a66..dc716e4 100644 --- a/content/documentation/cookbook/gateways.md +++ b/content/documentation/cookbook/gateways.md @@ -3,7 +3,6 @@ title = "Configuring a gateway node" weight = 20 +++ -# Gateways Gateways allow you to expose Garage endpoints (S3 API and websites) without storing data on the node. diff --git a/content/documentation/cookbook/real_world.md b/content/documentation/cookbook/real_world.md index a010d29..4fca5e8 100644 --- a/content/documentation/cookbook/real_world.md +++ b/content/documentation/cookbook/real_world.md @@ -1,10 +1,8 @@ +++ -title = "Multi-node deployment" +title = "Deployment on a cluster" weight = 5 +++ -# Deploying Garage on a real-world cluster - 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. diff --git a/content/documentation/cookbook/recovering.md b/content/documentation/cookbook/recovering.md index 7d75bfe..8f08e0e 100644 --- a/content/documentation/cookbook/recovering.md +++ b/content/documentation/cookbook/recovering.md @@ -3,7 +3,6 @@ title = "Recovering from failures" weight = 35 +++ -# Recovering from failures 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. diff --git a/content/documentation/cookbook/reverse_proxy.md b/content/documentation/cookbook/reverse_proxy.md index 7fca5e6..30c27b3 100644 --- a/content/documentation/cookbook/reverse_proxy.md +++ b/content/documentation/cookbook/reverse_proxy.md @@ -3,7 +3,6 @@ title = "Configuring a reverse proxy" weight = 30 +++ -# Configuring a reverse proxy The main reason to add a reverse proxy in front of Garage is to provide TLS to your users. diff --git a/content/documentation/cookbook/systemd.md b/content/documentation/cookbook/systemd.md index 8e812e1..b071952 100644 --- a/content/documentation/cookbook/systemd.md +++ b/content/documentation/cookbook/systemd.md @@ -3,7 +3,6 @@ title = "Starting Garage with systemd" weight = 15 +++ -# Starting Garage with systemd We make some assumptions for this systemd deployment. diff --git a/content/documentation/design/benchmarks.md b/content/documentation/design/benchmarks.md index 62e8480..20491f7 100644 --- a/content/documentation/design/benchmarks.md +++ b/content/documentation/design/benchmarks.md @@ -3,7 +3,6 @@ title = "Benchmarks" weight = 10 +++ -# Benchmarks 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). diff --git a/content/documentation/design/goals.md b/content/documentation/design/goals.md index aa1e0bc..28511d9 100644 --- a/content/documentation/design/goals.md +++ b/content/documentation/design/goals.md @@ -3,7 +3,6 @@ title = "Goals and use cases" weight = 5 +++ -# Goals and use cases ## Goals and non-goals diff --git a/content/documentation/design/internals.md b/content/documentation/design/internals.md index ba120b0..e126654 100644 --- a/content/documentation/design/internals.md +++ b/content/documentation/design/internals.md @@ -3,7 +3,6 @@ title = "Internals" weight = 20 +++ -# Internals ## Overview diff --git a/content/documentation/design/related_work.md b/content/documentation/design/related_work.md index 32b5141..b940c13 100644 --- a/content/documentation/design/related_work.md +++ b/content/documentation/design/related_work.md @@ -3,7 +3,6 @@ title = "Related work" weight = 15 +++ -# Related work ## Context diff --git a/content/documentation/development/devenv.md b/content/documentation/development/devenv.md index 7ea577c..bf6c017 100644 --- a/content/documentation/development/devenv.md +++ b/content/documentation/development/devenv.md @@ -3,7 +3,6 @@ title = "Setup your environment" weight = 5 +++ -# Setup your development environment Depending on your tastes, you can bootstrap your development environment in a traditional Rust way or through Nix. diff --git a/content/documentation/development/miscellaneous_notes.md b/content/documentation/development/miscellaneous_notes.md index aafb3cd..5ead19d 100644 --- a/content/documentation/development/miscellaneous_notes.md +++ b/content/documentation/development/miscellaneous_notes.md @@ -3,7 +3,6 @@ title = "Miscellaneous notes" weight = 20 +++ -# Miscellaneous Notes ## Quirks about cargo2nix/rust in Nix diff --git a/content/documentation/development/release_process.md b/content/documentation/development/release_process.md index 380f544..06d1f47 100644 --- a/content/documentation/development/release_process.md +++ b/content/documentation/development/release_process.md @@ -3,7 +3,6 @@ title = "Release process" weight = 15 +++ -# Release process Before releasing a new version of Garage, our code pass through a succession of checks and transformations. We define them as our release process. diff --git a/content/documentation/development/scripts.md b/content/documentation/development/scripts.md index a3871eb..34c921b 100644 --- a/content/documentation/development/scripts.md +++ b/content/documentation/development/scripts.md @@ -3,7 +3,6 @@ title = "Development scripts" weight = 10 +++ -# Development scripts We maintain a `script/` folder that contains some useful script to ease testing on Garage. diff --git a/content/documentation/reference-manual/cli.md b/content/documentation/reference-manual/cli.md index 2f0525f..b6b8867 100644 --- a/content/documentation/reference-manual/cli.md +++ b/content/documentation/reference-manual/cli.md @@ -3,7 +3,6 @@ title = "Garage CLI" weight = 15 +++ -# Garage CLI 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/content/documentation/reference-manual/configuration.md b/content/documentation/reference-manual/configuration.md index 1b3782c..72c22d1 100644 --- a/content/documentation/reference-manual/configuration.md +++ b/content/documentation/reference-manual/configuration.md @@ -1,9 +1,8 @@ +++ -title = "Garage configuration file" +title = "Configuration file format" weight = 5 +++ -# Garage configuration file format reference Here is an example `garage.toml` configuration file that illustrates all of the possible options: diff --git a/content/documentation/reference-manual/layout.md b/content/documentation/reference-manual/layout.md index 79afccf..ab93d7c 100644 --- a/content/documentation/reference-manual/layout.md +++ b/content/documentation/reference-manual/layout.md @@ -3,7 +3,6 @@ title = "Cluster layout management" weight = 10 +++ -# Creating and updating a cluster layout 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 diff --git a/content/documentation/reference-manual/s3_compatibility.md b/content/documentation/reference-manual/s3_compatibility.md index 7160da9..9a66610 100644 --- a/content/documentation/reference-manual/s3_compatibility.md +++ b/content/documentation/reference-manual/s3_compatibility.md @@ -3,7 +3,6 @@ title = "S3 Compatibility status" weight = 20 +++ -# S3 Compatibility status ## Global S3 features diff --git a/content/documentation/working-documents/compatibility_target.md b/content/documentation/working-documents/compatibility_target.md index 3f1b357..6ac47cc 100644 --- a/content/documentation/working-documents/compatibility_target.md +++ b/content/documentation/working-documents/compatibility_target.md @@ -3,7 +3,6 @@ title = "S3 compatibility target" weight = 5 +++ -# S3 compatibility target 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/content/documentation/working-documents/design_draft.md b/content/documentation/working-documents/design_draft.md index 90c2d1c..78e82c3 100644 --- a/content/documentation/working-documents/design_draft.md +++ b/content/documentation/working-documents/design_draft.md @@ -3,7 +3,6 @@ title = "Design draft" weight = 25 +++ -# Design draft **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.** diff --git a/content/documentation/working-documents/load_balancing.md b/content/documentation/working-documents/load_balancing.md index 58a1bec..ba208fa 100644 --- a/content/documentation/working-documents/load_balancing.md +++ b/content/documentation/working-documents/load_balancing.md @@ -3,7 +3,6 @@ title = "Load balancing data" weight = 10 +++ -# Load Balancing Data (planned for version 0.2) **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/content/documentation/working-documents/migration_04.md b/content/documentation/working-documents/migration_04.md index 55dfdfe..302fdb1 100644 --- a/content/documentation/working-documents/migration_04.md +++ b/content/documentation/working-documents/migration_04.md @@ -3,7 +3,6 @@ title = "Migrating from 0.3 to 0.4" weight = 20 +++ -# Migrating from 0.3 to 0.4 **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/content/documentation/working-documents/migration_06.md b/content/documentation/working-documents/migration_06.md index 692e309..22d8274 100644 --- a/content/documentation/working-documents/migration_06.md +++ b/content/documentation/working-documents/migration_06.md @@ -3,7 +3,6 @@ title = "Migrating from 0.5 to 0.6" weight = 15 +++ -# Migrating from 0.5 to 0.6 **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.** |