Configuration Reference
These pages describe every configuration option tilegroxy supports.
Structure
The following is the top-level configuration structure. All top-level keys are optional besides layers:
server: ... (1)
health: ... (2)
client: ... (3)
logging: ... (4)
telemetry: ... (5)
error: ... (6)
secret: ... (7)
authentication: ... (8)
cache: ... (9)
defaultcache: some-id (10)
datastores: (11)
- ...
tls: (12)
- ...
analytics: ... (13)
ratelimit: ... (14)
defaultratelimit: some-id (15)
layers: (16)
- ...| 1 | Server: how the HTTP server operates |
| 2 | Health: health check endpoints served on a separate port |
| 3 | Client: how requests to upstream HTTP servers are made |
| 4 | Log: application, access, and audit logs |
| 5 | Telemetry: OpenTelemetry metrics, logs, and traces |
| 6 | Error: how errors are returned to users |
| 7 | Secret: an external store for sensitive values |
| 8 | Authentication: how incoming requests are authenticated |
| 9 | Cache: where tiles are stored, either a single cache or a list of them |
| 10 | Default cache: the ID of the cache layers use unless they specify another |
| 11 | Datastores: shared connections used by caches, providers, authentication, analytics, and rate limiting |
| 12 | TLS: certificates, keys, and trusted CAs used by the client and server |
| 13 | Analytics: where usage events are recorded |
| 14 | Rate Limit: how many tiles can be requested in a period |
| 15 | Default rate limit: the ID of the policy layers use unless they specify another |
| 16 | Layers: the layers to serve |