Deuxfleurs/garagehq.deuxfleurs.fr
26
2
Fork 1
Code Issues 5 Pull requests 3 Projects Releases Wiki Activity

Added markdown fake metadata to doc content

Browse source
This commit is contained in:
Lucas Chaplain 2022-01-24 21:08:34 +01:00
parent dc932f9735
commit ada5e9ac0e
40 changed files with 200 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
content/documentation/connect/apps.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Apps (Nextcloud, Peertube...) # Apps (Nextcloud, Peertube...)
In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix) In this section, we cover the following software: [Nextcloud](#nextcloud), [Peertube](#peertube), [Mastodon](#mastodon), [Matrix](#matrix)

5
content/documentation/connect/backup.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Backups (restic, duplicity...) # Backups (restic, duplicity...)
Backups are essential for disaster recovery but they are not trivial to manage. Backups are essential for disaster recovery but they are not trivial to manage.

5
content/documentation/connect/cli.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# CLI tools # CLI tools
CLI tools allow you to query the S3 API without too many abstractions. CLI tools allow you to query the S3 API without too many abstractions.

5
content/documentation/connect/code.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Your code (PHP, JS, Go...) # Your code (PHP, JS, Go...)
If you are developping a new application, you may want to use Garage to store your user's media. If you are developping a new application, you may want to use Garage to store your user's media.

5
content/documentation/connect/fs.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# FUSE (s3fs, goofys, s3backer...) # FUSE (s3fs, goofys, s3backer...)
**WARNING! Garage is not POSIX compatible. **WARNING! Garage is not POSIX compatible.

5
content/documentation/connect/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Integrations # Integrations
Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs. Garage implements the Amazon S3 protocol, which makes it compatible with many existing software programs.

5
content/documentation/connect/repositories.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Repositories (Docker, Nix, Git...) # 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. 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.

5
content/documentation/connect/websites.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Websites (Hugo, Jekyll, Publii...) # Websites (Hugo, Jekyll, Publii...)
Garage is also suitable to host static websites. Garage is also suitable to host static websites.

5
content/documentation/cookbook/exposing_websites.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Exposing buckets as websites # Exposing buckets as websites
You can expose your bucket as a website with this simple command: You can expose your bucket as a website with this simple command:

5
content/documentation/cookbook/from_source.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Compiling Garage from source # Compiling Garage from source

5
content/documentation/cookbook/gateways.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Gateways # Gateways
Gateways allow you to expose Garage endpoints (S3 API and websites) without storing data on the node. Gateways allow you to expose Garage endpoints (S3 API and websites) without storing data on the node.

5
content/documentation/cookbook/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Cookbook # Cookbook
A cookbook, when you cook, is a collection of recipes. A cookbook, when you cook, is a collection of recipes.

5
content/documentation/cookbook/real_world.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Deploying Garage on a real-world cluster # Deploying Garage on a real-world cluster
To run Garage in cluster mode, we recommend having at least 3 nodes. To run Garage in cluster mode, we recommend having at least 3 nodes.

5
content/documentation/cookbook/recovering.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Recovering from failures # Recovering from failures
Garage is meant to work on old, second-hand hardware. Garage is meant to work on old, second-hand hardware.

5
content/documentation/cookbook/reverse_proxy.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Configuring a reverse proxy # Configuring a reverse proxy
The main reason to add a reverse proxy in front of Garage is to provide TLS to your users. The main reason to add a reverse proxy in front of Garage is to provide TLS to your users.

5
content/documentation/cookbook/systemd.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Starting Garage with systemd # Starting Garage with systemd
We make some assumptions for this systemd deployment. We make some assumptions for this systemd deployment.

5
content/documentation/cookbook/website.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Hosting a website # Hosting a website
TODO TODO

5
content/documentation/design/benchmarks.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Benchmarks # Benchmarks
With Garage, we wanted to build a software defined storage service that follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle), With Garage, we wanted to build a software defined storage service that follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle),

5
content/documentation/design/goals.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Goals and use cases # Goals and use cases
## Goals and non-goals ## Goals and non-goals

