aboutsummaryrefslogtreecommitdiff
path: root/doc/book
Commit message (Collapse)AuthorAgeFilesLines
* [doc-units] document how interval value is parsedAlex Auvolat2024-04-031-3/+5
|
* [fix-buffering] implement `block_ram_buffer_max` to avoid excessive RAM usageAlex Auvolat2024-03-272-0/+44
|
* [syslog] document environment variablesAlex Auvolat2024-03-202-1/+24
|
* Update WinSCP link in documentationstefano2024-03-191-1/+1
| | | | Update link to new wiki location. See Deuxfleurs/garage#780
* [db-snapshot] documentation for metadata db snapshotsdb-snapshotAlex Auvolat2024-03-155-7/+114
|
* [disable-scrub] document `disable_scrub` config optiondisable-scrubAlex Auvolat2024-03-142-1/+19
|
* [doc-updates] from source: fix default feature listAlex Auvolat2024-03-141-2/+2
|
* [doc-updates] doc: be slightly more critical of LMDBAlex Auvolat2024-03-143-31/+53
|
* [rel-0.9.3] Bump version to 0.9.3v0.9.3Alex Auvolat2024-03-041-5/+5
|
* doc: fix typo in connect/backup.mdArmaël Guéneau2024-03-031-2/+2
|
* [rel-0.9.2] Bump version to v0.9.2v0.9.2rel-0.9.2Alex Auvolat2024-03-011-5/+5
|
* Merge pull request 'Docs: add default metrics_token in quick start + ↵Alex2024-02-292-5/+6
|\ | | | | | | | | | | uniformize use of base64' (#739) from doc-default-token into main Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/739
| * [doc-default-token] add default metrics_token in quick start + uniformize ↵Alex Auvolat2024-02-292-5/+6
| | | | | | | | use of base64
* | [doc-dedup] reorder features, move no-RAFT downAlex Auvolat2024-02-281-11/+11
| |
* | [doc-dedup] fix #rpc_bind_outgoing anchor in config pageAlex Auvolat2024-02-281-1/+1
| |
* | [doc-dedup] mention deduplication and compression in features pageAlex Auvolat2024-02-281-0/+8
|/
* doc: reverse-proxy.md: Added section on caddy-fs-s3.Jonathan Davies2024-02-261-0/+29
|
* Align admin endpoint porthartraft2024-02-201-1/+1
|
* Minor typos and grammarhartraft2024-02-201-6/+6
|
* Typohartraft2024-02-201-1/+1
| | | | Fix small typo on the getting started guide
* [peer-metrics] add documentation for new cluster status metricspeer-metricsAlex Auvolat2024-02-201-0/+106
|
* [networking-fixes] add doc for rpc_bind_outgoingnetworking-fixesAlex Auvolat2024-02-191-0/+13
|
* [doc-fixes] configuration reference: fix typo and set block size in MAlex Auvolat2024-02-191-2/+2
|
* [doc-fixes] fixes to index of configuration optionsAlex Auvolat2024-02-191-13/+10
|
* doc: mention `warn` and `error` as available log levelsemilylange2024-02-121-3/+4
| | | | | | | | | | | | | For some users, this might be their first time being interacting with the `env_logger` crate. As such, they might not be aware that less verbose log levels exist. Some might not want to log every incoming request, for example. This commit also adds syntax hints to the code-fence for bash for better syntax highlighting of that section, and repeats itself multiple times, that `info` is, in fact, the default. No changes to the recommendation of log levels were made.
* [nix-improvements] get rid of DroneAlex Auvolat2024-02-094-46/+21
|
* doc: fix some typosArmaël Guéneau2024-01-273-9/+9
|
* Bump version to 0.9.1v0.9.1rel-v0.9.1Alex Auvolat2024-01-161-5/+5
|
* Merge tag 'v0.8.5' into sync-08-09Alex Auvolat2024-01-161-3/+19
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Garage v0.8.5 This minor release includes the following improvements and fixes: New features: - Configuration: make LMDB's `map_size` configurable and make `block_size` and `sled_cache_capacity` expressable as strings (such as `10M`) (#628, #630) - Add support for binding to Unix sockets for the S3, K2V, Admin and Web API servers (#640) - Move the `convert_db` command into the main Garage binary (#645) - Add support for specifying RPC secret and admin tokens as environment variables (#643) - Add `allow_world_readable_secrets` option to config file (#663, #685) Bug fixes: - Use `statvfs` instead of mount list to determine free space in metadata/data directories (#611, #631) - Add missing casts to fix 32-bit build (#632) - Fix error when none of the HTTP servers (S3/K2V/Admin/Web) is started and fix shutdown hang (#613, #633) - Add missing CORS headers to PostObject response (#609, #656) - Monitoring: finer histogram boundaries in Prometheus exported metrics (#531, #686) Other: - Documentation improvements (#641)
| * config: refactor secret sourcingAlex Auvolat2024-01-151-4/+3
| |
| * Add allow_world_readable_secrets option to config fileFélix Baylac Jacqué2023-10-261-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sometimes, the secret files permissions checks gets in the way. It's by no mean complete, it doesn't take the Posix ACLs into account among other things. Correctly checking the ACLs would be too involving (see https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/658#issuecomment-7102) and would likely still fail in some weird chmod settings. We're adding a new configuration file key allowing the user to disable this permission check altogether. The (already existing) env variable counterpart always take precedence to this config file option. That's useful in cases where the configuration file is static and cannot be easily altered. Fixes https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/658 Co-authored-by: Florian Klink <flokli@flokli.de>
| * docs: add documentation for specifying token / secret file as environment ↵networkException2023-10-191-3/+8
| | | | | | | | variables
* | Merge pull request 'fix typo in peertube doc' (#617) from ↵Alex2024-01-111-2/+2
|\ \ | | | | | | | | | | | | | | | Lapineige/garage:main into main Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/617
| * | another typoLapineige2023-08-191-1/+1
| | |
| * | fix typoLapineige2023-08-191-1/+1
| | |
* | | Merge pull request 'OpenAPI specification of admin APIv1' (#672) from api-v1 ↵Alex2023-11-294-24/+84
|\ \ \ | | | | | | | | | | | | | | | | | | | | into main Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/672
| * | | fix the docapi-v1Quentin Dufour2023-11-284-24/+84
| | | |
* | | | doc: move replication_mode to top of configuration page referencefix-doc-db-engineAlex Auvolat2023-11-281-85/+85
| | | |
* | | | doc: improve navigation in configuration referenceAlex Auvolat2023-11-284-43/+100
| | | |
* | | | doc: update the `db_engine` sectionAlex Auvolat2023-11-281-27/+30
|/ / /
* | | doc: update quick start and real world for v0.9.0doc-updatesAlex Auvolat2023-10-112-44/+52
| | |
* | | doc: updates to the "migrating to v0.9" pageAlex Auvolat2023-10-101-3/+6
| | |
* | | upgrade doc: fixes and precisionsAlex Auvolat2023-10-051-3/+4
| | |
* | | Add migration to v0.9 guideAlex Auvolat2023-10-051-0/+68
| | |
* | | Merge branch 'main' into nextv0.9.0-rc1Alex Auvolat2023-10-034-7/+17
|\ \ \ | | |/ | |/|
| * | Merge pull request 'Add support for binding to unix domain sockets' (#640) ↵Alex2023-10-031-0/+7
| |\ \ | | | | | | | | | | | | | | | | | | | | from networkException/garage:unix-sockets into main Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/640
| | * | doc: add documentation for specifying unix socket pathsnetworkException2023-10-031-0/+7
| | | |
| * | | doc: update endpoint_url documentationFlorian Klink2023-10-023-7/+10
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since `awscli` `>=1.29.0` or `>=2.13.0` it is now possible to use the `AWS_ENDPOINT_URL` environment variable, or the `endpoint_url` config key to override the endpoint URL. This means, the aws bash function to wrap with --endpoint-url is not necessary anymore. Update invocations to reflect that. https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html https://github.com/aws/aws-cli/issues/4454#issuecomment-1626116607
* | | layout doc: reformulatenew-layout-uxAlex Auvolat2023-09-221-7/+8
| | |
* | | layout doc: write explanations for bizarre scenariosAlex Auvolat2023-09-221-0/+74
| | |