Ginger
======

Ginger is an open source host management plugin to Wok, Web Server Originated
from Kimchi, that provides an intuitive web panel with common tools for
configuring and operating Linux systems.

The current features include:
 + retrieve system health (sensors) stats
 + user login account management,
 + network interface configuration,
 + configuration backup,
 + Power (ppc) firmware update,
 + Power policy management.


*** Dependencies for Ubuntu/Debian ***

To run the source code in Ubuntu/Debian an extra package is required:

$ sudo apt-get install python-libuser

This step is not required for installation using the .deb package.


*** Dependencies for the unit tests ***

To run the unit tests from the source code the python mock package
is required:

$ sudo pip install mock


*** Notes on Power policy management feature ***

The power policy management feature uses the 'tuned' service to control the
power policies of the host. Problems have been reported with this package,
depending on the host configuration, such as SELinux denials and trouble
to communicate using DBUS with the 'tuned' service started from systemd.

If you find any problems with the power policy management feature, we
recommend following these steps (all steps requires 'sudo' privileges):

- put SELinux in permissive mode for 'tuned' (required if the version of the
package 'selinux-policy' is < 3.11):

$ semanage permissive -a tuned_t

- disable the 'tuned' service from systemd and restart it by hand:

$ systemctl stop tuned.service
$ tuned -l -P -d

Remember to restart wokd service after these changes:

$ systemctl restart wokd.service

If these steps do not solve the problem, try to update all 'tuned' related
packages and the packages'selinux-policy' and 'selinux-policy-targeted'.


*** Copyright notice ***

All the .gif and .png files in 'ui/css/base/images/' directory are licensed
as follows:

----------------------------
Copyright IBM Corp, 2015

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA