diff --git a/doc/adminguide.html b/doc/adminguide.html index 4bf7e343..64c67384 100755 --- a/doc/adminguide.html +++ b/doc/adminguide.html @@ -18,7 +18,7 @@  [User's Guide]   [Administrator's Guide]   [FAQ]  - [DEMO]  + [DEMO]   [Download] 

@@ -46,7 +46,9 @@ 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 and elog . These executables can then be copied to a convenient place like -/usr/local/bin or ~/bin. +/usr/local/bin or ~/bin. Alternatively, +a make install will copy these files to DESTDIR +which is defined in the Makefile. The elogd executable can be started manually for testing with :

@@ -96,10 +98,28 @@ described below. To start the daemon automatically, it can be run from the /etc/rc.d/init.d system. Please consult your distribution to find out how to do that.
-Under RedHat 6.x. I use a script which I put under /etc/rc.d/init.d. Then I call : +Under RedHat 6.x. I use a script which I put under /etc/rc.d/init.d. Then I call :

+

  Running elogd under Apache  
+

+For cases where elogd should run under port 80 in parallel to an Apache server, +Apache can be configured to run Elog in a subdirectory of Apache. Start elogd normally +under port 8080 (or similarly) as noted above and make sure it's working there. Then put following redirection +into the Apache configuration file: + +

+

+Make sure that the Apache modules mod_proxy.c and mod_alias.c are activated. 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 +starint with /elog to the elogd daemon.

+

Notes for the Solaris platform:

Martin Huber reports that diff --git a/doc/config.html b/doc/config.html index 64d3bb4c..c05b0ff2 100755 --- a/doc/config.html +++ b/doc/config.html @@ -66,7 +66,7 @@ Options Location = Building1, Building2 Options OS = Linux, Windows ME, Windows 2000 Required Attributes = Location, Owner Email All = name@address, othername@otheraddress -Mail Subject = Location +Use Mail Subject = Location

@@ -115,10 +115,10 @@ contents of the tab. This optional HTML code gets displayed in the title of the logbook selection page. It can contain images via <img src="welcome.gif">. These images must be in the same directory as the elodg.cfg file. -The following line is an example Welcome Title: -

+The following line is an example Welcome Title:
+

Welcome title = <img src="welcome.jpg"><p><font size=5 color=white>Welcome to our Elog</font>
-

+
This displays an image and a text below.

@@ -142,6 +142,27 @@ This defines the SMTP host needed to send automatic email notifications. The hos name you can get from your email program or your local system administrator.

+

  • Logfile +
    +This option specifies a filename which logs all login/logout activities and +successful user connections for logbooks with user level access.

    + +

  • URL +
    +This URL is used in automatic email notifications to point back to the new message. +Usually, the elog daemon tries to obtain the URL from the "Referer" statement in the +HTTP header. If this is not correct (like if the domain name is missing), the URL used +to point back to the logbook can be overwritten by this statement. The URL has to +contain the port number if not the standard port 80 is used like
    +
    +URL = http://host.domain:8080/ +

    + +

  • User +
  • Group +
    +The user and group to run the elogd daemon under when started by root.

    +

    @@ -218,6 +239,16 @@ messages of for logbook queries. Here is a simple example of such a file: The file must be present in the same directory as the elogd file.

    +

  • Start page = <command> +
    +This option can be used to display a different start page. command +can be either "last10" for the last ten messages, or an ELog menu command in the +form ?cmd=xxx. To start with the search page, one uses

    + +

    +Start page = ?cmd=Find
+
    +
  • Submit Page = <file>
    This optional page can be displayed when a new message was submitted in a logbook. @@ -271,10 +302,12 @@ If this option is not present, following default is used:
    This option specifies the menu commands displayed on top of the listing page resulting from a "find" command. Although all commands from a above are possible, -only the commands New, Find, Back, Last, Last day, Last 10, config, Change +only the commands New, Find, Back, Last day, Last 10, Last x, Config, Change password, Logout and Help make sense. There is one special command in addition to the above commands: The command Last x - gets expanded to "Last 2 days", "Last 4 days" or "Last 20 entries", "Last 40 entries" and so on, similar to the standard behaviour without the "Find Menu commands" option. + gets expanded to "Last 2 days", "Last 4 days" or +"Last 20 entries", "Last 40 entries" and so on, similar to the standard +behaviour without the "Find Menu commands" option.

  • Bottom text = <file> @@ -299,6 +332,20 @@ It can point to a site-specific help page via http://... or file://c:/tmp/config.html, or to the name of an HTML file which must be present in the same directory as the elogd file.

    +

  • Message Width +
    +This value sets the number of characters per line of the main message entry field. +The default value is 76 (78 for replies), and can be increased for installations +which need a larger window size (like pasting log files etc.). +

    + +

  • Display mode +
    +Default mode for search display can be "full", "summary" +and "threaded". On the find entry form, the checkboxes +are set accordingly. The "Last xxx" page used this setting directly. +

    +

    @@ -313,7 +360,7 @@ defined. Typical values are "Author", "Subject" or "Type".
  • Options <attribute> = <list>
    -Usually, a text field is used for an attribute, where the user can fill in +Usually, an text field is used for an attribute, where the user can fill in text of up to 100 characters. If instead a drop-down box with preset items is better for a given attribute, these items can be defined with this statement. Up to 100 items can be defined, separated by commas. @@ -333,21 +380,6 @@ In the "find" page only one of these values can be specified, which is th treated as a substring in the search filter.

    -

  • IOptions <attribute> = <list> -
    -As an alternative, icons can be used as values of attributes. The name of the icon -image files (ususlly GIF files) are specified with this option. The icons have to -be present in the icons subdirectory of the themes directory. -A configuration line like

    -

    -IOptions Type = icon1.gif, icon2.gif, icon3.gif, icon4.gif
-
    - -results in following browser display:

    - - -

    -

  • Options <attribute> = boolean
    If an attribute is marked "boolean" this way, a checkbox is displayed for @@ -405,9 +437,32 @@ as described unter the "Subst <attribute>" option.
  • Display search = <list>
    -The display of attributes in a search result table can be restricted only to -certain attributes listed here. This can be helpful is many attributes are defined -in a logbook, which usually makes the table too big to fit in the browser. +Specified the display and order of items in a search result page. In addition +to all attributes, one can specify here "#" for the message ID, "Logbook" +and "Date". The restriction to certain attributes can be helpful if many +attributes are defined in a logbook, which usually makes the table too big to +fit in the browser. The default +is
    +
    +Display search = #, Date, <all attributs>
+
    +Which displays the message number, date, and all attributes. The display of the +message body is controlled by the Display mode and +Summary lines options. +

    + +

  • Thread display = <string> +
    +Optional way to specify the line contents in the threaded search result. All +standard substitutions like as described in the Subst command can be +used here, like
    +
    Thread display = $author, $subject
    +

    + +

  • Thread icon = <attribute> +
    +If a logbook uses some icons for an attribute, these icons can be displayed +in the search result page instead of the default icons defined in the themes.cfg file.

  • Subst <attribute> = <string> @@ -424,10 +479,10 @@ text. This text can contain arbitrary fixed text and following values:
  • $logbook: The name of the current logbook
  • $date: The current date, formatted via "Date format" -

    +
    Following example use this feature to add the remote host name to the author: -

    -Subst Author = $author from $remote_host +
    +

    Subst Author = $author from $remote_host

  • Remove on reply = <list> @@ -457,24 +512,23 @@ on in your browser. Please consult your browser documentation about how to d

    These optional password statements define passwords for reading and writing to the -logbook, to delete entries in the logbook and to configure a logbook via the Config -menu. The passwords are stored in an encoded form. To change them, use elogd -directly with the -r , -w and -a - flags. To set the write password of logbook "linux" to "test", enter: -

    +logbook, to delete entries in the logbook and to configure a logbook via the Config menu. The passwords are stored in an encoded form. To change them, use elogd + directly with the -r , -w and +-a flags. To set the write password of logbook "linux" to " +test", enter:

    -The read password is queried by the browser with a pop-up window and usually stays -active for the entire browser session. The write and admin passwords are stored in -cookies on the browser side and have an expiration time of 24h. After that time, the -passwords have to be re-submitted. This time can be changed with the statement -Write Password Expiration = x or Admin Password Expiration -= x, where x is the expiration time in hours. It should be noted -that on some systems the daylight savings time is calculated incorrectly, which can -cause time offsets of one hour between a server PC and a client PC. In this case one -hour must be added to the expiration time. If the expiration is set to "0", the -passwords are kept for the current browser session only. When the browser is restarted, -the password must be re-entered. +The read password is queried by the browser with a pop-up window and usually stays active +for the entire browser session. The write and admin passwords are stored in cookies on +the browser side and expire after the browser session. This time can be changed with the +statement Write Password Expiration = x or Admin Password +Expiration = x, where x is the expiration time in hours. It should be +noted that on some systems the daylight savings time is calculated incorrectly, which can +cause time offsets of one hour between a server PC and a client PC. In this case one hour +must be added to the expiration time. If the expiration is set to "0", the passwords are +kept for the current browser session only. When the browser is restarted, the password +must be re-entered.