conf/upsd.conf.sample

   1 # Network UPS Tools: example upsd configuration file
   2 #
   3 # This file contains access control data, you should keep it secure.
   4 #
   5 # It should only be readable by the user that upsd becomes.  See the FAQ.
   6 #
   7 # Each entry below provides usage and default value.
   8
   9 # =======================================================================
  10 # MAXAGE <seconds>
  11 # MAXAGE 15
  12 #
  13 # This defaults to 15 seconds.  After a UPS driver has stopped updating
  14 # the data for this many seconds, upsd marks it stale and stops making
  15 # that information available to clients.  After all, the only thing worse
  16 # than no data is bad data.
  17 #
  18 # You should only use this if your driver has difficulties keeping
  19 # the data fresh within the normal 15 second interval.  Watch the syslog
  20 # for notifications from upsd about staleness.
  21
  22 # =======================================================================
  23 # STATEPATH <path>
  24 # STATEPATH /var/run/nut
  25 #
  26 # Tell upsd to look for the driver state sockets in 'path' rather
  27 # than the default that was compiled into the program.
  28
  29 # =======================================================================
  30 # LISTEN <address> [<port>]
  31 # LISTEN 127.0.0.1 3493
  32 # LISTEN ::1 3493
  33 #
  34 # This defaults to the localhost listening addresses and port 3493.
  35 # In case of IP v4 or v6 disabled kernel, only the available one will be used.
  36 #
  37 # You may specify each interface you want upsd to listen on for connections,
  38 # optionally with a port number.
  39 #
  40 # You may need this if you have multiple interfaces on your machine and
  41 # you don't want upsd to listen to all interfaces (for instance on a
  42 # firewall, you may not want to listen to the external interface).
  43 #
  44 # This will only be read at startup of upsd.  If you make changes here,
  45 # you'll need to restart upsd, reload will have no effect.
  46
  47 # =======================================================================
  48 # MAXCONN <connections>
  49 # MAXCONN 1024
  50 #
  51 # This defaults to maximum number allowed on your system.  Each UPS, each
  52 # LISTEN address and each client count as one connection.  If the server
  53 # runs out of connections, it will no longer accept new incoming client
  54 # connections.  Only set this if you know exactly what you're doing.
  55
  56 # =======================================================================
  57 # CERTFILE <certificate file>
  58 # CERTFILE /usr/local/ups/etc/upsd.pem
  59 #
  60 # When compiled with SSL support with OpenSSL backend,
  61 # you can enter the certificate file here.
  62 # The certificates must be in PEM format and must be sorted starting with
  63 # the subject's certificate (server certificate), followed by intermediate
  64 # CA certificates (if applicable_ and the highest level (root) CA. It should
  65 # end with the server key. See 'docs/security.txt' or the Security chapter of
  66 # NUT user manual for more information on the SSL support in NUT.
  67 #
  68 # See 'docs/security.txt' or the Security chapter of NUT user manual
  69 # for more information on the SSL support in NUT.
  70
  71 # =======================================================================
  72 # CERTPATH <certificate file or directory>
  73 # CERTPATH /usr/local/ups/etc/cert/upsd
  74 #
  75 # When compiled with SSL support with NSS backend,
  76 # you can enter the certificate path here.
  77 # Certificates are stored in a dedicated database (splitted in 3 files).
  78 # Specify the path of the database directory.
  79 #
  80 # See 'docs/security.txt' or the Security chapter of NUT user manual
  81 # for more information on the SSL support in NUT.
  82
  83 # =======================================================================
  84 # CERTIDENT <certificate name> <database password>
  85 # CERTIDENT "my nut server" "MyPasSw0rD"
  86 #
  87 # When compiled with SSL support with NSS backend,
  88 # you can specify the certificate name to retrieve from database to
  89 # authenticate itself and the password
  90 # required to access certificate related private key.
  91 #
  92 # See 'docs/security.txt' or the Security chapter of NUT user manual
  93 # for more information on the SSL support in NUT.
  94
  95 # =======================================================================
  96 # CERTREQUEST <certificate request level>
  97 # CERTREQUEST REQUIRE
  98 #
  99 # When compiled with SSL support with NSS backend and client certificate
 100 # validation (disabled by default, see 'docs/security.txt'),
 101 # you can specify if upsd requests or requires client's' certificates.
 102 # Possible values are :
 103 #  - 0 to not request to clients to provide any certificate
 104 #  - 1 to require to all clients a certificate
 105 #  - 2 to require to all clients a valid certificate
 106 #
 107 # See 'docs/security.txt' or the Security chapter of NUT user manual
 108 # for more information on the SSL support in NUT.
 109