Added markdown fake metadata to doc content

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

View file

@ -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)

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

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

View file

@ -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.

View file

@ -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.

View file

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

View file

@ -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:

View file

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

View file

@ -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.

View file

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

View file

@ -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.

View file

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

View file

@ -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.

View file

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

View file

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

View file

@ -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),

View file

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

View file

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

View file

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

View file

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

View file

@ -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.

View file

@ -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!

View file

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

View file

@ -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.

View file

@ -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.

View file

@ -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" />

View file

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

View file

@ -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

View file

@ -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:

View file

@ -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.

View file

@ -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

View file

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

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.**

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 is unsupported. This document is only intended to

View file

@ -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.