diff --git a/doc/README.html b/doc/README.html new file mode 100644 --- /dev/null +++ b/doc/README.html @@ -0,0 +1,195 @@ + + + + + + +Wiedenmann Vacation + + + + + +
+

Wiedenmann Vacation

+

Web Front-End to Manage vacation(1) Settings

+ +++ + + + +
Author:Wolfgang Scherer
+ + + + + + + + + + + + + + + + +
+

Inhalt

+ +
+ + +
+

Installation

+
    +
  1. Copy the program anywhere on your harddrive.

    +
  2. +
  3. Change alias /vacation in lib/ws-vacation.conf.in, if desired.

    +
  4. +
  5. Execute the following commands (as user) to create the run-time files:

    +
    +>>> make clean
    +>>> make
    +
    +

    This substitutes the installation directory in the necessary places.

    +
  6. +
  7. Copy lib/ws-vacation.conf to /etc/apache2/conf.d/.

    +
  8. +
  9. Reload the Apache server:

    +
    +>>> rcapache2 reload.
    +
    +
  10. +
  11. The sudo(1) setup allows the apache server to execute vacation(1) +as any user (except root) without a password. This is activated by +copying the file lib/ws-vacation-sudo into the directory +/etc/sudoers.d (ubuntu):

    +
    +>>> cp lib/ws-vacation-sudo /etc/sudoers.d/ws-vacation-sudo
    +>>> chmod 0440 /etc/sudoers.d/ws-vacation-sudo
    +
    +

    or by appending it to the file /etc/sudoers (older SuSE):

    +
    +>>> cat lib/ws-vacation-sudo >>/etc/sudoers
    +
    +
  12. +
+
+
+

User Management

+

The file lib/.htpasswd can be created by the regular means.

+

An automated script is available that creates the password database +from the system shadow(8) database. Just change into directory lib +and execute (as root):

+
+>>> php gen_htpasswd.php
+
+
+

Bemerkung

+

If new users are created in the system, this step must be +repeated to update the .htpasswd file.

+
+

+
+
+

Configuration

+

The file lib/config.php contains the basic configuration data.

+

It is possible to fine-tune the standard user selection with:

+ +

The file lib/language.php contains language specific translation and +also the default vacation(1) message text.

+

The HTML header and footer can be modified in lib/templates.php.

+ + + +

+ + + + + +

Copyright

+

Copyright (C) 2012, Wolfgang Scherer, <sw@wiedenmann-seile.de>. +Sponsored by Wiedenmann-Seile GmbH.

+

See section GNU Free Documentation License for license conditions for the documentation.

+

See section GNU General Public License for license conditions for the program.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +