mirror of
https://github.com/itzg/mc-router.git
synced 2024-11-21 11:25:41 +01:00
docs: included required header for API calls
This commit is contained in:
parent
5fbec98fb6
commit
226f821598
37
README.md
37
README.md
@ -49,24 +49,31 @@ Routes Minecraft client connections to backend servers based upon the requested
|
||||
|
||||
# REST API
|
||||
|
||||
* `GET /routes`
|
||||
* `GET /routes` (with `Accept: application/json`)
|
||||
|
||||
Retrieves the currently configured routes
|
||||
* `POST /routes`
|
||||
Registers a route given a JSON body structured like:
|
||||
```json
|
||||
{
|
||||
"serverAddress": "CLIENT REQUESTED SERVER ADDRESS",
|
||||
"backend": "HOST:PORT"
|
||||
}
|
||||
```
|
||||
* `POST /defaultRoute`
|
||||
|
||||
* `POST /routes` (with `Content-Type: application/json`)
|
||||
|
||||
Registers a route given a JSON body structured like:
|
||||
```json
|
||||
{
|
||||
"serverAddress": "CLIENT REQUESTED SERVER ADDRESS",
|
||||
"backend": "HOST:PORT"
|
||||
}
|
||||
```
|
||||
|
||||
* `POST /defaultRoute` (with `Content-Type: application/json`)
|
||||
|
||||
Registers a default route to the given backend. JSON body is structured as:
|
||||
```json
|
||||
{
|
||||
"backend": "HOST:PORT"
|
||||
}
|
||||
```
|
||||
```json
|
||||
{
|
||||
"backend": "HOST:PORT"
|
||||
}
|
||||
```
|
||||
|
||||
* `DELETE /routes/{serverAddress}`
|
||||
|
||||
Deletes an existing route for the given `serverAddress`
|
||||
|
||||
# Docker Multi-Architecture Image
|
||||
|
@ -11,8 +11,13 @@ services:
|
||||
EULA: "TRUE"
|
||||
TYPE: FORGE
|
||||
router:
|
||||
image: itzg/mc-router
|
||||
image: ${MC_ROUTER_IMAGE:-itzg/mc-router}
|
||||
environment:
|
||||
# enable API
|
||||
API_BINDING: ":25564"
|
||||
ports:
|
||||
- 25565:25565
|
||||
# bind the API port to only loopback to avoid external exposure
|
||||
- 127.0.0.1:25564:25564
|
||||
command: --mapping=vanilla.example.com=vanilla:25565,forge.example.com=forge:25565
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user