ELOG for Debian
---------------

If you have logbooks generated with the old versions of ELOG (prior to 
version 2.0.0), you must first convert them to the new format by running
'elconv' in each logbook directory.

Starting from version 2.3.2, ELOG always runs under a separate user and 
group which is 'elog' by default.  You might change it via Usr/Grp
options in configuration file '/etc/elog.conf'.
Do not forget to adjust the permissions of logbooks appropriately.

The init script ('/etc/init.d/elog') honors the following variables
defined in '/etc/default/elog' (listed with the compiled-in defaults):

  # Logbook root directory.
  LOGBOOKDIR=/var/lib/elog
  # Resource directory (i.e. themes, icons).
  RESOURCEDIR=/usr/share/elog
  # Configuration file.
  CONFFILE=/etc/elog.conf
  # PID file for the daemon.
  PIDFILE=/var/run/elogd.pid
  # Port where elogd will run.
  PORT=8080
  # Host where elogd will run.
  HOST=localhost
  # Be verbose.
  VERBOSE=dummy

Since command line options always supersede the corresponding options in 
config file, an administrator might restrict some user configurable options 
via these variables.  For example, defining the following line would 
result an ignored 'port' statement in config file and ensures that ELOG 
always listens port '8080' (note that the compiled-in default port is 
'80', but the default port defined in the configuration file is '8080'):

  PORT=8080

You can also change the logbook repository location by using the same 
mechanism, e.g. to set the data directory as '/srv/elog' (as suggested 
in FHS v2.3) include the following line in '/etc/default/elog':

  LOGBOOKDIR=/srv/elog

User authentication for the logbooks
------------------------------------
Variant: Password file
Debian elog package uses /usr/share/elog as the elog "resources" directory.  So
if you define a password file as follows, it won't work:

  [global]
  ...
  Password file = global.pwd
  Self register = 1
  ...

This is because elogd looks for 'global.pwd' under /usr/share/elog, but it
doesn't have write permissions to create it (creating a non-static file in
/usr/share is not a good idea anyway).  So, you should supply a password file
for which elogd has write permissions.  For example:
  
  Password file = /var/lib/elog/global.pwd

  or

  touch /any/directory/which/elog/can/write/global.pwd
  chown elog:elog /any/directory/which/elog/can/write/global.pwd

  [/etc/elog.conf]
  Password file = /any/directory/which/elog/can/write/global.pwd

Variant: Kerberos
Starting with elog 2.9.2 in Debian Kerberos authentication is compiled
into the Debian binaries. Easily enable it via the configuration file
located in /etc/elog.conf.


Apart from its main function i.e. logbooking, ELOG can be used in 
various ways.  See the examples directory for a few ideas.  By far the 
most interesting application is that, it can be used as a scratch pad to 
take notes while surfing the net.  See the 'examples/elog-webnotes.conf' 
and 'contrib/elogsubmit.txt' for details.  You'll need the Java support 
in your browser for this application.

  -- Recai Oktaş <roktas@debian.org>
  -- Roger Kalt <roger.kalt@gmail.com>  Fri, 25 Apr 2014


