|
1 | 1 | # Network UPS Tools: example nut.conf |
2 | 2 | # |
| 3 | +# This file tries to standardize the various files being found in the field, |
| 4 | +# like /etc/default/nut on Debian based systems, /etc/sysconfig/ups on RedHat |
| 5 | +# based systems, ... Distribution's init script or service unit/method script |
| 6 | +# should source this file to see which component(s) has to be started. |
| 7 | +# Some scripts and units provided by NUT project itself may also look into |
| 8 | +# this file for optional configuration about OS integration. |
| 9 | +# |
| 10 | +# IMPORTANT NOTES: |
| 11 | +# This file is intended to be sourced by standard POSIX shell scripts |
| 12 | +# (so there is no guaranteed `export VAR=VAL` syntax) and additionally |
| 13 | +# by systemd on Linux (no guaranteed expansion of variables). |
| 14 | +# You MUST NOT use spaces around the equal sign! |
| 15 | +# Practical support for this file and its settings currently varies between |
| 16 | +# various OS packages and NUT sample scripts, but should converge over time. |
| 17 | +# |
| 18 | +# See also: `man nut.conf` (usually in Manual pages Section 5, |
| 19 | +# for Configuration files) |
| 20 | +# |
3 | 21 | ############################################################################## |
4 | 22 | # General section |
5 | 23 | ############################################################################## |
6 | 24 | # The MODE determines which part of the NUT is to be started, and which |
7 | 25 | # configuration files must be modified. |
8 | 26 | # |
9 | | -# This file try to standardize the various files being found in the field, like |
10 | | -# /etc/default/nut on Debian based systems, /etc/sysconfig/ups on RedHat based |
11 | | -# systems, ... Distribution's init script should source this file to see which |
12 | | -# component(s) has to be started. |
13 | | -# |
14 | 27 | # The values of MODE can be: |
15 | 28 | # - none: NUT is not configured, or use the Integrated Power Management, or use |
16 | | -# some external system to startup NUT components. So nothing is to be started. |
| 29 | +# some external system to startup NUT components. So nothing is to be started |
| 30 | +# by scripts or services bundled with NUT packages. |
17 | 31 | # - standalone: This mode address a local only configuration, with 1 UPS |
18 | 32 | # protecting the local system. This implies to start the 3 NUT layers (driver, |
19 | 33 | # upsd and upsmon) and the matching configuration files. This mode can also |
|
23 | 37 | # specific LISTEN directive in upsd.conf. |
24 | 38 | # Since this MODE is opened to the network, a special care should be applied |
25 | 39 | # to security concerns. |
26 | | -# - netclient: this mode only requires upsmon. |
27 | | -# |
28 | | -# IMPORTANT NOTE: |
29 | | -# This file is intended to be sourced by standard POSIX shell scripts (so |
30 | | -# there is no guaranteed `export VAR=VAL` syntax) and by systemd on Linux. |
31 | | -# You MUST NOT use spaces around the equal sign! |
| 40 | +# - netclient: this mode only requires upsmon (and tools it may be using, like |
| 41 | +# upssched or custom scripts) to monitor a remote NUT server and possibly |
| 42 | +# shut down this system (part of upsmon must run as root then). |
32 | 43 |
|
33 | 44 | MODE=none |
34 | 45 |
|
35 | | -# Uncomment this to allow starting the service even if ups.conf has no device |
36 | | -# sections at the moment. This environment variable overrides the built-in |
37 | | -# "false" and an optional same-named default flag that can be set in upsd.conf: |
| 46 | +# Uncomment this to allow starting the service even if `ups.conf` has no device |
| 47 | +# sections configured at the moment. This environment variable overrides the |
| 48 | +# built-in "false" flag in `upsd`, and an optional same-named default flag that |
| 49 | +# can be set in `upsd.conf`. If you want a data server always running, even if |
| 50 | +# it initially has nothing to serve (may be live-reloaded later, when devices |
| 51 | +# become configured), this option is for you. |
38 | 52 | #ALLOW_NO_DEVICE=true |
39 | 53 | #export ALLOW_NO_DEVICE |
| 54 | + |
| 55 | +# The optional 'UPSD_OPTIONS' allow to set upsd specific command-line options. |
| 56 | +# It is ignored when 'MODE' above indicates that no upsd should be running. |
| 57 | +# It may be redundant in comparison to options which can be set in `upsd.conf`. |
| 58 | +#UPSD_OPTIONS= |
| 59 | + |
| 60 | +# The optional 'UPSMON_OPTIONS' allow to set upsmon specific command-line options. |
| 61 | +# It is ignored when 'MODE' above indicates that no upsmon should be running. |
| 62 | +# It may be redundant in comparison to options which can be set in `upsmon.conf`. |
| 63 | +#UPSMON_OPTIONS= |
| 64 | + |
| 65 | +# If the optional 'POWEROFF_WAIT' is configured (to a value that can be handled |
| 66 | +# by `/bin/sleep` on the current system - typically an integer with the number |
| 67 | +# of seconds for a delay, but not always limited to that syntax), and the current |
| 68 | +# system which manages one or more UPS devices would not only command it to shut |
| 69 | +# down, but also try to avoid the "Power race". Caveats emptor, see NUT FAQ and |
| 70 | +# other docs for details. |
| 71 | +#POWEROFF_WAIT=3600 |
| 72 | + |
| 73 | +# The optional 'POWEROFF_QUIET' setting controls if the NUT shutdown integration |
| 74 | +# scripts or service units would emit messages about their activity (or lack |
| 75 | +# thereof). By default they may be verbose, to aid post-mortem troubleshooting |
| 76 | +# via logs or console captures. |
| 77 | +# Set to `true` to avoid that trove of information, if you consider it noise. |
| 78 | +#POWEROFF_QUIET=true |
0 commit comments