withinboredom/garage
1
0
Fork 0
forked from Deuxfleurs/garage
Code Issues Pull requests Projects Releases Wiki Activity

Updates to documentation

Browse source
This commit is contained in:
Alex 2021-05-31 17:23:35 +02:00
parent d76a8576f4
commit 56ac9fd460
No known key found for this signature in database
GPG key ID: EDABF9711E244EB1
3 changed files with 18 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/book/src/SUMMARY.md
View file

@ -17,7 +17,7 @@
- [Reference Manual](./reference_manual/index.md) - [Reference Manual](./reference_manual/index.md)
- [Garage configuration file](./reference_manual/configuration.md) - [Garage configuration file](./reference_manual/configuration.md)
- [Garage CLI](./reference_manual/cli.md) - [Garage CLI](./reference_manual/cli.md)
- [S3 API](./reference_manual/s3_compatibility.md) - [S3 compatibility status](./reference_manual/s3_compatibility.md)
- [Design](./design/index.md) - [Design](./design/index.md)
- [Related Work](./design/related_work.md) - [Related Work](./design/related_work.md)

7
doc/book/src/quick_start/index.md
View file

@ -65,11 +65,10 @@ your data to be persisted properly.
Use the following command to launch the Garage server with our configuration file: Use the following command to launch the Garage server with our configuration file:
``` ```
garage server -c garage.toml RUST_LOG=garage=info garage server -c garage.toml
``` ```
By default, Garage displays almost no output. You can tune Garage's verbosity as follows You can tune Garage's verbosity as follows (from less verbose to more verbose):
(from less verbose to more verbose):
``` ```
RUST_LOG=garage=info garage server -c garage.toml RUST_LOG=garage=info garage server -c garage.toml
@ -262,5 +261,5 @@ The following tools can also be used to send and recieve files from/to Garage:
- [Cyberduck](https://cyberduck.io/) - [Cyberduck](https://cyberduck.io/)
- [`s3cmd`](https://s3tools.org/s3cmd) - [`s3cmd`](https://s3tools.org/s3cmd)
Refer to the ["configuring clients"](../cookbook/clients.md) to learn how to configure Refer to the ["configuring clients"](../cookbook/clients.md) page to learn how to configure
these clients to interact with a Garage server. these clients to interact with a Garage server.

14
doc/book/src/reference_manual/s3_compatibility.md
View file

@ -14,6 +14,7 @@ Not implemented:
- vhost-style URLs (`bucket.garage.tld/key`) - vhost-style URLs (`bucket.garage.tld/key`)
- object-level ACL - object-level ACL
- object versioning
- encryption - encryption
- most `x-amz-` headers - most `x-amz-` headers
@ -54,6 +55,15 @@ Implemented.
Implemented. Implemented.
#### GetBucketLocation
Implemented.
#### GetBucketVersioning
Stub implementation (Garage does not yet support versionning so this always returns
"versionning not enabled").
#### GetObject #### GetObject
Implemented. Implemented.
@ -66,6 +76,10 @@ Implemented.
Implemented. Implemented.
#### ListBuckets
Implemented.
#### ListObjects #### ListObjects
Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2. Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.