diff --git a/.gitignore b/.gitignore index 8c723dbc300851c01c11c71711b051f8a0830ec1..1cb6d806ea86b5721390e04908cde3c30bf02410 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .idea *.iml config/*.conf +config/*.html config/*.users diff --git a/README.md b/README.md index 8aced80e9ad99fa51c445cdf7d4830216b37751c..1f4b63669ad1980b326f8a062ca86b0a671ab875 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,20 @@ provide all `nut` options without making too many compromises. ## Usage -1. Copy any of the `./config/*.conf.sample` files to `./config/[FILENAME].conf` -and modify as needed. +1. Create necessary configurations in `./config`; both `.conf` and `.html` files +are supported. **`./config` includes sample configurations.** 1. `docker-compose up -d` -1. `nut` will be available on the container's port `3493`. +1. If `MODE` is set to `netserver`, `nut` will be available on the container's +port `3493`. + * Confirm using `telnet`: + ```bash + $ telnet [CONTAINER IP] 3493 + Trying [CONTAINER IP]... + Connected to [CONTAINER IP]. + Escape character is '^]'. + + $ LIST UPS + BEGIN LIST UPS + UPS test "Back-UPS XS 1500 Test" + END LIST UPS + ```