Skip to content

Commit

Permalink
chore(docs): describe configuration file by automatically generating …
Browse files Browse the repository at this point in the history
…docs from the Config structs
  • Loading branch information
rkettelerij committed Oct 18, 2024
1 parent 869d1ac commit 4dc5a63
Show file tree
Hide file tree
Showing 4 changed files with 319 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,11 @@ docker run -v `pwd`/examples:/examples -p 8080:8080 -it pdok/gokoala --config-fi
Now open <http://localhost:8080>. See [examples](examples) for more details.
### Configuration file
## Config
The configuration file consists of a general section and a section
See the full **[Configuration Reference](./docs/README.md)** for available options.
The configuration YAML file consists of a general section and a section
per OGC API building block (tiles, styles, etc). See [example configuration
files](examples/) for details. You can reference environment variables in the
configuration file. For example to use the `MY_SERVER` env var:
Expand Down
1 change: 1 addition & 0 deletions config/config.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//go:generate ../hack/generate-deepcopy.sh
//go:generate ../hack/generate-config-docs.sh
package config

import (
Expand Down
Loading

0 comments on commit 4dc5a63

Please sign in to comment.