X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/3e4a52ed34b130743164d6d77f31a1fc67f161c8..d34160c512a52cf1f5caf59fa00372d3a627e24c:/README.md?ds=inline diff --git a/README.md b/README.md index 7e6b111..c76ad4f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ --> +# Mobius (Friendship Quest Remix) + +A fork of [mobius](https://github.com/jhalter/mobius) with some extra features: + +1. If you have upload permission, you get your own `~` folder. + # Mobius Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server implemented in Golang. @@ -174,9 +180,9 @@ To run as a systemd service, refer to this sample unit file: [mobius-hotline-ser The Mobius server includes an optional HTTP API to perform out-of-band administrative functions. -To enable it, include the `--api-port` flag with a string defining the IP and port to listen on in the form of `:`. +To enable it, include the `--api-addr` flag with a string defining the IP and port to listen on in the form of `:`. -Example: `--api-port=127.0.0.1:5503` +Example: `--api-addr=127.0.0.1:5503` ⚠️ The API has no authentication, so binding it to localhost is a good idea! @@ -185,7 +191,7 @@ Example: `--api-port=127.0.0.1:5503` The stats endpoint returns server runtime statistics and counters. ``` -❯ curl -s localhost:5603/api/v1/stats | jq . +❯ curl -s localhost:5503/api/v1/stats | jq . { "ConnectionCounter": 0, "ConnectionPeak": 0, @@ -212,7 +218,7 @@ The reload endpoint reloads the following configuration files from disk: Example: ``` -❯ curl -s localhost:5603/api/v1/reload | jq . +❯ curl -s localhost:5503/api/v1/reload | jq . { "msg": "config reloaded" } @@ -225,7 +231,7 @@ The shutdown endpoint accepts a shutdown message from POST payload, sends it to Example: ``` -❯ curl -d 'Server rebooting' localhost:5603/api/v1/shutdown +❯ curl -d 'Server rebooting' localhost:5503/api/v1/shutdown { "msg": "server shutting down" } ```