5
content/documentation/design/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Design # Design
The design section helps you to see Garage from a "big picture" The design section helps you to see Garage from a "big picture"

5
content/documentation/design/internals.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Internals # Internals
## Overview ## Overview

5
content/documentation/design/related_work.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Related work # Related work
## Context ## Context

5
content/documentation/development/devenv.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Setup your development environment # Setup your development environment
Depending on your tastes, you can bootstrap your development environment in a traditional Rust way or through Nix. Depending on your tastes, you can bootstrap your development environment in a traditional Rust way or through Nix.

5
content/documentation/development/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Development # Development
Now that you are a Garage expert, you want to enhance it, you are in the right place! Now that you are a Garage expert, you want to enhance it, you are in the right place!

5
content/documentation/development/miscellaneous_notes.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Miscellaneous Notes # Miscellaneous Notes
## Quirks about cargo2nix/rust in Nix ## Quirks about cargo2nix/rust in Nix

5
content/documentation/development/release_process.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Release process # Release process
Before releasing a new version of Garage, our code pass through a succession of checks and transformations. Before releasing a new version of Garage, our code pass through a succession of checks and transformations.

5
content/documentation/development/scripts.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Development scripts # Development scripts
We maintain a `script/` folder that contains some useful script to ease testing on Garage. We maintain a `script/` folder that contains some useful script to ease testing on Garage.

5
content/documentation/intro.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
<p align="center" style="text-align:center;"> <p align="center" style="text-align:center;">
<a href="https://garagehq.deuxfleurs.fr"> <a href="https://garagehq.deuxfleurs.fr">
<img alt="Garage's Logo" src="img/logo.svg" height="200" /> <img alt="Garage's Logo" src="img/logo.svg" height="200" />

5
content/documentation/quick_start/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Quick Start # Quick Start
Let's start your Garage journey! Let's start your Garage journey!

5
content/documentation/reference_manual/cli.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Garage CLI # Garage CLI
The Garage CLI is mostly self-documented. Make use of the `help` subcommand The Garage CLI is mostly self-documented. Make use of the `help` subcommand

5
content/documentation/reference_manual/configuration.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Garage configuration file format reference # Garage configuration file format reference
Here is an example `garage.toml` configuration file that illustrates all of the possible options: Here is an example `garage.toml` configuration file that illustrates all of the possible options:

5
content/documentation/reference_manual/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Reference Manual # Reference Manual
A reference manual contains some extensive descriptions about the features and the behaviour of the software. A reference manual contains some extensive descriptions about the features and the behaviour of the software.

5
content/documentation/reference_manual/layout.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Creating and updating a cluster layout # Creating and updating a cluster layout
The cluster layout in Garage is a table that assigns to each node a role in The cluster layout in Garage is a table that assigns to each node a role in

5
content/documentation/reference_manual/s3_compatibility.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# S3 Compatibility status # S3 Compatibility status
## Global S3 features ## Global S3 features

5
content/documentation/working_documents/compatibility_target.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# S3 compatibility target # S3 compatibility target
If there is a specific S3 functionnality you have a need for, feel free to open If there is a specific S3 functionnality you have a need for, feel free to open

5
content/documentation/working_documents/design_draft.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Design draft # Design draft
**WARNING: this documentation is a design draft which was written before Garage's actual implementation. **WARNING: this documentation is a design draft which was written before Garage's actual implementation.

5
content/documentation/working_documents/index.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Working Documents # Working Documents
Working documents are documents that reflect the fact that Garage is a software that evolves quickly. Working documents are documents that reflect the fact that Garage is a software that evolves quickly.

5
content/documentation/working_documents/load_balancing.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Load Balancing Data (planned for version 0.2) # 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.** **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.**

5
content/documentation/working_documents/migration_04.md
View file

@ -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
**Migrating from 0.3 to 0.4 is unsupported. This document is only intended to **Migrating from 0.3 to 0.4 is unsupported. This document is only intended to

5
content/documentation/working_documents/migration_06.md
View file

@ -1,3 +1,8 @@
+++
title="Doc Post"
date=2018-08-20
+++
# Migrating from 0.5 to 0.6 # Migrating from 0.5 to 0.6
**This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster. **This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster.