Imported Upstream version 2.7.2
This commit is contained in:
Laurent Bigonville
parent
0121794af9
commit
a356b56d11
263 changed files with 6039 additions and 8151 deletions
319
INSTALL.nut
Normal file
319
INSTALL.nut
Normal file
|
|
@ -0,0 +1,319 @@
|
|||
Installation instructions
|
||||
=========================
|
||||
|
||||
This chapter describe the various methods for installing Network UPS Tools.
|
||||
|
||||
Whenever it is possible, prefer <<Installing_packages, installing from packages>>.
|
||||
Packagers have done an excellent and hard work at improving NUT integration into
|
||||
their system.
|
||||
|
||||
[[Installing_source]]
|
||||
Installing from source
|
||||
----------------------
|
||||
|
||||
These are the essential steps for compiling and installing this software.
|
||||
|
||||
The NUT linkdoc:packager-guide[Packager Guide], which presents the best
|
||||
practices for installing and integrating NUT, is also a good reading.
|
||||
|
||||
[NOTE]
|
||||
.Keep in mind that...
|
||||
================================================================================
|
||||
|
||||
- the paths shown below are the default values you get by just calling
|
||||
configure by itself. If you have used --prefix or similar, things will be
|
||||
different. Also, if you didn't install this program from source yourself, the
|
||||
paths will probably have a number of differences.
|
||||
|
||||
- by default, your system probably won't find the man pages, since they
|
||||
install to /usr/local/ups/man. You can fix this by editing your MANPATH, or
|
||||
just do this:
|
||||
|
||||
man -M /usr/local/ups/man <man page>
|
||||
|
||||
- if your favorite system offers up to date binary packages, you should always
|
||||
prefer these over a source installation. Along with the known advantages of such
|
||||
systems for installation, upgrade and removal, there are many integration issues
|
||||
that have been addressed.
|
||||
|
||||
================================================================================
|
||||
|
||||
|
||||
Prepare your system
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
System User creation
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Create at least one system user and a group for running this software. You
|
||||
might call them "ups" and "nut". The exact names aren't important as
|
||||
long as you are consistent.
|
||||
|
||||
The process for doing this varies from one system to the next, and
|
||||
explaining how to add users is beyond the scope of this document.
|
||||
|
||||
For the purposes of this document, the user name and group name
|
||||
will be 'ups' and 'nut' respectively.
|
||||
|
||||
Be sure the new user is a member of the new group! If you forget to
|
||||
do this, you will have problems later on when you try to start upsd.
|
||||
|
||||
|
||||
Build and install
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
[[Configuration]]
|
||||
Configuration
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Configure the source tree for your system. Add the '--with-user' and
|
||||
'--with-group' switch to set the user name and group that you created
|
||||
above.
|
||||
|
||||
./configure --with-user=ups --with-group=nut
|
||||
|
||||
If you need any other switches for configure, add them here. For example:
|
||||
|
||||
* to build and install USB drivers, add '--with-usb' (note that you
|
||||
need to install libusb development package or files).
|
||||
|
||||
* to build and install SNMP drivers, add '--with-snmp' (note that
|
||||
you need to install libsnmp development package or files).
|
||||
|
||||
* to build and install CGI scripts, add '--with-cgi'.
|
||||
|
||||
See <<Configure_options,Configure options>> from the User Manual,
|
||||
docs/configure.txt or './configure --help' for all the available
|
||||
options.
|
||||
|
||||
If you alter paths with additional switches, be sure to use those
|
||||
new paths while reading the rest of the steps.
|
||||
|
||||
Reference: <<Configure_options,Configure options>> from the
|
||||
User Manual.
|
||||
|
||||
|
||||
Build the programs
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
make
|
||||
|
||||
This will build the NUT client and server programs and the
|
||||
selected drivers. It will also build any other features that were
|
||||
selected during <<Configuration,configuration>> step above.
|
||||
|
||||
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
[NOTE]
|
||||
=====================================================================
|
||||
|
||||
you should now gain privileges for installing software if necessary:
|
||||
|
||||
su
|
||||
|
||||
=====================================================================
|
||||
|
||||
Install the files to a system level directory:
|
||||
|
||||
make install
|
||||
|
||||
This will install the compiled programs and man pages, as well as
|
||||
some data files required by NUT. Any optional features selected
|
||||
during configuration will also be installed.
|
||||
|
||||
This will also install sample versions of the NUT configuration
|
||||
files. Sample files are installed with names like ups.conf.sample
|
||||
so they will not overwrite any existing real config files you may
|
||||
have created.
|
||||
|
||||
If you are packaging this software, then you will probably want to
|
||||
use the DESTDIR variable to redirect the build into another place,
|
||||
i.e.:
|
||||
|
||||
make DESTDIR=/tmp/package install
|
||||
make DESTDIR=/tmp/package install-conf
|
||||
|
||||
[[StatePath]]
|
||||
State path creation
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Create the state path directory for the driver(s) and server to use
|
||||
for storing UPS status data and other auxiliary files, and make it
|
||||
owned by the user you created.
|
||||
|
||||
mkdir -p /var/state/ups
|
||||
chmod 0770 /var/state/ups
|
||||
chown root:nut /var/state/ups
|
||||
|
||||
[[Ownership]]
|
||||
Ownership and permissions
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Set ownership data and permissions on your serial or USB ports
|
||||
that go to your UPS hardware. Be sure to limit access to just
|
||||
the user you created earlier.
|
||||
|
||||
These examples assume the second serial port (ttyS1) on a typical
|
||||
Slackware system. On FreeBSD, that would be cuaa1. Serial ports
|
||||
vary greatly, so yours may be called something else.
|
||||
|
||||
chmod 0660 /dev/ttyS1
|
||||
chown root:nut /dev/ttyS1
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
FIXME: TBR
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
The setup for USB ports is slightly more complicated. Device files
|
||||
for USB devices, such as /proc/bus/usb/002/001, are usually
|
||||
created "on the fly" when a device is plugged in, and disappear
|
||||
when the device is disconnected. Moreover, the names of these
|
||||
device files can change randomly. To set up the correct
|
||||
permissions for the USB device, you may need to set up (operating
|
||||
system dependent) hotplugging scripts. Sample scripts and
|
||||
information are provided in the scripts/hotplug and
|
||||
scripts/udev directories. For most users, the hotplugging scripts
|
||||
will be installed automatically by "make install".
|
||||
|
||||
(If you want to try if a driver works without setting up
|
||||
hotplugging, you can add the "-u root" option to upsd, upsmon, and
|
||||
drivers; this should allow you to follow the below
|
||||
instructions. However, don't forget to set up the correct
|
||||
permissions later!).
|
||||
|
||||
NOTE: if you are using something like devfs or udev, make sure
|
||||
these permissions stay set across a reboot. If they revert to the
|
||||
old values, your drivers may fail to start.
|
||||
|
||||
|
||||
You are now ready to configure NUT, and start testing and using it.
|
||||
|
||||
You can jump directly to the <<Configuration_notes,NUT configuration>>.
|
||||
|
||||
|
||||
[[Installing_packages]]
|
||||
Installing from packages
|
||||
------------------------
|
||||
|
||||
This chapter describes the specific installation steps when using
|
||||
binary packages that exist on various major systems.
|
||||
|
||||
[[Debian]]
|
||||
Debian, Ubuntu and other derivatives
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
NOTE: NUT is packaged and well maintained in these systems.
|
||||
The official Debian packager is part of the NUT Team.
|
||||
|
||||
Using your prefered method (apt-get, aptitude, Synaptic, ...), install
|
||||
the 'nut' package, and optionaly the following:
|
||||
|
||||
- 'nut-cgi', if you need the CGI (HTML) option,
|
||||
- 'nut-snmp', if you need the snmp-ups driver,
|
||||
- 'nut-xml', for the netxml-ups driver,
|
||||
- 'nut-powerman-pdu', to control the PowerMan daemon (PDU management)
|
||||
- 'nut-dev', if you need the development files.
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
- nut-client
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
Configuration files are located in /etc/nut.
|
||||
linkman:nut.conf[5] must be edited to be able to invoke /etc/init.d/nut
|
||||
|
||||
NOTE: Ubuntu users can access the APT URL installation by clicking on link:apt://nut[this link].
|
||||
|
||||
|
||||
[[Mandriva]]
|
||||
Mandriva
|
||||
~~~~~~~~
|
||||
|
||||
NOTE: NUT is packaged and well maintained in these systems.
|
||||
The official Mandriva packager is part of the NUT Team.
|
||||
|
||||
Using your prefered method (urpmi, RPMdrake, ...), install one of the two below
|
||||
packages:
|
||||
|
||||
- 'nut-server' if you have a 'standalone' or 'netserver' installation,
|
||||
- 'nut' if you have a 'netclient' installation.
|
||||
|
||||
Optionaly, you can also install the following:
|
||||
|
||||
- 'nut-cgi', if you need the CGI (HTML) option,
|
||||
- 'nut-devel', if you need the development files.
|
||||
|
||||
|
||||
[[Suse]]
|
||||
Suse / Opensuse
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
NOTE: NUT is packaged and well maintained in these systems.
|
||||
The official Suse packager is part of the NUT Team.
|
||||
|
||||
Install the 'nut-classic' package, and optionaly the following:
|
||||
|
||||
- 'nut-drivers-net', if you need the snmp-ups or the netxml-ups drivers,
|
||||
- 'nut-cgi', if you need the CGI (HTML) option,
|
||||
- 'nut-devel', if you need the development files,
|
||||
|
||||
NOTE: Suse and Opensuse users can use the
|
||||
link:http://software.opensuse.org/search?baseproject=ALL&p=1&q=nut[one-click install method]
|
||||
to install NUT.
|
||||
|
||||
|
||||
[[RedHat]]
|
||||
Red Hat, Fedora and CentOS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
NOTE: NUT is packaged and well maintained in these systems.
|
||||
The official Red Hat packager is part of the NUT Team.
|
||||
|
||||
Using your prefered method (yum, Add/Remove Software, ...), install one of the
|
||||
two below packages:
|
||||
|
||||
- 'nut' if you have a 'standalone' or 'netserver' installation,
|
||||
- 'nut-client' if you have a 'netclient' installation.
|
||||
|
||||
Optionaly, you can also install the following:
|
||||
|
||||
- 'nut-cgi', if you need the CGI (HTML) option,
|
||||
- 'nut-xml', if you need the netxml-ups driver,
|
||||
- 'nut-devel', if you need the development files.
|
||||
|
||||
|
||||
[[FreeBSD]]
|
||||
FreeBSD
|
||||
~~~~~~~
|
||||
|
||||
You can either install NUT as a binary package or as a port.
|
||||
|
||||
Binary package
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
To install the main component, use the following command:
|
||||
|
||||
# pkg_add -r nut
|
||||
|
||||
Port
|
||||
^^^^
|
||||
|
||||
The port is located under /usr/ports/sysutils/nut.
|
||||
To install it, use the following command:
|
||||
|
||||
# cd /usr/ports/sysutils/nut/ && make install clean
|
||||
|
||||
You have to define WITH_NUT_CGI to build the optional CGI scripts.
|
||||
|
||||
Optionaly, you can also install the following ports:
|
||||
|
||||
- sysutils/nut-snmp, for the SNMP driver,
|
||||
- sysutils/nut-usb, for the USB drivers,
|
||||
- sysutils/nut-libupsclient, for the upsclient library.
|
||||
|
||||
|
||||
You are now ready to configure NUT, and start testing and using it.
|
||||
|
||||
You can jump directly to the
|
||||
<<Configuration_notes,NUT configuration>>.
|
||||
Loading…
Add table
Add a link
Reference in a new issue