garage/doc/book/src/SUMMARY.md

# Summary

[The Garage Data Store](./intro.md)

- [Quick start](./quick_start/index.md)

- [Cookbook](./cookbook/index.md)
  - [Multi-node deployment](./cookbook/real_world.md)
  - [Building from source](./cookbook/from_source.md)
  - [Integration with systemd](./cookbook/systemd.md)
  - [Configuring a gateway node](./cookbook/gateways.md)
  - [Exposing buckets as websites](./cookbook/exposing_websites.md)
  - [Configuring a reverse proxy](./cookbook/reverse_proxy.md)
  - [Recovering from failures](./cookbook/recovering.md)

- [Integrations](./connect/index.md)
  - [Apps (Nextcloud, Peertube...)](./connect/apps.md)
  - [Websites (Hugo, Jekyll, Publii...)](./connect/websites.md)
  - [Repositories (Docker, Nix, Git...)](./connect/repositories.md)
  - [CLI tools (rclone, awscli, mc...)](./connect/cli.md)
  - [Backups (restic, duplicity...)](./connect/backup.md)
  - [Your code (PHP, JS, Go...)](./connect/code.md)
  - [FUSE (s3fs, goofys, s3backer...)](./connect/fs.md)


- [Reference Manual](./reference_manual/index.md)
  - [Garage configuration file](./reference_manual/configuration.md)
  - [Cluster layout management](./reference_manual/layout.md)
  - [Garage CLI](./reference_manual/cli.md)
  - [S3 compatibility status](./reference_manual/s3_compatibility.md)

- [Design](./design/index.md)
  - [Goals and use Cases](./design/goals.md)
  - [Benchmarks](./design/benchmarks.md)
  - [Related work](./design/related_work.md)
  - [Internals](./design/internals.md)

- [Development](./development/index.md)
  - [Setup your environment](./development/devenv.md)
  - [Development scripts](./development/scripts.md)
  - [Release process](./development/release_process.md)
  - [Miscellaneous notes](./development/miscellaneous_notes.md)

- [Working Documents](./working_documents/index.md)
  - [S3 compatibility target](./working_documents/compatibility_target.md)
  - [Load balancing data](./working_documents/load_balancing.md)
  - [Migrating from 0.5 to 0.6](./working_documents/migration_06.md)
  - [Migrating from 0.3 to 0.4](./working_documents/migration_04.md)
  - [Design draft](./working_documents/design_draft.md)
Doc skeleton + intro 2021-03-17 14:44:14 +01:00			`# Summary`

			`[The Garage Data Store](./intro.md)`

Reorganize documentation 2021-05-31 17:13:36 +02:00			`- [Quick start](./quick_start/index.md)`
Doc skeleton + intro 2021-03-17 14:44:14 +01:00
Refactor file organization 2021-03-17 16:15:18 +01:00			`- [Cookbook](./cookbook/index.md)`
Improve how node roles are assigned in Garage - change the terminology: the network configuration becomes the role table, the configuration of a nodes becomes a node's role - the modification of the role table takes place in two steps: first, changes are staged in a CRDT data structure. Then, once the user is happy with the changes, they can commit them all at once (or revert them). - update documentation - fix tests - implement smarter partition assignation algorithm This patch breaks the format of the network configuration: when migrating, the cluster will be in a state where no roles are assigned. All roles must be re-assigned and commited at once. This migration should not pose an issue. 2021-11-09 12:24:04 +01:00			`- [Multi-node deployment](./cookbook/real_world.md)`
Reorganize documentation 2021-05-31 17:13:36 +02:00			`- [Building from source](./cookbook/from_source.md)`
Add doc for Nextcloud 2021-10-29 18:05:47 +02:00			`- [Integration with systemd](./cookbook/systemd.md)`
Reorganize and improve documentation 2021-12-06 16:10:32 +01:00			`- [Configuring a gateway node](./cookbook/gateways.md)`
Documentation for hugo, jekyll and publii 2021-11-04 10:51:15 +01:00			`- [Exposing buckets as websites](./cookbook/exposing_websites.md)`
Doc about exposing your website 2021-11-04 12:06:38 +01:00			`- [Configuring a reverse proxy](./cookbook/reverse_proxy.md)`
Add doc for Nextcloud 2021-10-29 18:05:47 +02:00			`- [Recovering from failures](./cookbook/recovering.md)`

			`- [Integrations](./connect/index.md)`
			`- [Apps (Nextcloud, Peertube...)](./connect/apps.md)`
			`- [Websites (Hugo, Jekyll, Publii...)](./connect/websites.md)`
