diff --git a/doc/adminguide.html b/doc/adminguide.html index 6e9431b2..94497667 100755 --- a/doc/adminguide.html +++ b/doc/adminguide.html @@ -1,7 +1,7 @@
@@ -46,14 +46,14 @@ workstations. It should also compile and run on other UNIX flavours.
Since version 2.0, ELOG contains a RPM file which eases the installation. Get the
-file elog-x.x.x-x.i386.rpm from the download
+file elog-x.x.x-x.i386.rpm from the download
section and execute as root "rpm -i elog-x.x.x-x.i386.rpm". This will
-install the elogd daemon in /usr/local/sbin
-and the elog and elconv programs in
-/usr/local/bin. The sample configuration file elogd.cfg
-together with the sample logbook will be installed under /usr/local/elog
-and the documentation goes to /usr/share/doc. The elogd startup script
-will be installed at /etc/rc.d/init.d/elogd. To start the daemon, enter
+install the elogd daemon in /usr/local/sbin
+and the elog and elconv programs in
+/usr/local/bin. The sample configuration file elogd.cfg
+together with the sample logbook will be installed under /usr/local/elog
+and the documentation goes to /usr/share/doc. The elogd startup script
+will be installed at /etc/rc.d/init.d/elogd. To start the daemon, enter
/etc/rc.d/init.d/elogd start
-Download the latest elog-x.x.x.tar.gz package.
+Download the latest elog-x.x.x.tar.gz package.
-Expand the compressed TAR file with tar -xzvf elog-x.x.x.tar.gz.
+Expand the compressed TAR file with tar -xzvf elog-x.x.x.tar.gz.
This creates a subdirectory elog-x.x.x where x.x.x is the
version number. In that directory execute make, which
creates the executables elogd, elog and
@@ -105,7 +105,7 @@ and tries to fall-back to a non-root account. This is necessary to avoid securit
It looks in the configuration file for the statements Usr and
Grp.. If found, elogd uses that user and goupe
name to run under. The names must of course be present on the system (usually
-/etc/passwd and /etc/group). If the statements
+/etc/passwd and /etc/group). If the statements
Usr and Grp. are not present, elogd
tries user and group elog, then the default user and group (normally
nogroup and nobody). Care has to be taken
@@ -162,10 +162,10 @@ Redirect permanent /elog http://your.host.domain/elog/
ProxyPass /elog/ http://your.host.domain:8080/
-Make sure that the Apache modules mod_proxy.c and mod_alias.c are activated. Justin Dieters <enderak@yahoo.com>
+Make sure that the Apache modules mod_proxy.c and mod_alias.c are activated. Justin Dieters <enderak@yahoo.com>
reports that mod_proxy_http.c is also required. The Redirect
statement is necessary to automatically append a "/" to a request like
-http://your.host.domain/elog. Apache then works as a proxy and forwards all requests
+http://your.host.domain/elog. Apache then works as a proxy and forwards all requests
staring with /elog to the elogd daemon.
Note: Do not put "ProxyRequests On" into your configuration file. This option is not necessary
@@ -188,7 +188,7 @@ the proxy host (anybody knows how to fix that???).
Martin Huber reports that +
Martin Huber reports that under Solaris 7 the following command line is needed to compile elog:
gcc -L/usr/lib/ -ldl -lresolv -lm -ldl -lnsl -lsocket elogd.c -o elogdelogd command line to turn keep-
Sridhar Anandakrishnan and -Recai Oktas report that under Mac OS X there is a problem with +
Sridhar Anandakrishnan and +Recai Oktas report that under Mac OS X there is a problem with the default stack size. The command limit stacksize unlimited (for tcsh) or ulimit -s unlimited (for bash) increases the stacksize and fixes this problem. Read the according thread in the forum. @@ -226,37 +226,42 @@ are still possible, they are not recommended any more.
Under Windows, the ports below 1024 can be used
without restriction. So if no web server is running on the same PC the ELOG daemon can
be started under the standard Web port 80. This is achieved by changing the port=8080
-option in elogd.cfg to port=80 and restarting elogd.
+option in elogd.cfg to port=80 and restarting elogd.
The ELOG daemon with :
It may also be used to generate passwords :
- with :
The appearance, functionality and behaviour of the various logbooks on an ELOG server are
@@ -269,15 +274,15 @@ having to restart the server. Instead of restarting the server, under Unix one c
like
The many options of this unique but very important file are documented on the separate elogd.cfg syntax page.
+"config.html" config.html??>elogd.cfg syntax pageelogd can be executed with the following options :
-
+elogd [-p port] [-h hostname/IP] [-D] [-c file] [-v] [-k]
elogd [-p port] [-h hostname/IP] [-C] [-m] [-M] [-D] [-c file] [-s dir] [-d dir] [-v] [-k] [-f file] [-x]
-
-p <port> : TCP port number to use for the http server (if other than 80)
--h <hostname or IP address> : in the case of a "multihomed" server, host name or IP address of the interface ELOG should run on
--D : become a daemon (Unix only)
--c <file> : specify the configuration file (full path mandatory if -D is used)
+-p <port> TCP port number to use for the http server (if other than 80)
+-h <hostname or IP address> in the case of a "multihomed" server, host name or IP
+ address of the interface ELOG should run on
+-C <url> clone remote elogd configuration
+-m synchronize logbook(s) with remote server
+-M synchronize with removing deleted entries
+-l <logbook> optionally specify logbook for -m and -M commands-D become a daemon (Unix only)
+-c <file> specify the configuration file (full path mandatory if -D is used)
-s <dir> specify resource directory (themes, icons, ...)
-d <dir> specify logbook root directory
--v : verbose output for debugging
--k : do not use TCP keep-alive
--f <file> : specify PID file where elogd process ID is written when server is started
--x : enables execution of shell commands
+-v verbose output for debugging
+-k do not use TCP keep-alive
+-f <file> specify PID file where elogd process ID is written when server is started
+-x enables execution of shell commands
+elogd [-r pwd] [-w pwd] [-a pwd] [-l logbook]
elogd [-r pwd] [-w pwd] [-a pwd] [-l logbook]
-
-r <pwd> : create/overwrite read password in config file
--w <pwd> : create/overwrite write password in config file
--a <pwd> : create/overwrite administrative password in config file
--l <logbook> : specify logbook for -r and -w commands
+-r <pwd> create/overwrite read password in config file
+-w <pwd> create/overwrite write password in config file
+-a <pwd> create/overwrite administrative password in config file
+-l <logbook> specify logbook for -r and -w commands"killall -HUP elogd" to tell the server to re-read its configuration.
To better control appearance and layout of the logbooks, elogd.cfg may
optionally specify the use of additional files containing HTML code, and/or custom "themes"
configurations. These need to be edited directly from the file system right now.
-The meaning of the directory flags -s and -d is explained
-in the section covering the configuration options Resource dir and
-Logbook dir in the elogd.cfg description.
+The meaning of the directory flags -s and -d is explained
+in the section covering the configuration options Resource dir and
+Logbook dir in the elogd.cfg description.
elogd togethwer with
elogd. If another Web server is running
on port 80, use a different port.
-+
+
stunnel program if not already done
and start it with:
@@ -306,14 +311,14 @@ details.
Substitute the port 80 if you started elogd on another port. This
causes stunnel to receive requests on the https port 443 and
forward them to the elogd port.
-
+
elogd runs into elogd.cfg:
URL = https://your.host.name/Note the
https at the beginning of the URL, which is
mandatory. Once you use the https URL, elog won't work correctly when
accessed not through stunnel via http://.., since any
- redirection would always bring you back to https://...).+ redirection would always bring you back to https://...).
@@ -322,7 +327,7 @@ details.
stunnel -f -d 443 -r your.host.name:80-This reveals any potential error.
+This reveals any potential error.
@@ -363,7 +368,7 @@ reads logbook entries from its database and formats them into HTML. Since only forms and tables are used, no Java or Javascript is necessary, which makes the logbook display very fast. The system does not use any images on purpose to reduce the amount of data to be transferred. Since the ELOG daemon contains its own http server, no additional server like Apache is required.
The "database" in which ELOG saves its entries is in plain ASCII format.
-One file is created for each day in the form YYMMDDa.log
+One file is created for each day in the form YYMMDDa.log
(where YY is the year, MM the month and DD the day). For ELOG versions 1.x.x,
the format was YYMMDD.log. Messages are separated internally
by the string $@MID@$. If this string is entered in a message
@@ -381,10 +386,10 @@ files from March 2001, just select them with 0103??a.log
-
-
+
+