Skip to content

Commit

Permalink
doc(readme): Remove config example from README to prevent having to k…
Browse files Browse the repository at this point in the history
…eep multiple configs in sync
  • Loading branch information
ldebruijn committed Oct 3, 2023
1 parent 55f4f93 commit 7a9e895
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7a9e895

Please sign in to comment.