From 7a9e895adc6a95da19925391a7b6310879839d37 Mon Sep 17 00:00:00 2001 From: ldebruijn Date: Tue, 3 Oct 2023 09:09:55 +0200 Subject: [PATCH] doc(readme): Remove config example from README to prevent having to keep multiple configs in sync --- README.md | 29 ----------------------------- 1 file changed, 29 deletions(-) diff --git a/README.md b/README.md index 971e1da..9a12838 100644 --- a/README.md +++ b/README.md @@ -36,35 +36,6 @@ We recommend configuring the binary using a yaml file, place a file called `armo For all the configuration options check out the [Configuration Documentation](docs/configuration.md) -```yaml -web: - read_timeout: 5s - write_timeout: 10s - idle_timeout: 120s - shutdown_timeout: 20s - host: 0.0.0.0:8080 - path: /graphql - -target: - host: http://localhost:8081 - timeout: 10s - keep_alive: 180s - -persisted_operations: - enabled: true - fail_unknown_operations: true - store: - # Only one store will be used - # Armor will look at all files in the dir and try to load persisted operations from any `.json` file - dir: "./my-dir" - # Armor will look at all objects in the bucket and try to load persisted operations from any `.json` file - gcp_bucket: "gs://somebucket" - -field_suggestions: - enabled: true - mask: [redacted] -``` - Alternatively go-graphql-armor can be configured using environment variables or command line arguments. ## Contributing