Add documentation for routes config file (#194)

This commit is contained in:
Lilly Tempest 2023-05-24 15:24:39 +02:00 committed by GitHub
parent 087a325720
commit de655ee432
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -109,6 +109,22 @@ To test out this example, I added these two entries to my "hosts" file:
127.0.0.1 forge.example.com 127.0.0.1 forge.example.com
``` ```
# Routing Configuration
The routing configuration allows routing via a config file rather than a command.
You need to set `-routes-config` or `ROUTES_CONFIG` env variable.
The following shows a JSON file for routes config, where `default-server` can also be `null` or omitted:
```json
{
"default-server": "vanilla:25565",
"mappings": {
"vanilla.example.com": "vanilla:25565",
"forge.example.com": "forge:25565"
}
}
```
# Kubernetes Usage # Kubernetes Usage
## Using Kubernetes Service auto-discovery ## Using Kubernetes Service auto-discovery