Documentation for Nix binary cache 2021-11-10 10:01:48 +01:00			`- [Repositories (Docker, Nix, Git...)](./connect/repositories.md)`
Add doc for Nextcloud 2021-10-29 18:05:47 +02:00			`- [CLI tools (rclone, awscli, mc...)](./connect/cli.md)`
Add skeleton for backups, fuse and code sections 2021-11-10 18:05:07 +01:00			`- [Backups (restic, duplicity...)](./connect/backup.md)`
Add doc for Nextcloud 2021-10-29 18:05:47 +02:00			`- [Your code (PHP, JS, Go...)](./connect/code.md)`
Add skeleton for backups, fuse and code sections 2021-11-10 18:05:07 +01:00			`- [FUSE (s3fs, goofys, s3backer...)](./connect/fs.md)`
Add doc for Nextcloud 2021-10-29 18:05:47 +02:00
Work on structure + Getting started is reworked 2021-03-17 15:44:29 +01:00
Refactor file organization 2021-03-17 16:15:18 +01:00			`- [Reference Manual](./reference_manual/index.md)`
Write documentation on configuration file and other improvements 2021-05-28 18:00:59 +02:00			`- [Garage configuration file](./reference_manual/configuration.md)`
Improve how node roles are assigned in Garage - change the terminology: the network configuration becomes the role table, the configuration of a nodes becomes a node's role - the modification of the role table takes place in two steps: first, changes are staged in a CRDT data structure. Then, once the user is happy with the changes, they can commit them all at once (or revert them). - update documentation - fix tests - implement smarter partition assignation algorithm This patch breaks the format of the network configuration: when migrating, the cluster will be in a state where no roles are assigned. All roles must be re-assigned and commited at once. This migration should not pose an issue. 2021-11-09 12:24:04 +01:00			`- [Cluster layout management](./reference_manual/layout.md)`
Write documentation on configuration file and other improvements 2021-05-28 18:00:59 +02:00			`- [Garage CLI](./reference_manual/cli.md)`
Updates to documentation 2021-05-31 17:23:35 +02:00			`- [S3 compatibility status](./reference_manual/s3_compatibility.md)`
Work on structure + Getting started is reworked 2021-03-17 15:44:29 +01:00
Refactor file organization 2021-03-17 16:15:18 +01:00			`- [Design](./design/index.md)`
Reorganize and improve documentation 2021-12-06 16:10:32 +01:00			`- [Goals and use Cases](./design/goals.md)`
Add a benchmark page with a first benchmark 2021-12-08 11:30:07 +01:00			`- [Benchmarks](./design/benchmarks.md)`
Reorganize and improve documentation 2021-12-06 16:10:32 +01:00			`- [Related work](./design/related_work.md)`
Refactor file organization 2021-03-17 16:15:18 +01:00			`- [Internals](./design/internals.md)`
Work on structure + Getting started is reworked 2021-03-17 15:44:29 +01:00
Refactor file organization 2021-03-17 16:15:18 +01:00			`- [Development](./development/index.md)`
			`- [Setup your environment](./development/devenv.md)`
Build Garage with Nix 2021-10-04 18:27:57 +02:00			`- [Development scripts](./development/scripts.md)`
			`- [Release process](./development/release_process.md)`
Documentation for Nix binary cache 2021-11-10 10:01:48 +01:00			`- [Miscellaneous notes](./development/miscellaneous_notes.md)`
Refactor file organization 2021-03-17 16:15:18 +01:00
			`- [Working Documents](./working_documents/index.md)`
S3 compatibility target 2021-12-06 17:18:45 +01:00			`- [S3 compatibility target](./working_documents/compatibility_target.md)`
Reorganize and improve documentation 2021-12-06 16:10:32 +01:00			`- [Load balancing data](./working_documents/load_balancing.md)`
Add documentation to migrate to 0.6 2022-01-10 14:39:35 +01:00			`- [Migrating from 0.5 to 0.6](./working_documents/migration_06.md)`
Improve CLI, adapt tests, update documentation 2021-10-19 16:16:10 +02:00			`- [Migrating from 0.3 to 0.4](./working_documents/migration_04.md)`
Reorganize and improve documentation 2021-12-06 16:10:32 +01:00			`- [Design draft](./working_documents/design_draft.md)`