Upstream/mc-router
1
0
Fork 0
mirror of https://github.com/itzg/mc-router.git synced 2024-11-14 10:15:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for routes config file (#194)

Browse Source
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
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
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
```
# 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
## Using Kubernetes Service auto-discovery