diff options
40 files changed, 200 insertions, 0 deletions
diff --git a/content/documentation/connect/apps.md b/content/documentation/connect/apps.md index 14d69ef..f88e334 100644 --- a/content/documentation/connect/apps.md +++ b/content/documentation/connect/apps.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Apps (Nextcloud, Peertube...) In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix) diff --git a/content/documentation/connect/backup.md b/content/documentation/connect/backup.md index a0af383..60a875b 100644 --- a/content/documentation/connect/backup.md +++ b/content/documentation/connect/backup.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Backups (restic, duplicity...) Backups are essential for disaster recovery but they are not trivial to manage. diff --git a/content/documentation/connect/cli.md b/content/documentation/connect/cli.md index c78ed30..d6b5fba 100644 --- a/content/documentation/connect/cli.md +++ b/content/documentation/connect/cli.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # CLI tools CLI tools allow you to query the S3 API without too many abstractions. diff --git a/content/documentation/connect/code.md b/content/documentation/connect/code.md index 3d7acd5..2224293 100644 --- a/content/documentation/connect/code.md +++ b/content/documentation/connect/code.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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 be8a340..8258acc 100644 --- a/content/documentation/connect/fs.md +++ b/content/documentation/connect/fs.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # FUSE (s3fs, goofys, s3backer...) **WARNING! Garage is not POSIX compatible. diff --git a/content/documentation/connect/index.md b/content/documentation/connect/index.md index 60a3b03..a01bc48 100644 --- a/content/documentation/connect/index.md +++ b/content/documentation/connect/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Integrations Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs. diff --git a/content/documentation/connect/repositories.md b/content/documentation/connect/repositories.md index 8a3dce1..429a15a 100644 --- a/content/documentation/connect/repositories.md +++ b/content/documentation/connect/repositories.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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. diff --git a/content/documentation/connect/websites.md b/content/documentation/connect/websites.md index 6f66c8d..70c9de6 100644 --- a/content/documentation/connect/websites.md +++ b/content/documentation/connect/websites.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Websites (Hugo, Jekyll, Publii...) Garage is also suitable to host static websites. diff --git a/content/documentation/cookbook/exposing_websites.md b/content/documentation/cookbook/exposing_websites.md index 0cbb115..1b55a08 100644 --- a/content/documentation/cookbook/exposing_websites.md +++ b/content/documentation/cookbook/exposing_websites.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Exposing buckets as websites You can expose your bucket as a website with this simple command: diff --git a/content/documentation/cookbook/from_source.md b/content/documentation/cookbook/from_source.md index 167f01d..38ede4d 100644 --- a/content/documentation/cookbook/from_source.md +++ b/content/documentation/cookbook/from_source.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Compiling Garage from source diff --git a/content/documentation/cookbook/gateways.md b/content/documentation/cookbook/gateways.md index f03671a..f176c5e 100644 --- a/content/documentation/cookbook/gateways.md +++ b/content/documentation/cookbook/gateways.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-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/index.md b/content/documentation/cookbook/index.md index 792a5e6..764ee0c 100644 --- a/content/documentation/cookbook/index.md +++ b/content/documentation/cookbook/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Cookbook A cookbook, when you cook, is a collection of recipes. diff --git a/content/documentation/cookbook/real_world.md b/content/documentation/cookbook/real_world.md index 906fe31..7d6d77e 100644 --- a/content/documentation/cookbook/real_world.md +++ b/content/documentation/cookbook/real_world.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Deploying Garage on a real-world cluster To run Garage in cluster mode, we recommend having at least 3 nodes. diff --git a/content/documentation/cookbook/recovering.md b/content/documentation/cookbook/recovering.md index 279d574..2b8e2f0 100644 --- a/content/documentation/cookbook/recovering.md +++ b/content/documentation/cookbook/recovering.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Recovering from failures Garage is meant to work on old, second-hand hardware. diff --git a/content/documentation/cookbook/reverse_proxy.md b/content/documentation/cookbook/reverse_proxy.md index 14633ae..36d3535 100644 --- a/content/documentation/cookbook/reverse_proxy.md +++ b/content/documentation/cookbook/reverse_proxy.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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 ff3541f..cb40b6a 100644 --- a/content/documentation/cookbook/systemd.md +++ b/content/documentation/cookbook/systemd.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Starting Garage with systemd We make some assumptions for this systemd deployment. diff --git a/content/documentation/cookbook/website.md b/content/documentation/cookbook/website.md index 53488ac..a5e378f 100644 --- a/content/documentation/cookbook/website.md +++ b/content/documentation/cookbook/website.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Hosting a website TODO diff --git a/content/documentation/design/benchmarks.md b/content/documentation/design/benchmarks.md index 6e5580e..b339df1 100644 --- a/content/documentation/design/benchmarks.md +++ b/content/documentation/design/benchmarks.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Benchmarks With Garage, we wanted to build a software defined storage service that follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle), diff --git a/content/documentation/design/goals.md b/content/documentation/design/goals.md index 10ef6a8..539b3b4 100644 --- a/content/documentation/design/goals.md +++ b/content/documentation/design/goals.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Goals and use cases ## Goals and non-goals diff --git a/content/documentation/design/index.md b/content/documentation/design/index.md index 2e3b5fd..f84af11 100644 --- a/content/documentation/design/index.md +++ b/content/documentation/design/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Design The design section helps you to see Garage from a "big picture" diff --git a/content/documentation/design/internals.md b/content/documentation/design/internals.md index 0b31584..2cb5792 100644 --- a/content/documentation/design/internals.md +++ b/content/documentation/design/internals.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Internals ## Overview diff --git a/content/documentation/design/related_work.md b/content/documentation/design/related_work.md index da3f807..e11652c 100644 --- a/content/documentation/design/related_work.md +++ b/content/documentation/design/related_work.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Related work ## Context diff --git a/content/documentation/development/devenv.md b/content/documentation/development/devenv.md index 78affa4..2979141 100644 --- a/content/documentation/development/devenv.md +++ b/content/documentation/development/devenv.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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/index.md b/content/documentation/development/index.md index 09147ec..9ca1f70 100644 --- a/content/documentation/development/index.md +++ b/content/documentation/development/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Development Now that you are a Garage expert, you want to enhance it, you are in the right place! diff --git a/content/documentation/development/miscellaneous_notes.md b/content/documentation/development/miscellaneous_notes.md index 1adc574..aba4802 100644 --- a/content/documentation/development/miscellaneous_notes.md +++ b/content/documentation/development/miscellaneous_notes.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-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 e6f9e60..50673ae 100644 --- a/content/documentation/development/release_process.md +++ b/content/documentation/development/release_process.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Release process Before releasing a new version of Garage, our code pass through a succession of checks and transformations. diff --git a/content/documentation/development/scripts.md b/content/documentation/development/scripts.md index 387cb34..bfcb047 100644 --- a/content/documentation/development/scripts.md +++ b/content/documentation/development/scripts.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Development scripts We maintain a `script/` folder that contains some useful script to ease testing on Garage. diff --git a/content/documentation/intro.md b/content/documentation/intro.md index 5d6e2cf..8c97b8f 100644 --- a/content/documentation/intro.md +++ b/content/documentation/intro.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + <p align="center" style="text-align:center;"> <a href="https://garagehq.deuxfleurs.fr"> <img alt="Garage's Logo" src="img/logo.svg" height="200" /> diff --git a/content/documentation/quick_start/index.md b/content/documentation/quick_start/index.md index ffb3ebb..54f6f8d 100644 --- a/content/documentation/quick_start/index.md +++ b/content/documentation/quick_start/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Quick Start Let's start your Garage journey! diff --git a/content/documentation/reference_manual/cli.md b/content/documentation/reference_manual/cli.md index 80789b9..3f7bd7a 100644 --- a/content/documentation/reference_manual/cli.md +++ b/content/documentation/reference_manual/cli.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Garage CLI The Garage CLI is mostly self-documented. Make use of the `help` subcommand diff --git a/content/documentation/reference_manual/configuration.md b/content/documentation/reference_manual/configuration.md index 9f88b23..9a2e314 100644 --- a/content/documentation/reference_manual/configuration.md +++ b/content/documentation/reference_manual/configuration.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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/index.md b/content/documentation/reference_manual/index.md index 0d4bd6f..cdff814 100644 --- a/content/documentation/reference_manual/index.md +++ b/content/documentation/reference_manual/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Reference Manual A reference manual contains some extensive descriptions about the features and the behaviour of the software. diff --git a/content/documentation/reference_manual/layout.md b/content/documentation/reference_manual/layout.md index 80c71d6..3d325c7 100644 --- a/content/documentation/reference_manual/layout.md +++ b/content/documentation/reference_manual/layout.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Creating and updating a cluster layout The cluster layout in Garage is a table that assigns to each node a role in diff --git a/content/documentation/reference_manual/s3_compatibility.md b/content/documentation/reference_manual/s3_compatibility.md index 4c4c645..98b6170 100644 --- a/content/documentation/reference_manual/s3_compatibility.md +++ b/content/documentation/reference_manual/s3_compatibility.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-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 8830101..51c6e2e 100644 --- a/content/documentation/working_documents/compatibility_target.md +++ b/content/documentation/working_documents/compatibility_target.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # S3 compatibility target If there is a specific S3 functionnality you have a need for, feel free to open diff --git a/content/documentation/working_documents/design_draft.md b/content/documentation/working_documents/design_draft.md index 06ed46b..2ac3e0d 100644 --- a/content/documentation/working_documents/design_draft.md +++ b/content/documentation/working_documents/design_draft.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Design draft **WARNING: this documentation is a design draft which was written before Garage's actual implementation. diff --git a/content/documentation/working_documents/index.md b/content/documentation/working_documents/index.md index a9e7f89..8c0f1f0 100644 --- a/content/documentation/working_documents/index.md +++ b/content/documentation/working_documents/index.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Working Documents Working documents are documents that reflect the fact that Garage is a software that evolves quickly. diff --git a/content/documentation/working_documents/load_balancing.md b/content/documentation/working_documents/load_balancing.md index 99271ad..e6fa3e8 100644 --- a/content/documentation/working_documents/load_balancing.md +++ b/content/documentation/working_documents/load_balancing.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # 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 05e7eaf..92ec71e 100644 --- a/content/documentation/working_documents/migration_04.md +++ b/content/documentation/working_documents/migration_04.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Migrating from 0.3 to 0.4 **Migrating from 0.3 to 0.4 is unsupported. This document is only intended to diff --git a/content/documentation/working_documents/migration_06.md b/content/documentation/working_documents/migration_06.md index 4312e37..dd180d5 100644 --- a/content/documentation/working_documents/migration_06.md +++ b/content/documentation/working_documents/migration_06.md @@ -1,3 +1,8 @@ ++++ +title="Doc Post" +date=2018-08-20 ++++ + # Migrating from 0.5 to 0.6 **This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster. |