aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Halter <868228+jhalter@users.noreply.github.com>2024-08-07 15:39:19 -0700
committerGitHub <noreply@github.com>2024-08-07 15:39:19 -0700
commitf428cd7b08e68d650d4bf669cfc618f5fab998b4 (patch)
tree1841a512b086612e9cf89bc66ec845787a4e3cf0
parent95f835dc335c42fb5e40bfa9b3c990cecff4a7b3 (diff)
Update README.md
Fix documentation of --api-addr flag
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7e6b111..97e2575 100644
--- a/README.md
+++ b/README.md
@@ -174,9 +174,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 `<ip>:<port>`.
+To enable it, include the `--api-addr` flag with a string defining the IP and port to listen on in the form of `<ip>:<port>`.
-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!