+The notation of the following options is such that items enclosed by "<" and ">" +should be replaced by a specific string. If a value contains blanks (like a complete sentence), it +should not be enclosed in quotation marks.
+
+If a setting has a number of possible options, they are shown in the form
+option1|option2|..., meaning that one of the options (without any vertical bar)
+should be used.
+
The following options are specific to the [global] section:
Port
+Port = <port>
elogd is contained in the file eloghe
xx are the first two letters of the language (like "en", "ge" and "fr"). For new languages, a new file of that type must be created as well.
-
Logbook Tabs = 0/1
+Logbook Tabs = [0|1]
string is used for t
contents of the tab.
-
Welcome Title
+Welcome Title = <html code>
<img src="welcome.gif">.
@@ -137,18 +145,18 @@ file. It can be completely customized in order to contain logos etc. As a templa
the standard selection page produced by elogd can be used.
-
SMTP host
+SMTP host = <host.domain>
-
Logfile
+Logfile = <file>
-
URL
+URL = <http://host.domain>
URL = http://host.domain:8080/
-
User
-Group
+User = <name>
+Group = <name>
@@ -183,28 +191,28 @@ Here are the available options, by broad categories:
Data dir
+Data dir = <directory>
elogd program.
-
Number Attachments
+Number Attachments = <number>
-
Comment
+Comment = <comment>
-
Theme
+Theme = <theme>
elogd file.
-
Message comment
+Message comment = <comment>
This optional comment is displayed on top of the text entry field when submitting
a new message. It can contain a sentence like "Please enter your message here:".
@@ -325,7 +333,7 @@ Or it can contain other useful links. The file must be present in the same direc
as the elogd file.
-
Help URL
+Help URL = <URL>
Help URL option to specify different help pages for different logbooks.
@@ -333,18 +341,17 @@ 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
+Message Width = <number>
-
Display mode
+Display mode = [full|summary|threaded]
Read password
-Write password
-Admin password
+Read password = <encoded password>
+Write password = <encoded password>
+Admin password = <encoded password>
Write password expiration = <hours>
Admin password expiration = <hours>
Show text = 0/1
+Show text = 0|1
This flag controls if logbook entries contain a body text. If an installation
only requires attributes, this flag can be set to 0. Default is
1.
-
Show attachments = 0/1
+Show attachments = 0|1
This flag controls the display of attachments such as images on normal
logbook pages. For logbooks with large images, this flag can be turned off,
@@ -682,33 +689,33 @@ This specifies the number of text lines displayed in a summary page. Zero displa
no text at all. The default is 3.
-
Reverse sort = 0/1
+Reverse sort = 0|1
If this flag is 1, the result of the "Last day" and "Last 10" queries
is sorted in reverse order (newest entry down to oldest). Default is 0.-
Search all logbooks = 0/1
+Search all logbooks = 0|1
If this flag is 1, the search form displays the button "Search all
logbooks". The default is 1. It might be necessary to turn this option
off for public logbooks if there are also protected logbooks. Otherwise the
search result would also display entries from the protected logbooks.-
Enable browsing = 0/1
+Enable browsing = 0|1
If this flag is 1, browsing (hitting the next/previous button) is enabled.
For some rare occasions it might be necessary to disable browsing. Default is
1.
-
Filtered browsing = 0/1
+Filtered browsing = 0|1
If this flag is 1, browsing (hitting the next/previous button) can be
filtered by individual attributes. If the checkbox next to an attribute is checked,
only messages with the same attribute value are displayed. Default is 1.
-
HTML default = 0/1/2/3
+HTML default = 0|1|2|3
This specifies the default state of the "Submit as HTML text" button on the
new message entry from. For installations where entries are normally submitted
@@ -717,7 +724,7 @@ as HTML, the default can be set to 1. If this value is set to 2
ore HTML submissions are possible, respectively. The default is 0.
-
Suppress default = 0/1/2
+Suppress default = 0|1|2
This specifies the default state of the "Suppress Email notification" button on the
new message entry form. For installations where normally an email notification is
@@ -727,7 +734,7 @@ entered, users can then uncheck the suppress box. If this value is set to 2
always produced. The default is 0.
-
Resubmit default = 0/1/2
+Resubmit default = 0|1|2
This specifies the default state of the "Resubmit as new entry" button on the
edit message entry from. If this button is checked, the current message is removed
@@ -737,7 +744,7 @@ have been updated recently. If this value is set to 2, the resubmit box
is not displayed at all. The default is 0.
-
Display Email recipients = 0/1
+Display Email recipients = 0|1
If this flag is 1, the email recipients are displayed when a logbook
entry is entered which produces an email notification. Setting this flag to 0
@@ -745,20 +752,20 @@ suppresses this display, in case users need not see that email is being sent and
The default is 1.
-
Email message body = 0/1
+Email message body = 0|1
If this flag is 1, the email notification send by elog contains the
full message body in addition to the attributes. The default is 0.
-
Back to main = 0/1
+Back to main = 0|1
If this flag is 1, the "Back" button takes you back to the logbook
selection page instead to the last entry of the current logbook.
The default is 0.
-
Restrict edit = 0/1
+Restrict edit = 0|1
If this flag is 1, users can only edit their own messages. The system
checks automatically if the currently logged in user matches the user
@@ -766,7 +773,7 @@ supplied in an author attribute via the "Preset xxxx" option.
The default is 0.
-
Top level only = 0/1
+Top level only = 0|1
If this flag is 1, only top level messages are displayed in the search
result page for threaded display. No replies are shown. The default is 0.