https://github.com/clamy54/nutw
Nutw is a NUT client for Windows.
https://github.com/clamy54/nutw
nut ups windows
Last synced: 5 months ago
JSON representation
Nutw is a NUT client for Windows.
- Host: GitHub
- URL: https://github.com/clamy54/nutw
- Owner: clamy54
- License: other
- Created: 2022-12-09T14:24:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T10:55:06.000Z (over 2 years ago)
- Last Synced: 2025-09-12T15:28:00.164Z (10 months ago)
- Topics: nut, ups, windows
- Language: Go
- Homepage:
- Size: 15.7 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Nutw
====
## About
Nutw is a NUT client for Windows.
Nutw is running as a service and probes a NUT server at regular intervals.
If ups supports battery levels probes, then Nutw shutdown the local OS if
current battery level is below low-battery level.
If ups doesn't battery levels probes, then Nutw shutdown the local OS if
ups is going on battery.
## Installation
Just run nutw-install.exe with administrator privileges and configure installation folder.
## Configuration
Open nutw.ini (installed in the same directory as nutw.exe during installation) and configure the
nutd section.
| Keyword: | Description: |
| ---------------------- | -----------------------------------------------------------|
| `server` | `hostname or ip adress of the upsd daemon server` |
| `port` | `tcp port used by the remote upsd daemon` |
| `usetls` | `if set to 1 then initiate tls session` |
| `login` | `login to use for authenticating against upsd daemon` |
| `password` | `password to use for authenticating against upsd daemon` |
| `upsname` | `ups device name served by upsd daemon` |
| `interval` | `amount of time (in seconds) between two probes` |
## Testing the configuration
Open a terminal, change directory to Nutw installation directory and run :
```
nutw --mode=debug
```
Nutw logs can be checked with the help of 'Windows Event Viewer'. Just expand Applications logs and filter by ID 177.
## Setting up the service
Nutw is running as a windows service. After configuration and testings are done, you can setup the service by opening a terminal in Administrator mode,
changing current directory to Nutw installation directory and run :
```
nutw --mode=install
```
Nutw logs can be checked with the help of 'Windows Event Viewer' (see Testing section).
## Nutw parameters
Nutw support the following mode :
| Keyword: | Description: |
| ---------------------- | -----------------------------------------------------------|
| `install` | `install and run the service` |
| `uninstall` | `stop and uninstall the service` |
| `start ` | `start the service (must be installed before)` |
| `stop` | `stop the service` |
| `restart` | `restart the service (must be running)` |
| `debug` | `test Nutw configuration ( No OS shutdown in this mode )` |
Usage :
```
nutw --mode=
```
Some modes requires Administrator privileges.
## Credits
Changelog :
v1.1 - Debug mode is now more verbose on default console
v1.0 - Initial release
## Credits
Nutw use [Kardianos Service module](https://github.com/kardianos/service).