X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/b6e3be945680d017874967ae72ef86ee4235dcc2..HEAD:/README.md?ds=inline diff --git a/README.md b/README.md index a5df525..c76ad4f 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,17 @@ --> +# 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) client and server implemented in Golang. +Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server implemented in Golang. -- **Server Goal:** Make it simple to run a Hotline server on macOS, Linux, and Windows, with full compatibility for all popular Hotline clients. -- **Client Goal:** Make it fun and easy to connect to multiple Hotline servers through a [terminal UI](https://github.com/jhalter/mobius/wiki/Mobius-Client-Screenshot-Gallery). +- **Project Goal:** Make it simple to run a Hotline server on macOS, Linux, and Windows, with full compatibility for all popular Hotline clients. ## Installation @@ -53,7 +58,7 @@ sudo docker run \ -p 5500:5500 \ -p 5501:5501 \ -v $HLFILES:/usr/local/var/mobius/config \ - ghcr.io/jhalter/mobius:latest \ + ghcr.io/jhalter/mobius-hotline-server:latest \ -init ``` @@ -175,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! @@ -186,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, @@ -213,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" } @@ -226,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" } -``` \ No newline at end of file +```