diff --git a/doc/adminguide.html b/doc/adminguide.html index 2ff6e75f..7cfce440 100755 --- a/doc/adminguide.html +++ b/doc/adminguide.html @@ -230,7 +230,10 @@ and keep the other options as they are. After pressing "OK" the daemon should be
  • -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) +
  • -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 @@ -244,15 +247,25 @@ It may also be used to generate passwords :
  • -a <pwd> : create/overwrite administrative password in config file
  • -l <logbook> : specify logbook for -r and -w commands + +

    The appearance, functionality and behaviour of the various logbooks on an ELOG server are +determined by the single elogd.cfg file in the ELOG installation directory.

    -The appearance, functionality and behaviour of the various logbooks on an ELOG server are determined by the single elogd.cfg file in the ELOG installation directory. -

    -This file may be edited directly from the file system, or from a form in the ELOG Web interface (when the Config menu item is available). In this case, changes are applied dynamically without having to restart the server. -

    -The many options of this unique but very important file are documented on the separate elogd.cfg syntax page. -

    -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. -

    + +This file may be edited directly from the file system, or from a form in the ELOG Web interface +(when the Config menu item is available). In this case, changes are applied dynamically without +having to restart the server.

    + +The many options of this unique but very important file are documented on the separate elogd.cfg syntax page.

    + +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.

      Secure Connections HOWTO  
    diff --git a/doc/config.html b/doc/config.html index 00f704d6..894eff3f 100755 --- a/doc/config.html +++ b/doc/config.html @@ -51,7 +51,6 @@ SMTP host = mailsend.your.domain [Linux] Theme = default Comment = General linux tips and tricks -Data dir = /usr/local/elog/linux Attributes = Author, Type, Category, Subject Options Type = Routine, Software Installation, Problem Fixed, Configuration, Other Options Category = General, Hardware, Software, Network, Account, Other @@ -60,7 +59,6 @@ Required Attributes = Author [PC] Comment = Database PC installations -Data dir = /usr/local/elog/pc Attributes = Location, OS, Owner Options Location = Building1, Building2 Options OS = Linux, Windows ME, Windows 2000 @@ -91,6 +89,20 @@ Specifies the TCP port under which the server is listening. Default is 80. Can b via the '-p' command line flag.

    +

  • Resource dir = <directory> +
    +Specifies the root directory for ELOG resources like help files, themes, icons and user HTML +files. Can be overwritten with the -s flag when starting elogd. If not +specified, use the directory where the configuration file elogd.cfg resides. +

    + +

  • Logbook dir = <directory> +
    +Specifies the root directory for logbooks. Can be overwritten with the -d flag when +starting elogd. If not specified, use the directory where the configuration file elogd.cfg + resides. Each logbook data is stored in a separate directory under this root directory +specified by the Subdir option.

    +

  • Language = <name>
    @@ -134,7 +146,7 @@ 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. +These images must be stored in the resource directory. Alternatively, an absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows).

    @@ -155,8 +167,8 @@ used by most browsers for bookmark names.
  • Selection page = <file>
    When this option is present, a user defined file is displayed instead of the logbook -selection page. This file must be in the same directory as the elogd.cfg -file. Alternatively, an absolute path can be used if the file name starts with a +selection page. This file must be stored in the resource directory. Alternatively, an +absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows).

    @@ -245,9 +257,19 @@ Here are the available options, by broad categories:

  • Data dir = <directory>
    +This option is obsolete from version 2.2.5 on and should not be used. Use Subdir = ... +instead.

    + +

  • Subdir = <directory> +
    Each logbook has a separate directory where the logbook entries are stored, which is controlled by this statement. If the directory does not exist, it is created -autmatically by the elogd program. +autmatically by the elogd program. The subdirectory is relative +to the logbook root directory specified with the Logbook dir = ... +option. So if Logbook dir = /usr/local/elog/logbooks and +Subdir = Demo then the logbook data is stored in +/user/local/elog/logbooks/Demo. If the subdirectory starts with a "/" +("\" under Windows), then it is used as an absolute path independent of the logbook dir.

  • Number Attachments = <number> @@ -268,9 +290,9 @@ explicitly specified in the URL.
    A theme determines which layout and colors are used for a logbook, similar to skins in other programs. The theme option points to a subdirectory -under the directory of the configuration file, which contains all files for -that theme. The format of these files is described under the Themes -section. +under the "themes" directory which resides in the resource directory. +It contains all files for that theme. The format of these files is described under +the Themes section.

  • Date format = <string> @@ -297,7 +319,7 @@ messages of for logbook queries. Here is a simple example of such a file: </ul> -The file must be present in the same directory as the elogd file. +The file must be present in the resource directory. Alternatively, an absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows). @@ -328,7 +350,7 @@ Here is an example: <a href="?cmd=New">Enter</a> another message -The file must be present in the same directory as the elogd file. +The file must be present in the resource directory. Alternatively, an absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows). @@ -451,20 +473,22 @@ example a link back to the main logbook selection page like: <center><a href="/">Main page</a></center> -Or it can contain other useful links. The file must be present in the same directory as the -elogd.cfg file. Alternatively, an absolute path can be used if the file +Or it can contain other useful links. The file must be present in the resource directory. +Alternatively, an absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows).

  • Help URL = <URL> +
    -This URL is used for the Help button. By default, the file eloghelp_xx.html is -returned with the contents of the help page. Edit this file directly to add site-specific help for all logbooks. Alternatively, use the Help URL option to specify different help pages for different logbooks. -It can point to a site-specific help page via http://... or to a local file like -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. -

    +This URL is used for the Help button. By default, the file eloghelp_xx.html is returned with +the contents of the help page. Edit this file directly to add site-specific help for all logbooks. +Alternatively, use the Help URL option to specify different help pages for different +logbooks. It can point to a site-specific help page via http://... or to a local +file like file://c:/tmp/config.html, or to the name of an HTML file which must be +present in the resource directory.

  • Message Width = <number>
    @@ -573,7 +597,7 @@ down box by default.
  • Preset text = <string> or <file>
    This preset value is used for the main body text. It can be a string or a file, -which must be present in the same directory as the elogd.cfg file. +which must be present in the resource directory. Alternatively, an absolute path can be used if the file name starts with a "/" (Unix) or "\" or "x:" (Windows).