From 069735e6aba8577d93789392410583d191d01a45 Mon Sep 17 00:00:00 2001 From: Erick Hitter <git-contrib@ethitter.com> Date: Sun, 29 Dec 2019 15:17:00 -0800 Subject: [PATCH] README updates --- .gitignore | 1 + README.md | 19 ++++++++++++++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 8c723db..1cb6d80 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 8aced80..1f4b636 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 + ``` -- GitLab