diff --git a/README.md b/README.md index 016a3b9..70b7b8c 100644 --- a/README.md +++ b/README.md @@ -75,15 +75,21 @@ npm install npm start ``` -The server starts on port 3020 by default. Open [http://localhost:3020](http://localhost:3020) in -your browser. +The server starts on port 3020, bound to `localhost` only, by default. +Open [http://localhost:3020](http://localhost:3020) in your browser. -To use a different port: +Both can be overridden with environment variables: ```bash -PORT=8080 npm start +PORT=8080 npm start # different port +BIND_ADDRESS=0.0.0.0 npm start # all interfaces (LAN accessible) +BIND_ADDRESS=192.168.1.50 npm start # specific interface +PORT=8080 BIND_ADDRESS=0.0.0.0 npm start # both ``` +> **Note:** The default `localhost` binding means the app is only reachable from the same machine. +> Set `BIND_ADDRESS=0.0.0.0` to expose it on your local network. + ## Data Storage All data is stored locally in a `data/` directory created automatically on first run: