You successfully submitted a message
Back to the logbook
Enter another message
@@ -592,7 +592,7 @@ Here are the available options, by broad categories:
commands"** list. A typical example for the menu settings for this
scenario are:
-```
+``` text
Menu commands = List, New, Edit, Reply, Duplicate, Find, Config, Logout, Help
Guest menu commands = List, Find, Login, Help
```
@@ -613,7 +613,7 @@ Here are the available options, by broad categories:
to go back to the listing page and display the next *Routine* entry
and all *Routine* entries:
-```
+``` text
Next Routine entry |
All Routine entries
@@ -634,7 +634,7 @@ Here are the available options, by broad categories:
attributes, including the word *text*, if one wants to display the
entry body text for guests.
-```
+``` text
Summary |
Full |
@@ -841,7 +841,8 @@ Here are the available options, by broad categories:
This list specifies a set of icons for an attribute. Some icons are
contained in the *themes/default/icons* directory which can be used
here like
-```
+
+``` text
Attributes = Author, Icon, Subject...
IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
```
@@ -1032,11 +1033,11 @@ IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
RSS title. With this option once can changed this behaviour. Following
substitutions are possible:
- - $
diff --git a/mkdocs/docs/wishlist.md b/mkdocs/docs/wishlist.md
index f9baee7c..968d5af3 100644
--- a/mkdocs/docs/wishlist.md
+++ b/mkdocs/docs/wishlist.md
@@ -11,20 +11,17 @@ Feature| Votes
Implement groups of users| 8
Password expiration| 2
Account expiration|1
-Make attributes which whould be displayd selectable in \"Find\" page|1
+Make attributes which whould be displayed selectable in "Find" page|1
Convert elog text files into XML files and comma separated files with elconv|1
Implement multi-line attributes|8
Derive attribute options from list of entries of another logbook|1
Specify date format explicitly for substitutions, like $entry date{%Y}|2
Change attributes of whole thread, like mark a thread "open" or "closed"|4
Automatic unlocking of entries after a specific time period|1
-Implement PAM authentification under Linux (Which includes LDAP & AFS & Kerberos & ...)|13
Implement attributes which are math results from others, like *att3=att1+att2*|3
Show sums of numeric attributes|2
Let each user choose its language separately|1
Implement multiple selection boxes|1
-Boolean operators for queries, like "attrib1=a AND not attrib2=b"|1
-Implement "sybolik-link" logbooks such that a (virtual) logbook can "point" to a "real" logbook.
This is useful to have people always submit to the same logbook, when the real logbook
changes from time to time.|1
Select individual columns for display and printing|2
"Incremental" options. Have fixed set of global options, and in each
logbook add or remove some of those with
**+Options = ...** or **-Options = ...**|1
"Include" statement for config file.|2
diff --git a/mkdocs/site/config/index.html b/mkdocs/site/config/index.html
index 31e6ca89..29c1d4a5 100644
--- a/mkdocs/site/config/index.html
+++ b/mkdocs/site/config/index.html
@@ -821,7 +821,7 @@ show the logbooks from the other department. Prior to ELOG version
2.4.1, one had to run two elogd servers in parallel, listening under
different ports. Since 2.4.1, one can achieve the same behaviour using
Top groups. The configuration could look like this:
Group Linux PCs = Red Hat, Debian, Mandrake
+Group Linux PCs = Red Hat, Debian, Mandrake
Group Windows PCs = 98, ME, NT, XP, CE
Group CE = 1.0, 2.UL
@@ -941,7 +941,7 @@ section, the logbook option is used.
message list. This file can contain further links for new logbook
messages of for logbook queries. Here is a simple example of such a
file:
-<h1>Welcome to the test logbook</h1>
+<h1>Welcome to the test logbook</h1>
<ul>
<li><a href="?cmd=new">Enter</a> a new message
`<li><a href="?cmd=find">Search</a> the logbook
@@ -962,7 +962,7 @@ section, the logbook option is used.
Submit Page = <file>
This optional page can be displayed when a new message was submitted
in a logbook. Here is an example:
-<h1>You successfully submitted a message</h1>
+<h1>You successfully submitted a message</h1>
<a href="?cmd=Back">Back</a> to the logbook<p>
<a href="?cmd=New">Enter</a> another message
@@ -1049,7 +1049,7 @@ section, the logbook option is used.
password file), which then allowes full access via the "Menu
commands" list. A typical example for the menu settings for this
scenario are:
- Menu commands = List, New, Edit, Reply, Duplicate, Find, Config, Logout, Help
+ Menu commands = List, New, Edit, Reply, Duplicate, Find, Config, Logout, Help
Guest menu commands = List, Find, Login, Help
Note that the presence of this option opens user access also to the
@@ -1065,7 +1065,7 @@ section, the logbook option is used.
arbitrary text, images or links. One example would be following text
to go back to the listing page and display the next Routine entry
and all Routine entries:
-<small>
+<small>
<a href="?cmd=next&type=Routine">Next Routine entry</a> |
<a href="../?Type=Routine">All Routine entries</a>
</small>
@@ -1081,7 +1081,7 @@ section, the logbook option is used.
"Password file"). The list consists of comma separated
attributes, including the word text, if one wants to display the
entry body text for guests.
-<small>
+<small>
<a href="?mode=summary">Summary</a> |
<a href="?mode=full">Full</a> |
<a href="?mode=threaded">Threaded</a> |
@@ -1250,7 +1250,7 @@ section, the logbook option is used.
This list specifies a set of icons for an attribute. Some icons are
contained in the themes/default/icons directory which can be used
here like
-Attributes = Author, Icon, Subject...
+Attributes = Author, Icon, Subject...
IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
New icons are welcome and should be sent back to the author to be
@@ -1401,11 +1401,11 @@ IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
RSS title. With this option once can changed this behaviour. Following
substitutions are possible:
-- $<attribute>**: The value of the attribute
-- $logbook**: The name of the current logbook
-- $entry time: The message date and time, formatted via "Time
+
- $<attribute>: The value of the attribute
+- $logbook: The name of the current logbook
+- $entry time: The message date and time, formatted via "Time
format"
-- $message id**: The message ID
+- $message id: The message ID
A typical example would be\
RSS Title = $subject, posted by $author on $entry time
@@ -1416,23 +1416,23 @@ IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
by some text. This text can contain arbitrary fixed text and following
values:
-- $<attribute>**: The entered value of the attribute itself
-- $host: The host name where
elogd** is running
-- $remote_host**: The host name of the host from with the entry was
+
- $<attribute>: The entered value of the attribute itself
+- $host: The host name where
elogd is running
+- $remote_host: The host name of the host from with the entry was
submitted
-- $short_name**: The login name (if password file is present)
-- $long_name**: The full name from the password file for the
+
- $short_name: The login name (if password file is present)
+- $long_name: The full name from the password file for the
current user
-- $user_email**: The email address from the password file for the
+
- $user_email: The email address from the password file for the
current user
-- $logbook**: The name of the current logbook
-- $date: The current date, formatted via "Date format"
-- $utcdate: The current UTC date (GMT) and time, formatted via
- "Date format"
-- $version**: The version of the ELOG server in the form x.y.z
-- $revision**: The Subversion reversion of the ELOG server as an
+
- $logbook: The name of the current logbook
+- $date: The current date, formatted via "Date format"
+- $utcdate: The current UTC date (GMT) and time, formatted via
+ "Date format"
+- $version: The version of the ELOG server in the form x.y.z
+- $revision: The Subversion reversion of the ELOG server as an
integer number
-- $shell(<command>)**: <command> gets passed to the operating
+
- $shell(<command>): <command> gets passed to the operating
system shell and the result is taken for substitution.
Following example use this feature to add the remote host name to the
@@ -1440,7 +1440,7 @@ IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ...
Subst Author = $author from $remote_host
Following example substitutes an attribute with the contents of a
file:
-Subst Info = $shell(cat /tmp/filename) (Unix)
+Subst Info = $shell(cat /tmp/filename) (Unix)
Subst Info = $shell(type c:\tmp\filename) (Windows)
A special option are automatically generated tags, which are
@@ -1450,7 +1450,7 @@ Subst Info = $shell(type c:\tmp\filename) (Windows)
digit, thus the statement
Subst Number = XYZ-#####
results in automatically created attributes "Number" of the form
-XYZ-00001
+XYZ-00001
XYZ-00002
XYZ-00003
@@ -1459,14 +1459,14 @@ XYZ-00003
to create tags wich contain the current year, month and so on. Once
the date part of the attribute changes, the index restarts from one.
The statement
-`Subst Number = XYZ-%Y-%b-###
+Subst Number = XYZ-%Y-%b-###
results in automatically created attributes "Number" of the form
-XYZ-2005-Oct-001
+XYZ-2005-Oct-001
XYZ-2005-Oct-002
XYZ-2005-Oct-003
and
-XYZ-2005-Nov-001
+XYZ-2005-Nov-001
XYZ-2005-Nov-002
on the next month.
@@ -1513,21 +1513,21 @@ XYZ-2005-Nov-002
defined in the comma-separated list:
Values used for single message display page:
-- <flags>** Sum of following flags:
+- <flags> Sum of following flags:
- 1: Display attribute in same line as previous attribute
- 2: Display radio buttons or check boxes in separate lines (if
applicable)
-- <css_class_name>,<css_class_value> Cascading Style Sheet
+
- <css_class_name>,<css_class_value> Cascading Style Sheet
class names used for cells containing attribute name or value,
respectively. The classes must be defined in the style sheet file
- (usually themes/default/default.css).
+ (usually themes/default/default.css).
Values used for new message entry form:
-- <width>** Width of the text entry field in characters
-- <size>** Maximum number of characters allowed.
+- <width> Width of the text entry field in characters
+- <size> Maximum number of characters allowed.
Default is "0, attribname, attribvalue, 80, 500". Trailing
parameters can be ommitted, so specifying for example only the flags
@@ -1569,7 +1569,7 @@ XYZ-2005-Nov-002
called importnace and you want to highlight all entries where
importnace is severe for example, you can specify
following style:
-Style importance severe = background-color:red
+Style importance severe = background-color:red
For possible formattings, please refer to some CSS documentation. You
can change the colors, font styles and sizes. The style is then valid
for the whole row of that entry.
@@ -1585,7 +1585,7 @@ Cell Style Status Not Fixed = background-color:red
Cell Style Status Under Process = background-color:yellow
for example produce following listing:
-
{border="0"}
+
Change <attribute> = <string>
Instead of subsituting an attribute, the original attribute can be
kept and just the output formatting can be changed. This can be very
@@ -1694,7 +1694,7 @@ possibility is the definition of forms. Depending on an attribute, the
configuration option Preset text = ... can be used to copy some
pre-defined forms into the message body, which can then be filled out.
Consider following example:
-Attributes = Author, Type
+Attributes = Author, Type
Options Type = Network check{1}, System check{2}
{1} Preset text = network.txt
@@ -1703,7 +1703,7 @@ Options Type = Network check{1}, System check{2}
This causes two text files network.txt and system.txt to be copied
into the message body when a new entry is made. The file network.txt
could look like:
-Routers checked: [ ]
+Routers checked: [ ]
DHCP checked: [ ]
Comment: ...
@@ -1738,7 +1738,7 @@ only requiremnt is that conditions are uniquie, meaning that a condition
in one option list cannot be used in another list. This can easily be
avoided by using numbers for one condition and letters for the other
condition, like in the following example:
-Attributes = PC Name, Operating System, Version, Location, Floor
+Attributes = PC Name, Operating System, Version, Location, Floor
Options Operating System = Linux{1}, Windows{2}
Options Location = Main Building{a}, New Building{b}, Old Building{c}
{1} Options Version = 2.2, 2.4, 2.6
@@ -1783,7 +1783,7 @@ browser.
Admin user = <user list>
Login user = <user list>
This file contains user names and passwords in XML format, such as
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- created by MXML on Tue Nov 07 08:15:51 2006 -->
<list>
<user>
diff --git a/mkdocs/site/index.html b/mkdocs/site/index.html
index f38c1818..7ff8c5ae 100644
--- a/mkdocs/site/index.html
+++ b/mkdocs/site/index.html
@@ -289,5 +289,5 @@ by Fred Pacquier
diff --git a/mkdocs/site/search/search_index.json b/mkdocs/site/search/search_index.json
index e070226d..fd8e9bdb 100644
--- a/mkdocs/site/search/search_index.json
+++ b/mkdocs/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"The ELOG Home Page Home of the Electronic Logbook package by Stefan Ritt Current version: 3.1.4 What is ELOG ? ELOG is part of a family of applications known as weblog s . Their general purpose is : to make it easy for people to put information online in a chronological fashion, in the form of short, time-stamped text messages (\"entries\") with optional HTML markup for presentation, and optional file attachments (images, archives, etc.) to make it easy for other people to access this information through a Web interface, browse entries, search, download files, and optionally add, update, delete or comment on entries. ELOG is a remarkable implementation of a weblog in at least two respects : its simplicity of use : you don't need to be a seasoned server operator and/or an experimented database administrator to run ELOG ; one executable file (under Unix or Windows), a simple configuration text file, and it works. No Web server or relational database required. It is also easy to translate the interface to the appropriate language for your users. its versatility : through its single configuration file, ELOG can be made to display an infinity of variants of the weblog concept. There are options for what to display, how to display it, what commands are available and to whom, access control, etc. Moreover, a single server can host several weblog s , and each weblog can be totally different from the rest. Screen shots On the left upper panel is a typical logbook page displayed by Netscape Navigator. Each logbook page can contain attachments in a similar way to emails. This makes it possible to store images or text files and retrieve them easily. You could for example attach a sample configuration file which can later be copied to the local machine with the \" Save As... \" function of the Web browser. Several logbooks can be served though a single ELOG server. Each logbook can use different attributes for its entries. The logbook can then be searched using these attributes. The right pane on the left image shows a search for all entries with attribute \" Type \" equal to \" Configuration \", and the lower pane shows the search result. It is also possible to use full-text search in attributes and the entry body. While logbook entries are usually displayed one entry per page, they can also be listed consecutively which makes it easy to produce a paper printout of a logbook. Logbook pages can be edited or deleted. This feature can be turned off in the configuration file so that a logbook entries cannot be changed after being submitted. An additional feature is the automatic generation of a notification email messages based on a certain type or category of a logbook entry. Also try out the online demo Use cases The features of ELOG make it useful for several applications: Personal Logbooks . Personal notes can be written into ELOG and can then be retrieved from anywhere with a Web browser. This makes it handy for PC supporters who have to go around in companies or laboratories and don\\'t want to carry their paper logbook with them. The same holds true for people traveling around a lot. The logbook database consists of plain ASCII files which can copied easily between different computers to have local access, for example on a notebook with no network connection. Shared Logbooks . Logbooks can be shared by several people, for reading and optionally for writing. This way workgroups can share and exchange information like in a (simplified) news group. This is supported by the Reply command in ELOG which creates \" threads \" of entries. Users can be notified by email when new entries are added to the logbook. Compared to that of a news server, the installation of ELOG is much simpler. Small Databases . Since arbitrary attributes can be defined for a logbook, it can be used as a small database with search facilities. Problem collections . A system can consist of two logbooks, in one of which users enter bugs or problems. If someone adds a problem, an email is automatically sent to the administrator, who can then copy the entry to the second logbook and add the solution to the problem. Users can then look up all fixed problems. Shift Logbooks . If the Allow delete and Allow edit flags are off, an entry cannot be modified once it\\'s been entered. This can be useful for shift logbooks for example in accelerator control rooms where each entry becomes a \" document \" with a time and author stamp. ELOG was originally developed as a shift logbook for the PiBeta and Muegamma particle experiments at PSI . File collections . Since files can be attached to ELOG entries, the system can be used to store and retrieve files. This can be used to store configuration files, which need to be accessible by several people over the web, or to store images. Since ELOG features an elaborate query facility, entries can be searched for by specifying several categories. License ELOG is released under the GNU Public License . Credits The author would like to give credits to following people: Fred Pacquier for this Web site and the French translation Recai Oktas and Roger Kalt for the Debian package djek for the Dutch translation Heiko Scheit for many bug fixes and fruitful discussions Julio Calvo for the Spanish translation Emiliano 'AlberT' Gabrielli for his idea of scaling attached images Andreas Luedeke for continuing user support and deployment of ELOG at PSI Talks and presentations Here are some talks and presentations given at various occasions: Seminar at KIT, Karlsruhe, Jan. 2015. Introduction talk by Stefan Ritt. Seminar at KIT, Karlsruhe, Jan. 2015. Application of ELOG for accelerator operation at PSI by Andreas Luedeke . Content by Stefan Ritt , Web pages by Fred Pacquier","title":"Home"},{"location":"#the-elog-home-page","text":"Home of the Electronic Logbook package by Stefan Ritt Current version: 3.1.4","title":"The ELOG Home Page"},{"location":"#what-is-elog","text":"ELOG is part of a family of applications known as weblog s . Their general purpose is : to make it easy for people to put information online in a chronological fashion, in the form of short, time-stamped text messages (\"entries\") with optional HTML markup for presentation, and optional file attachments (images, archives, etc.) to make it easy for other people to access this information through a Web interface, browse entries, search, download files, and optionally add, update, delete or comment on entries. ELOG is a remarkable implementation of a weblog in at least two respects : its simplicity of use : you don't need to be a seasoned server operator and/or an experimented database administrator to run ELOG ; one executable file (under Unix or Windows), a simple configuration text file, and it works. No Web server or relational database required. It is also easy to translate the interface to the appropriate language for your users. its versatility : through its single configuration file, ELOG can be made to display an infinity of variants of the weblog concept. There are options for what to display, how to display it, what commands are available and to whom, access control, etc. Moreover, a single server can host several weblog s , and each weblog can be totally different from the rest.","title":"What is ELOG ?"},{"location":"#screen-shots","text":"On the left upper panel is a typical logbook page displayed by Netscape Navigator. Each logbook page can contain attachments in a similar way to emails. This makes it possible to store images or text files and retrieve them easily. You could for example attach a sample configuration file which can later be copied to the local machine with the \" Save As... \" function of the Web browser. Several logbooks can be served though a single ELOG server. Each logbook can use different attributes for its entries. The logbook can then be searched using these attributes. The right pane on the left image shows a search for all entries with attribute \" Type \" equal to \" Configuration \", and the lower pane shows the search result. It is also possible to use full-text search in attributes and the entry body. While logbook entries are usually displayed one entry per page, they can also be listed consecutively which makes it easy to produce a paper printout of a logbook. Logbook pages can be edited or deleted. This feature can be turned off in the configuration file so that a logbook entries cannot be changed after being submitted. An additional feature is the automatic generation of a notification email messages based on a certain type or category of a logbook entry. Also try out the online demo","title":"Screen shots"},{"location":"#use-cases","text":"The features of ELOG make it useful for several applications: Personal Logbooks . Personal notes can be written into ELOG and can then be retrieved from anywhere with a Web browser. This makes it handy for PC supporters who have to go around in companies or laboratories and don\\'t want to carry their paper logbook with them. The same holds true for people traveling around a lot. The logbook database consists of plain ASCII files which can copied easily between different computers to have local access, for example on a notebook with no network connection. Shared Logbooks . Logbooks can be shared by several people, for reading and optionally for writing. This way workgroups can share and exchange information like in a (simplified) news group. This is supported by the Reply command in ELOG which creates \" threads \" of entries. Users can be notified by email when new entries are added to the logbook. Compared to that of a news server, the installation of ELOG is much simpler. Small Databases . Since arbitrary attributes can be defined for a logbook, it can be used as a small database with search facilities. Problem collections . A system can consist of two logbooks, in one of which users enter bugs or problems. If someone adds a problem, an email is automatically sent to the administrator, who can then copy the entry to the second logbook and add the solution to the problem. Users can then look up all fixed problems. Shift Logbooks . If the Allow delete and Allow edit flags are off, an entry cannot be modified once it\\'s been entered. This can be useful for shift logbooks for example in accelerator control rooms where each entry becomes a \" document \" with a time and author stamp. ELOG was originally developed as a shift logbook for the PiBeta and Muegamma particle experiments at PSI . File collections . Since files can be attached to ELOG entries, the system can be used to store and retrieve files. This can be used to store configuration files, which need to be accessible by several people over the web, or to store images. Since ELOG features an elaborate query facility, entries can be searched for by specifying several categories.","title":"Use cases"},{"location":"#license","text":"ELOG is released under the GNU Public License .","title":"License"},{"location":"#credits","text":"The author would like to give credits to following people: Fred Pacquier for this Web site and the French translation Recai Oktas and Roger Kalt for the Debian package djek for the Dutch translation Heiko Scheit for many bug fixes and fruitful discussions Julio Calvo for the Spanish translation Emiliano 'AlberT' Gabrielli for his idea of scaling attached images Andreas Luedeke for continuing user support and deployment of ELOG at PSI","title":"Credits"},{"location":"#talks-and-presentations","text":"Here are some talks and presentations given at various occasions: Seminar at KIT, Karlsruhe, Jan. 2015. Introduction talk by Stefan Ritt. Seminar at KIT, Karlsruhe, Jan. 2015. Application of ELOG for accelerator operation at PSI by Andreas Luedeke . Content by Stefan Ritt , Web pages by Fred Pacquier","title":"Talks and presentations"},{"location":"adminguide/","text":"ELOG Administrator's Guide How to set up and run your very own ELOG server Installing and running on Linux Installation from the RPM file 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](http://elog.psi.ch/elog/download/RPMS/) 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 ` /etc/rc.d/init.d/elogd start It will listen under the port specified in /usr/local/elog/elogd.cfg which is 8080 by default. So one can connect using any browser with the URL: http://localhost:8080 To start the daemon automatically, enter: chkconfig --add elogd chkconfig --level 345 elogd on which will start the daemon on run levels 3,4 and 5 after the next reboot. Note that the RPM installation creates a user and group elog , under which the daemon runs. To start the daemon on non-RedHat systems, like SuSE or Solaris, a more generic startup scrips has been provided by Steve Jones in the Contributions section. Installation from the tarball Download the latest elog-x.x.x.tar.gz package.` Make sure you have the libssl-dev package installed. Consult your distribution for details. 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 elconv . On some systems like OpenBSD you have to execut gmake . These executables can then be copied to a convenient place like /usr/local/bin or ~/bin . Alternatively, a \"make install\" will copy the daemon elogd to SDESTDIR (by default /usr/local/sbin ) and the other files to DESTDIR (by default /usr/local/bin ). These directories can be changed in the Makefile. The elogd executable can be started manually for testing with : ` elogd -p 8080 where the -p flag specifies the port. Without the -p flag, the server uses the standard WWW port 80. Note that ports below 1024 can only be used if elogd is started under root, or the \" sticky bit \" is set on the executable. When elogd is started under root, it attaches to the specified port and tries to fall-back to a non-root account. This is necessary to avoid security problems. 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 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 that elogd , when running under the specific user and group account, has read and write access to the configuration file and logbook directories. Note that the RPM installation automatically creates a user and group elog . If the program complains with something like \" cannot bind to port ...\", it could be that the network is not started on the Linux box. This can be checked with the /sbin/ifconfig program, which must show that eth0 is up and running. The distribution contains a sample configuration file elogd.cfg and a demo logbook in the demo subdirectory. If the elogd server is started in the elogd-x.x.x directory, the demo logbook can be directly accessed with a browser by specifying the URL http://localhost:8080 (or whatever port you started the elog daemon on). If the elogd server is started in some other directory, you must specify the full path of the elogd file with the \"-c\" flag and change the Data dir = option in the configuration file to a full path like /usr/local/elog . Once testing is complete, elogd will typically be started with the -D flag to run as a daemon in the background, like this : elogd -p 8080 -c /usr/local/elog/elogd.cfg -D Note that it is mandatory to specify the full path for the elogd file when started as a daemon. To test the daemon, connect to your host via : http://your.host:8080/ If port 80 is used, the port can be omitted in the URL. If several logbooks are defined on a host, they can be specified in the URL : http://your.host/ where is the name of the logbook. The contents of the all-important configuration file elogd.cfg are described in Config . Notes for various platforms This section contains notes for installing and running elog under various operating systems. Mac OS X Under Mac OSX, ELOG must be compiled from the source code. The OSX command line tools (compiler & Co) must be available, which can be done thought he free Xcode package which can be obtained though the App Store. Once Xcode is installed, you can do a xcode-select --install to install the command line tools. After that, a simple make in in the elog directory does the job of compiling ELOG. If SSL support is needed (access via https://...), you have to install OpenSSL and turn on SSL support in the Makefile by setting USE_SSL = 1 . You can install OpenSSL for example through the MacPorts project. After having installed MacPorts, you do a sudo port install openssl . After successful compilation, you do a sudo make install to install all required files under the installation directory, which is by default /usr/local/ . A subdirectory /usr/local/elog is created which contains a simple example logbook. The ELOG server can now be started either manually with /usr/local/sbin/elogd or through the daemon servics with sudo launchctl enable system/ch.psi.elogd sudo launchctl bootstrap system /Library/LaunchDaemons/ch.psi.elogd.plist To stop the service, use sudo launchctl bootout system /Library/LauchDaemons/ch.psi.elogd.plist sudo launchctl disable system/ch.psi.elogd Debian A Debian package is available under https://tracker.debian.org/pkg/elog . Solaris 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 elogd With some combinations of Solaris servers and client-side browsers there have also been problems with ELOG 's keep-alive feature. In such a case you need to add the \" -k \" flag to the elogd command line to turn keep-alives off. FreeBSD David Otto maintains the ELOG port for FreeBSD . To install ELOG on a FreeBSD system, you can simply type cd /usr/ports/www/elog make install clean 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: 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 \\ 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 staring with /elog to the elogd daemon. Note : Do not put \"ProxyRequests On\" into your configuration file. This option is not necessary and can be misused for spamming and proxy forwarding of otherwise blocked sites. Because elogd uses links to itself (for example in the email notification and the redirection after a submit), it has to know under which URL it is running. If you run it under a proxy, you have to add the line: URL = http://your.proxy.host/subdir/ into elogd.cfg. Using apache authentication It is also possible to login via an apache-auth module. In elogd.cfg you should use the keyword \"Webserver\" for Authentication: Authentication = Webserver This triggers elogd to use the environment variable \"X-Forwarded-User\" as the logged in user. A simple example of a apache configuration (including the proxy) is : # this required to pass on the generated env-variable X-Forwarded-User to the proxy ProxyPassInterpolateEnv On ProxyPass /elog/ http://your.host.domain:8080/ Order allow,deny Allow from all AuthType Basic AuthName \"elog-server\" AuthUserFile \"/opt/elog/htpasswd\" require valid-user RequestHeader unset Authorization RequestHeader add X-Forwarded-User %{REMOTE_USER}s # elog doesn't like the '@', so we need to cut it RequestHeader edit X-Forwarded-User \"@(.*)$\" \"\" Installing ImageMagick When images are attached to ELOG entries, thumbnails can be created for quick preview. This works also for PDF and PostScript files. ELOG forwards any image operation to the ImageMagic and GhostScript packages, which must be installed for this to work. While these packages are installed on most Linux systems, windows users have to download and install these pagages manually. ImageMagick can be obtained from www.imagemagick.org and GhostScript can be obtained from http://pages.cs.wisc.edu/~ghost/ . After the installation, it has to be made sure that both packages are in the path. This can be checked to open a command prompt and typing identify -version . This command should return someting like: C:\\>identify -version Version: ImageMagick 6.3.8 01/25/08 Q16 http://www.imagemagick.org Copyright: Copyright (C) 1999-2008 ImageMagick Studio LLC When ELOG is started interactively, it checks for the ImageMagick installation and shows a note if it is found: C:\\Program Files\\ELOG>elogd elogd 2.7.2 built Feb 21 2008, 20:00:42 revision 2051 ImageMagick detected Indexing logbooks ... done Server listening on port 8080 ... If ImageMagick is not installed, the thumbnail functions are simply disabled, but ELOG can otherwise run normally. Installing and running in Windows ELOG is distributed in binary (executable) form for Windows platforms. It will run happily in console mode (or \" DOS box \") under Windows 9x and ME. Under Windows NT and 2000 it is also possible to run it as a service (the Windows equivalent of a UNIX daemon ). Download the latest elogxxx.exe file and execute it. The installer puts the ELOG system into a directory you specify and adds some menu shortcuts. With these shortcuts, the daemon elogd.exe can be started directly and the demo logbook can be accessed with the browser. Alternatively, the elogd.exe daemon can be registered as a service under Windows NT/2000/XP, so it gets started automatically when windows boots. This can be selected during installation or be done manually with the start menu shortcuts. While the pre-2.5.3 methods of installing elogd.exe as a daemon (namely FireDaemon and srvany.exe) 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. Server Configuration [The ELOG daemon elogd can be executed with the following options :]{#config} elogd [-p port] [-n hostname/IP] [-C] [-m] [-M] [-D] [-c file] [-s dir] [-d dir] [-v] [-k] [-f file] [-x] with : `-p ` TCP port number to use for the http server (if other than 80) `-n ` in the case of a \"multihomed\" server, host name or IP address of the interface ELOG should run on `-C ` clone remote elogd configuration `-m` synchronize logbook(s) with remote server `-M` synchronize with removing deleted entries `-l ` optionally specify logbook for -m and -M commands `-D` become a daemon (Unix only) `-c ` specify the configuration file (full path mandatory if -D is used) `-s ` specify resource directory (themes, icons, \\...) `-d ` specify logbook root directory `-v ` verbose output for debugging `-k ` do not use TCP keep-alive `-f ` specify PID file where elogd process ID is written when server is started `-x `enables execution of shell 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. 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. Instead of restarting the server, under Unix one can send a HUP signal like \"killall -HUP elogd\" to tell the server to re-read its configuration. 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 Using elogd itself Starting from version 2.7.3 on, the elogd program supports secure connections over the Secure Socker Layer (SSL) directly. It is recommented to run elog only through secure HTTPS connections if passwords are used. Otherwise the passwords are send over the network in clear text and exposed to sniffing attacks . To use SSL, put SSL = 1 into the config file. If the URL = directive is used, make sure to use https://... instead of http://... there. The ELOG distribution contains a simple self-signed certificate in the **ssl** subdirectory. One can replace this certificate and key with a real ceritficate to avoid browser pop-up windows warning about the self-signed certificate. ` Using Apache Another possibility is to use the Apache web server as a proxy server allowing secure connections. To do so, Apache has to be configured accordingly and a certificate has to be generated. See some instructions on how to create a certificate, and see Running elogd under Apache before on this page on how to run elogd under Apache. Once configured correctly, elogd can be accessed via http://your.host and via https://your.host simultaneously. The redirection statement has to be changed to Redirect permanent /elog https://your.host.domain/elog/ ProxyPass /elog/ http://your.host.domain:8080/ and following has to be added to the section \"VirtualHOst ...:443 in /etc/httpd/conf.d/ssl.conf: # Proxy setup for Elog Order deny,allow Allow from all ProxyPass /elog/ http://host.where.elogd.is.running:8080/ ProxyPassReverse /elog/ http://host.where.elogd.is.running:8080/ Then, following URL statement has to be written to elogd.cfg: URL = https://your.host.domain/elog There is a more detailed step-by-step instructions at the contributions section . Using ssh elogd can be accessed through a a SSH tunnel. To do so, open an SSH tunnel like: ssh -L 1234:your.server.name:8080 your.server.name This opens a secure tunnel from your local host, port 1234, to the server host where the elogd daemon is running on port 8080. Now you can access http://localhost:1234 from your browser and reach elogd in a secure way. How It All Works For the technically curious: The concept of ELOG is very simple. The logbook functionality is implemented by a single daemon program, elogd , which is written in C. It contains an integrated Web server, which does not serve files like standard Web servers, but 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 (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 (main body text or attribute), it gets converted automatically in order not to invalidate the database structure. If attachments are submitted, they are saved as separate files named YYMMDD_HHMMSS_name - where in addition to the date the time is specified and name is the original file name of the attachment. To copy the database to another computer, only the *.log files and the attachment files need to be copied. To copy for example all files from March 2001, just select them with 0103??a.log and 0103??_* .","title":"Admin guide"},{"location":"adminguide/#elog-administrators-guide","text":"How to set up and run your very own ELOG server","title":"ELOG Administrator's Guide"},{"location":"adminguide/#installing-and-running-on-linux","text":"","title":"Installing and running on Linux"},{"location":"adminguide/#installation-from-the-rpm-file","text":"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](http://elog.psi.ch/elog/download/RPMS/) 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 ` /etc/rc.d/init.d/elogd start It will listen under the port specified in /usr/local/elog/elogd.cfg which is 8080 by default. So one can connect using any browser with the URL: http://localhost:8080 To start the daemon automatically, enter: chkconfig --add elogd chkconfig --level 345 elogd on which will start the daemon on run levels 3,4 and 5 after the next reboot. Note that the RPM installation creates a user and group elog , under which the daemon runs. To start the daemon on non-RedHat systems, like SuSE or Solaris, a more generic startup scrips has been provided by Steve Jones in the Contributions section.","title":"Installation from the RPM file"},{"location":"adminguide/#installation-from-the-tarball","text":"Download the latest elog-x.x.x.tar.gz package.` Make sure you have the libssl-dev package installed. Consult your distribution for details. 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 elconv . On some systems like OpenBSD you have to execut gmake . These executables can then be copied to a convenient place like /usr/local/bin or ~/bin . Alternatively, a \"make install\" will copy the daemon elogd to SDESTDIR (by default /usr/local/sbin ) and the other files to DESTDIR (by default /usr/local/bin ). These directories can be changed in the Makefile. The elogd executable can be started manually for testing with : ` elogd -p 8080 where the -p flag specifies the port. Without the -p flag, the server uses the standard WWW port 80. Note that ports below 1024 can only be used if elogd is started under root, or the \" sticky bit \" is set on the executable. When elogd is started under root, it attaches to the specified port and tries to fall-back to a non-root account. This is necessary to avoid security problems. 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 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 that elogd , when running under the specific user and group account, has read and write access to the configuration file and logbook directories. Note that the RPM installation automatically creates a user and group elog . If the program complains with something like \" cannot bind to port ...\", it could be that the network is not started on the Linux box. This can be checked with the /sbin/ifconfig program, which must show that eth0 is up and running. The distribution contains a sample configuration file elogd.cfg and a demo logbook in the demo subdirectory. If the elogd server is started in the elogd-x.x.x directory, the demo logbook can be directly accessed with a browser by specifying the URL http://localhost:8080 (or whatever port you started the elog daemon on). If the elogd server is started in some other directory, you must specify the full path of the elogd file with the \"-c\" flag and change the Data dir = option in the configuration file to a full path like /usr/local/elog . Once testing is complete, elogd will typically be started with the -D flag to run as a daemon in the background, like this : elogd -p 8080 -c /usr/local/elog/elogd.cfg -D Note that it is mandatory to specify the full path for the elogd file when started as a daemon. To test the daemon, connect to your host via : http://your.host:8080/ If port 80 is used, the port can be omitted in the URL. If several logbooks are defined on a host, they can be specified in the URL : http://your.host/ where is the name of the logbook. The contents of the all-important configuration file elogd.cfg are described in Config .","title":"Installation from the tarball"},{"location":"adminguide/#notes-for-various-platforms","text":"This section contains notes for installing and running elog under various operating systems.","title":"Notes for various platforms"},{"location":"adminguide/#mac-os-x","text":"Under Mac OSX, ELOG must be compiled from the source code. The OSX command line tools (compiler & Co) must be available, which can be done thought he free Xcode package which can be obtained though the App Store. Once Xcode is installed, you can do a xcode-select --install to install the command line tools. After that, a simple make in in the elog directory does the job of compiling ELOG. If SSL support is needed (access via https://...), you have to install OpenSSL and turn on SSL support in the Makefile by setting USE_SSL = 1 . You can install OpenSSL for example through the MacPorts project. After having installed MacPorts, you do a sudo port install openssl . After successful compilation, you do a sudo make install to install all required files under the installation directory, which is by default /usr/local/ . A subdirectory /usr/local/elog is created which contains a simple example logbook. The ELOG server can now be started either manually with /usr/local/sbin/elogd or through the daemon servics with sudo launchctl enable system/ch.psi.elogd sudo launchctl bootstrap system /Library/LaunchDaemons/ch.psi.elogd.plist To stop the service, use sudo launchctl bootout system /Library/LauchDaemons/ch.psi.elogd.plist sudo launchctl disable system/ch.psi.elogd","title":"Mac OS X"},{"location":"adminguide/#debian","text":"A Debian package is available under https://tracker.debian.org/pkg/elog .","title":"Debian"},{"location":"adminguide/#solaris","text":"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 elogd With some combinations of Solaris servers and client-side browsers there have also been problems with ELOG 's keep-alive feature. In such a case you need to add the \" -k \" flag to the elogd command line to turn keep-alives off.","title":"Solaris"},{"location":"adminguide/#freebsd","text":"David Otto maintains the ELOG port for FreeBSD . To install ELOG on a FreeBSD system, you can simply type cd /usr/ports/www/elog make install clean","title":"FreeBSD"},{"location":"adminguide/#running-elogd-under-apache","text":"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: 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 \\ 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 staring with /elog to the elogd daemon. Note : Do not put \"ProxyRequests On\" into your configuration file. This option is not necessary and can be misused for spamming and proxy forwarding of otherwise blocked sites. Because elogd uses links to itself (for example in the email notification and the redirection after a submit), it has to know under which URL it is running. If you run it under a proxy, you have to add the line: URL = http://your.proxy.host/subdir/ into elogd.cfg.","title":"Running elogd under Apache"},{"location":"adminguide/#using-apache-authentication","text":"It is also possible to login via an apache-auth module. In elogd.cfg you should use the keyword \"Webserver\" for Authentication: Authentication = Webserver This triggers elogd to use the environment variable \"X-Forwarded-User\" as the logged in user. A simple example of a apache configuration (including the proxy) is : # this required to pass on the generated env-variable X-Forwarded-User to the proxy ProxyPassInterpolateEnv On ProxyPass /elog/ http://your.host.domain:8080/ Order allow,deny Allow from all AuthType Basic AuthName \"elog-server\" AuthUserFile \"/opt/elog/htpasswd\" require valid-user RequestHeader unset Authorization RequestHeader add X-Forwarded-User %{REMOTE_USER}s # elog doesn't like the '@', so we need to cut it RequestHeader edit X-Forwarded-User \"@(.*)$\" \"\" ","title":"Using apache authentication"},{"location":"adminguide/#installing-imagemagick","text":"When images are attached to ELOG entries, thumbnails can be created for quick preview. This works also for PDF and PostScript files. ELOG forwards any image operation to the ImageMagic and GhostScript packages, which must be installed for this to work. While these packages are installed on most Linux systems, windows users have to download and install these pagages manually. ImageMagick can be obtained from www.imagemagick.org and GhostScript can be obtained from http://pages.cs.wisc.edu/~ghost/ . After the installation, it has to be made sure that both packages are in the path. This can be checked to open a command prompt and typing identify -version . This command should return someting like: C:\\>identify -version Version: ImageMagick 6.3.8 01/25/08 Q16 http://www.imagemagick.org Copyright: Copyright (C) 1999-2008 ImageMagick Studio LLC When ELOG is started interactively, it checks for the ImageMagick installation and shows a note if it is found: C:\\Program Files\\ELOG>elogd elogd 2.7.2 built Feb 21 2008, 20:00:42 revision 2051 ImageMagick detected Indexing logbooks ... done Server listening on port 8080 ... If ImageMagick is not installed, the thumbnail functions are simply disabled, but ELOG can otherwise run normally.","title":"Installing ImageMagick"},{"location":"adminguide/#installing-and-running-in-windows","text":"ELOG is distributed in binary (executable) form for Windows platforms. It will run happily in console mode (or \" DOS box \") under Windows 9x and ME. Under Windows NT and 2000 it is also possible to run it as a service (the Windows equivalent of a UNIX daemon ). Download the latest elogxxx.exe file and execute it. The installer puts the ELOG system into a directory you specify and adds some menu shortcuts. With these shortcuts, the daemon elogd.exe can be started directly and the demo logbook can be accessed with the browser. Alternatively, the elogd.exe daemon can be registered as a service under Windows NT/2000/XP, so it gets started automatically when windows boots. This can be selected during installation or be done manually with the start menu shortcuts. While the pre-2.5.3 methods of installing elogd.exe as a daemon (namely FireDaemon and srvany.exe) 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.","title":"Installing and running in Windows"},{"location":"adminguide/#server-configuration","text":"[The ELOG daemon elogd can be executed with the following options :]{#config} elogd [-p port] [-n hostname/IP] [-C] [-m] [-M] [-D] [-c file] [-s dir] [-d dir] [-v] [-k] [-f file] [-x] with : `-p ` TCP port number to use for the http server (if other than 80) `-n ` in the case of a \"multihomed\" server, host name or IP address of the interface ELOG should run on `-C ` clone remote elogd configuration `-m` synchronize logbook(s) with remote server `-M` synchronize with removing deleted entries `-l ` optionally specify logbook for -m and -M commands `-D` become a daemon (Unix only) `-c ` specify the configuration file (full path mandatory if -D is used) `-s ` specify resource directory (themes, icons, \\...) `-d ` specify logbook root directory `-v ` verbose output for debugging `-k ` do not use TCP keep-alive `-f ` specify PID file where elogd process ID is written when server is started `-x `enables execution of shell 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. 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. Instead of restarting the server, under Unix one can send a HUP signal like \"killall -HUP elogd\" to tell the server to re-read its configuration. 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 . * *","title":"Server Configuration"},{"location":"adminguide/#secure-connections-howto","text":"","title":"Secure Connections HOWTO"},{"location":"adminguide/#using-elogd-itself","text":"Starting from version 2.7.3 on, the elogd program supports secure connections over the Secure Socker Layer (SSL) directly. It is recommented to run elog only through secure HTTPS connections if passwords are used. Otherwise the passwords are send over the network in clear text and exposed to sniffing attacks . To use SSL, put SSL = 1 into the config file. If the URL = directive is used, make sure to use https://... instead of http://... there. The ELOG distribution contains a simple self-signed certificate in the **ssl** subdirectory. One can replace this certificate and key with a real ceritficate to avoid browser pop-up windows warning about the self-signed certificate. `","title":"Using elogd itself"},{"location":"adminguide/#using-apache","text":"Another possibility is to use the Apache web server as a proxy server allowing secure connections. To do so, Apache has to be configured accordingly and a certificate has to be generated. See some instructions on how to create a certificate, and see Running elogd under Apache before on this page on how to run elogd under Apache. Once configured correctly, elogd can be accessed via http://your.host and via https://your.host simultaneously. The redirection statement has to be changed to Redirect permanent /elog https://your.host.domain/elog/ ProxyPass /elog/ http://your.host.domain:8080/ and following has to be added to the section \"VirtualHOst ...:443 in /etc/httpd/conf.d/ssl.conf: # Proxy setup for Elog Order deny,allow Allow from all ProxyPass /elog/ http://host.where.elogd.is.running:8080/ ProxyPassReverse /elog/ http://host.where.elogd.is.running:8080/ Then, following URL statement has to be written to elogd.cfg: URL = https://your.host.domain/elog There is a more detailed step-by-step instructions at the contributions section .","title":"Using Apache"},{"location":"adminguide/#using-ssh","text":"elogd can be accessed through a a SSH tunnel. To do so, open an SSH tunnel like: ssh -L 1234:your.server.name:8080 your.server.name This opens a secure tunnel from your local host, port 1234, to the server host where the elogd daemon is running on port 8080. Now you can access http://localhost:1234 from your browser and reach elogd in a secure way.","title":"Using ssh"},{"location":"adminguide/#how-it-all-works","text":"For the technically curious: The concept of ELOG is very simple. The logbook functionality is implemented by a single daemon program, elogd , which is written in C. It contains an integrated Web server, which does not serve files like standard Web servers, but 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 (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 (main body text or attribute), it gets converted automatically in order not to invalidate the database structure. If attachments are submitted, they are saved as separate files named YYMMDD_HHMMSS_name - where in addition to the date the time is specified and name is the original file name of the attachment. To copy the database to another computer, only the *.log files and the attachment files need to be copied. To copy for example all files from March 2001, just select them with 0103??a.log and 0103??_* .","title":"How It All Works"},{"location":"config/","text":"ELOG - Syntax of elogd.cfg Global and individual logbook options for an ELOG server The configuration file elogd.cfg contains entries which define the structure of logbooks and the behaviour of elogd . The file has a simple ASCII format. Each logbook is defined by a [] section where is the name of the logbook. The [global] section is used for settings common to all logbooks. Each line contains a setting name, followed by an equal sign and the value for this setting. Lines starting with \";\" are treated as comments. Here is a simple example, which define two logbooks, \" Linux \" and \" PC \": [global] SMTP host = mailsend.your.domain [Linux] Theme = default Comment = General linux tips and tricks Attributes = Author, Type, Category, Subject Options Type = Routine, Software Installation, Problem Fixed, Configuration, Other Options Category = General, Hardware, Software, Network, Account, Other Options Author = Stefan, Linus, unknown Required Attributes = Author [PC] Comment = Database PC installations Attributes = Location, OS, Owner Options Location = Building1, Building2 Options OS = Linux, Windows ME, Windows 2000 Required Attributes = Location, Owner Email All = name@address, othername@otheraddress Use Mail Subject = Location Global options 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 = Specifies the TCP port under which the server is listening. Default is 80. Can be superseeded via the '-p' command line flag. SSL = <0 | 1> Turn on Secure Socket Layer transport. If SSL is on, one can connect via https://... to the elogd daemon. If the URL = directive is used, make sure to use https://... instead of http://... there. The ELOG distribution contains a simple self-signed certificate in the ssl subdirectory. One can replace this certificate and key with a real ceritficate to avoid browser pop-up windows warning about the self-signed certificate. The default for this option is 0 . Interface = Specified network interface to listen at. Can be used if several network cards are in a computer, or if one wants to restrict access to the local host only, in which case one can use 127.0.0.1 as the interface. Resource dir = Specifies the root directory for ELOG resources like help files, themes and icons. Can be overwritten with the -s flag when starting elogd. If not specified, use the directory where the configuration file elogd.cfg resides. Changing this option requires a restart of the elogd server . Logbook dir = 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. Changing this option requires a restart of the elogd server . This directory also contains any password file and user HTML file. Language = The language setting determines the language of the elogd output. Not affected by this setting are the configuration file options and the commands specified with the optional Menu commands and List menu commands , which have to be specified in English and are translated automatically by elogd. The attribute names are unaffected by the language setting and have to be translated manually. If a language name is given (currently \" german \", \" french \", \" spanish \", \" dutch \", \" brazilian \" are supported out-of-the-box), the system searches for a file named eloglang. containing string translations from English into that language. If you create a new translation file, please send it back to the author to be included in future distributions .\\ \\ The online help for elogd is contained in the file eloghelp_ xx .html where 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. charset = Specifies the charset of the pages produced by elogd . Can be used to switch to Russian or Asian fonts. Logbook Tabs = [0|1] This flag controls the display of \" tabs \" on top of the logbook page which allow to quickly switch between logbooks. Default is 1 Main Tab = If this option is present, an additional first tab is displayed which takes you back to the main logbook selection page. The string is used for the contents of the tab. Main Tab URL = Normally the main tab brings one back to the logbook selection page. In case one wants to specify a different destination, such as a special web page outside of elog, one can use this statement to specify a full URL. Welcome Title = This optional HTML code gets displayed in the title of the logbook selection page. It can contain images via ![](\"welcome.gif\")
. These images must be stored in the resource directory or in the theme directory. The following line is an example Welcome Title: Welcome title = ![](\"welcome.jpg\")
Welcome to our Elog This displays an image and a text below. Page title = The string specified here is used for the title of individual logbook pages. It is also used by most browsers for bookmark names. can contain substitutions like \\$ where gets replaced by the attribute string from each message. The option Page title in the [global] section is used for the logbook selection page. List page title = The same for the summary or find result page. This may include substitutions as well, although attribute substitutions make no sense here, since the summary page may contain many messages with different attributes. Selection page = When this option is present, a user defined file is displayed instead of the logbook 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). It can be completely customized in order to contain logos etc. As a template, the standard selection page produced by elogd can be used. Guest Selection page = The same for installations which have a global password file. This means that the logbook selection page is also password protected. It might be however that some logbooks have guest access, in which case guest access to the selection page should be allowed as well (maybe with only a subset of the available logbooks). In that case this options can be used, to show a list of logbooks with guest access. Protect Selection page = 0 | 1 Normally, one can see the logbook selection page without having to log in. If one wants to require a login for the selection page, this switch can be set to 1 . Default is 0 . It is necessary to put the Password file = ... into the [global] section of the config file for this to work. Expand Selection page = 0 | 1 ' If this option is not present or set to one, the logbook selection page is expanded (all logbooks are shown if groups of logbooks are present). If this option is zero, only the group names are displayed. If one clicks on a group, its logbooks are shown. Using this option set to zero only makes sense if one has a large number of logbooks which would not fit on a single browser window, so collapsing makes sense. Default is 1 . SMTP host = This defines the SMTP host needed to send automatic email notifications. The host name you can get from your email program or your local system administrator. SMTP username = Some SMTP server require username/passowrd authentication. This option specifies the SMTP user name, while the option SMTP password can be created or modified via the -t switch when starting elogd. This is necessary since the password is encrypted. To set your SMPT password, enter on the command line: elogd -t SMTP port = This defines the port under which the SMTP server is listening. The default is 25, but some newer servers use port 587. Logfile = This option specifies a filename which logs all login/logout activities and successful user connections for logbooks with user level access. The the logging level (see below) is larger than 1, also read and write accesses can be logged. Logging level = 1 | 2 | 3 Specifies the logging level. The higher this value, the more information is logged. Default is 2 : 1: Log only logins and logouts 2: Log also write accesses 3: Log also read accesses URL = If one of the three cases is true: elogd runs with SSL enabled elogd runs under a proxy The automatic email notifications contains the wrong URL then the URL under which elogd is running has to be specified manually with this statement. The URL has to contain the port number if not the standard port 80 is used or 433 for SSL, and it has to contain the directory if used under a proxy like URL Condition URL = http://host.domain:8080/ if running on port 8080 URL = https://host.domain/ if SSL is enabled (SSL = 1) URL = http://host.domain/subdir/ if running under a proxy This URL is then used for any redirection. For example if one submits a new entry, the URL in the browser reads .../?cmd=Submit&... , containing all the attributes etc. After the submit this page gets redirected to .../ , where is the ID of the new entry. For the redirection via the HTTP \"Location:\" statement, an absolute URL is required. Since elogd cannot figure out the complete URL under which it is running when accessed through an Apache proxy, this statement is necessary to tell elogd the complete URL. Relative redirection = 0|1 Under some circumstances, absolute redirection via a complete URL may not work. If you access elogd through two different ways simulataneously, for example directly and via a stunnel connection, a single absolute URL cannot be used, because one connection starts with http:// , and the other with https:// . Another case is when the elogd server has a dynamic IP address, which changes from time to time. Setting Relative redirection = 1 , relative redirection is used. This uses the current URL from the browser, whatever it is, and only specifies the last part of the URL. It should noted however that relative redirections are not allowed in the HTTP standard, but most browsers support it anyhow. Problems have been reported with the Safari browser. So this option should only be used when it is really needed. Usr = Grp = The user and group to run the elogd daemon under when started by root. Resolve host names = 0|1 Resolve remote host names if set to 1 . If set to 0 , which is the default, only IP numbers are stored in any log file. If the hosts allow/deny options are used with host names, this setting must be set to 1 . If turned on, the DNS server is contacted on each HTTP request to elog, which can slow down the server considerably for slow DNS servers. Groups of logbooks If installations have very many logbooks, it can be hard to navigate between them. To make things more structured, it is possible to build a hierarchy of logbooks. A logbook group can contain any number of logbooks as well as other logbook groups. The hierarchy is defined with the the option Group = , , in the [global] section of the configuration file. To define following logbook hierarchy: one would use following statements: [global] Group Linux PCs = Red Hat, Debian, Mandrake Group Windows PCs = 98, ME, NT, XP, CE Group CE = 1.0, 2.0 The logbook tabs would then look like this: Where the selected group or logbook becomes blue. The lower groups/logbooks change according to the selected upper group. Please note that a logbook can be contained in more than one group, but then it should not be the first logbook in those groups. The colors of the tabs and the title bar can be specified in the CSS file. Top groups Sometimes groups of logbooks should be completely separate. Imagine two groups of logbooks, one for the engineering department and one for the administration department. These groups should have different administrators, and the logbook tabs at the top of the screen should not show the logbooks from the other department. Prior to ELOG version 2.4.1, one had to run two elogd servers in parallel, listening under different ports. Since 2.4.1, one can achieve the same behaviour using Top groups . The configuration could look like this: Group Linux PCs = Red Hat, Debian, Mandrake Group Windows PCs = 98, ME, NT, XP, CE Group CE = 1.0, 2.UL Top group engineering = Linux PCs, Windows PCs Top group administration = Employees, Purchases [global engineering] Password file = engineers.pwd Admin user = stefan [global administration] Password file = admin.pwd Admin user = bill Note that there can be a [global] section for each top level group of logbooks. The rule is that a configuration setting in an individual logbook section overrides a setting in the [global ] setting, which by itsel overrides a setting in the [global] section. This way one can define settings for all top level groups (such as the SMTP host) in the [global] section, and define different password files and administrators in the individual top level group sections. If top groups are used, the root of the elogd server is not accessible any more. Presume that elogd is accessible normally under http://your.host:8080/ , this URL becomes invalid for top groups, to avoid the case that one group can \"see\" the logbooks of the other groups. Instead, one has to append the top group name to the URL, such as http://your.host:8080/engineering or http://your.host:8080/administration . If someone does not know the top group name, one cannot see the list of logbooks there, so the groups become completely independent of each other. If this feature is not wanted, it can be disabled by setting Show top groups = 1 . Individual logbook options For each logbook, there is a section with the logbook name in square brackets, so that each logbook can have different options. If an option is not present in a logbook section, then the system tries to locate that option in the [global] section. Thus if the following options are placed in the [global] section, they are defaults for all logbooks. If they are present in the [global] and in the logbook section, the logbook option is used. Here are the available options, by broad categories: General options Data dir = This option is obsolete from version 2.2.5 on and should not be used. Use Subdir = ... instead. Subdir = 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. 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 Logbook dir = ... option is not specified, then logbooks is used. If the subdirectory starts with a \"/\" (\"\\\" under Windows), then it is used as an absolute path independent of the logbook dir. To see which directories are used, start elogd with the \"-v\" flag. Comment = The comment is displayed on the logbook selection list. The selection list is displayed if more than one logbook is defined on a host and no logbook is explicitly specified in the URL. Theme = 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 \"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. CSS = A given theme can contain several Cascading Style Sheets (CSS). This can be usefule if several logbooks use the same images and icons, but differnt colors. By default, the CSS elog.css is used. This statement adds an additional CSS, which can overwrite settings from elog.css . If different CSS'es should be used for different output media, this can be accomplished with a comma- separated list in the form CSS = &,& . This will then be translated into separate style sheet statements for the different media. For example a statement CSS = default.css&screen,print.css&print will result in the HTML statements: Title image = HTML code for the icon in the upper right corner. By default, following code is used: ![\"ELOG](\"elog.gif\")
This code can be replaced by to display a different icon file, or to display some text. The icon image has to be present in the theme directory, which is usually /themes/default . Title image URL = The ELOG icon at the right upper corner usually points to the ELOG home page. This URL can be changed to point to a corporate page for example with this option. The icon can be changed by replacing the elog.gif icon in the theme directory. This option should only be used if the Title image option is not used. Time format = This option determines how the date and time of a logbook entry is displayed. The format of the string is the same as the C function strftime , so a string of %A, %B %d, %Y, %H:%M yields in a display of Thursday, November 15, 2001, 12:35 for example. Time format = Same, but just for an individual attribute. Date format = This option determines how the date is displayed from attributes which are of type \"date\". The format of the string is the same as the C function strftime , so a string of %A, %B %d, %Y yields in a display of Thursday, November 15, 2001 for example. Date format = Same, but just for an individual attribute. Welcome Page = By default, the list with the last twenty entries of a logbook is displayed when the logbook is selected. This can be overridden with this option, which causes a HTML file to be shown instead of the message list. This file can contain further links for new logbook messages of for logbook queries. Here is a simple example of such a file: Welcome to the test logbook
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). Start page = This option can be used to display a different start page. command can be either 0?cmd=Last to display the last message, or any other ELog menu command in the form ?cmd=xxx . To start with the search page, one uses Start page = ?cmd=Find Please note that if another language than English is selected via the Language = xxx option, the commands have to be in that language as well (like \"Start page = 0?cmd=Letzter\" for German). Submit Page = This optional page can be displayed when a new message was submitted in a logbook. Here is an example: You successfully submitted a message
Back to the logbook Enter another message The file must be present in the logbook directory. Alternatively, an absolute path can be used if the file name starts with a \"/\" (Unix) or \"\" or \"x:\" (Windows). Message 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 :\". Reply comment = This optional comment is displayed on top of the text entry field when replying to an exiting entry. It can contain a sentence like \" Please enter your reply here :\". Attachment comment = This optional comment is displayed on top of the attachment sumbission section when entering a new message. It can contain a sentence like \" Please upload your attachments here :\". Menu commands = This option specifies the menu commands displayed on top of a single logbook page. For certain installations, it can be useful to disable some commands. Following commands are possible: New - Enter new logbook entry Edit - Edit current logbook entry Delete - Delete current logbook entry Reply - Submit a reply to current entry Duplicate - Duplicate the current entry with the possibility to change some values Download - Download a message in ASCII format Find - Search entries in logbooks Last day - Display entries from last day Move to - Move entry to other logbook Copy to - Copy entry to other logbook Config - Edit elogd.cfg (if no \" Password file \" is given) Config - Modify/Add user accounts (if \" Password file \" is given) Admin - Edit elogd.cfg (if \" Password file \" is given) Login - Login with user name and password (if \" Password file \" is given) Import - Show CSV (comma-separated-values) import page Logout - Logout current user (if \" Password file \" is given) Help - General help The commands are always in English, independent of the language = ... setting, and are automatically translated into the specified language. If this option is not present, following default is used: Menu commands = List, New, Edit, Delete, Reply, Duplicate, Find, Config, Help Copy to = Move to = The commands Copy to and Move to make it possible to copy or move a logbook entry from one logbook to another. By default, all logbooks except the current logbook are shown as a possible destination. With the configurations options Copy to = and Move to = it is possible to specify a list of destination logbooks, separated by commata. This can make sense if only certain logbooks make sense as destinations. The flag Preserve IDs can be used to keep the entry ID in the destination logbook. List Menu commands = This option specifies the menu commands displayed on top of the listing page. Although all commands from a above are possible, only the commands New, Find, Select, Import, Config, Admin, Change password, Logout and Help make sense. The command Select can be used to select multiple messages for deletion or for moving to other logbooks. Once the Select command is clicked, check boxes appear in front of all entries which let the user select one or more entries. A new menu bar shows up with a Delete and optionally a Coyp to ... and Move to ... button, if these commands are present in the Menu commands list. Pressing one of these buttons deletes, copies or moves all selected logbook entries. Guest Menu commands = This option specifies the menu commands for guest logins. A guest login happens if a password file is used, but someone accesses the logbook for the first time, which means that no username/password is given. In that case the commands from the guest menu are displayed, which usually contain a subset of the normal commands. A typical scenario is a logbook which only has commands to read the logbook on the guest menu, but no commands to write/edit entries. Instead, the login command is given in the guest menu, with which one can login as a real user (username and password have to match those from the password file), which then allowes full access via the \"Menu commands\" list. A typical example for the menu settings for this scenario are: Menu commands = List, New, Edit, Reply, Duplicate, Find, Config, Logout, Help Guest menu commands = List, Find, Login, Help Note that the presence of this option opens user access also to the find result or elog listing page, which usually contains some config command. So it is useful to combine the Guest menu commands option with the following Guest List Menu commands option to restrict the access to the find result page as well. Guest List Menu commands = Same as Guest Menu commands but for the find result page. Menu text = If this option is present, and additional menu row above the message gets displayed with the contents of . This file can contain arbitrary text, images or links. One example would be following text to go back to the listing page and display the next Routine entry and all Routine entries: Next Routine entry | All Routine entries List Menu text = The same for the list page. Filter Menu text = The same for the filter line in the list page. Guest Display = This option specifies which attributes are displayed on guest access. It is possible to display only a subset of all attributes for guest access, but the full list if someone is logged in (using the option \"Password file\"). The list consists of comma separated attributes, including the word text , if one wants to display the entry body text for guests. Summary | Full | Threaded | Top text = | The text of this option gets displayed at the top of every Elog page. It can be a string or a filename which gets displayed. Might be useful to display company logos etc. If a file is specified, it must be present in the logbook directory. Alternatively, an absolute path can be used if the file name starts with a \"/\" (Unix) or \"\" or \"x:\" (Windows). Bottom text = | The text of this option gets displayed at the bottom of every Elog page instead of the little Elog home page link. It can be a string or a file. It can contain for example a link back to the main logbook selection page like: Main page Or it can contain other useful links. If a file is specified, it must be present in the logbook directory. Alternatively, an absolute path can be used if the file name starts with a \"/\" (Unix) or \"\" or \"x:\" (Windows). Bottom text login = | The same as Bottom text but for the login page. This allows to display a different text at the bottom of the login page. It can also be used to execute some JavaScript. Help 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 resource directory. 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.). If both Message Width and Message Height are not given, some JavaScript code is used which automatically resizes the message window dynamically to fit optimally into the browser window. Message Height = This value sets the number of lines of the main message entry field. The default value is 20, and can be changed for installations which need a different window size. If both Message Width and Message Height are not given, some JavaScript code is used which automatically resizes the message window dynamically to fit optimally into the browser window. Admin textarea = , This defines the textarea size for the admin page. Default is 80,40 . Display mode = [full|summary|threaded] Default mode for search display. On the find entry form, the checkboxes are set accordingly. The \"Last xxx\" page uses this setting directly. Entries per page = Number of logbook entries displayed per page in a search result. The default is 20. Restrict edit time = If this option is set, a new message can only be edited a certain number of hours after its creation. This can be useful if one wants to ensure that old entries cannot be modified. Hours can also be fractional, like 0.5 for 30 min. Admin restrict edit time = Same option for admin users. This can be useful if normal users are not allowed to change entries after \"restrict edit time\", but an admin user should be allowed to do so. Setting this to zero disables any restriction for admin users and they can edit entries forever. Max content length = This option restricts the size of attachments. When very large (>100MB) attachments are uploaded, the elogd server can be busy with this upload for a longer time and not respond to other requests during that time. To avoid this, the maximum size of attachments can be restricted. The server will then refuse to accept larger attachments. The default is 10485760 (= 10 MB). This option has to be placed into the [global] section and the elogd server has to be restarted after a change. Fonts = List of fonts (comma separated) to be shown in the font drop-down box of the entry edit form. Default is Fonts = Arial, Comic Sans MS, Courier New, Tahoma, Times New Roman, Verdana On Unix systems some of these fonts might not be installed, in which case they can be replaced by others like Serif , Sans-serif , Helvetica . All display limit = If a logbook contains many entries, the list gets divided into pages, with some page navigation for the next, previous, a specific page and all pages. If the logbook contains a large number of entries (>500), the display of all thes entries can take very long and might slow down the elogd server, especially if the entries are not displayed in \"summary\" mode but in \"full\" mode. Therefore the \"All\" link should not be used in the page navigation for large logbooks. The number of entries from when on the \"All\" link gets hidden can be specified with this number, the default value is 500 . Thumbnail size = This option determines the default thumbnail size. To make the automatic generation of thumbnails working, the ImageMagick package has to be installed. Refer to the admin guide for installation instructions. The thumbnail size size gets passed to the -thumbnail option of the conversion. A value of 300 converts all pictures to thumbnails 300 pixels wide. A value of 300> converts all pictures to thumbnails 300 pixels wide if they are larger than 300 pixels initially, and leaves them untouched if they are smaller. A value of 10% converts all pictures to 10% of their original size. If the thumbnail size option is missing, the thumbnails will be created with the original image size, and can then be resized and rotated interactively with the image manipulation buttons: Setting Thumbnail size = 0 turns off the thumbnail creation. Thumbnail options = With this option one can pass additional parameters to the ImageMagick package. They are passes 1:1 to the convert program. Commonly used is the -density option to increase the image quality when converting from PDF or EPS files. Attributes Attributes = Define a number of attributes for the logbook, separated by commata. A maximum of 100 attributes can be defined. Typical values are \" Author \", \" Subject \" or \" Type \". Following values are not allowed: Text Date Encoding Reply to In reply to Locked by Attachment Path since these are used internally by elog. Options = 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. To add an option including a comma, encose it in quotations marks like Options town = San Francisco, \"Paris, Texas\", \"Paris, France\" Extendable options = When using the Options to specify a list of possible options, this list is fixed. Sometimes it is desirable to extend the list when a new entry in a logbook is made and a certain option is missing on the list. By adding the attribute name to the Extandable options list, a button appears next to the attribute in the message entry form which lets you add new options to the list. The elogd.cfg configuration file is then automatically updated. When a new logbook entry gets made, the new option automatically appears in the drop-down box for that attribute. ROptions = Same as Options above, but using radio buttons instead of a drop-down box. MOptions = This list allows for \" Multiple Options \", meaning that an attribute can have several values simultaneously. When entering an entry with MOptions, each value from the list is represented by a checkbox. Unlike with normal options, multiple checkboxes can be checked for an entry. The attribue value then becomes | | ... In the \" find \" page only one of these values can be specified, which is then treated as a substring in the search filter. IOptions = This list specifies a set of icons for an attribute. Some icons are contained in the themes/default/icons directory which can be used here like Attributes = Author, Icon, Subject... IOptions Icon = icon1.gif, icon2.gif, icon3.gif, ... New icons are welcome and should be sent back to the author to be incorporated in the next version. Comment = Optional comment which is displayed below the attribute name in the entry form. Can be used to explain the attribute somehow. Tooltip = Same as Comment , except that the comment gets displayed as a tooltip (tiny pup-up window) when the user moves the mouse cursor over the attribute name in the entry form. Tooltip = Same as Tooltip , but for option values of a MOptions attribute. Using this option, a different tooltip can be shown above each check box of an optional value for an attribute. Please note that attributes or options with spaces should not be enclosed with quotes. Icon comment = Icons may contain a comment, which is then used in email notifications instead of the icon file name. One has to add a separate icon comment for each icon file. Options = boolean If an attribute is marked \" boolean \" this way, a checkbox is displayed for this attribute. Preset = This option uses a preset string for an attribute. The string can contain subsitutions like the ones described under the \" Subst \" command. One possible application is to use the login name for the author field like: Preset Author = $long_name If the attribute should be locked at the Web submission, use the \" Locked Attributes = ... \" option. If a preset value is given for an attribute which has an options list, the preset value is selected in the drop down box by default. Preset text = or This preset value is used for the main body text. It can be a string or a file, which must be present in the logbook directory. Alternatively, an absolute path can be used if the file name starts with a \"/\" (Unix) or \"\" or \"x:\" (Windows). Preset on edit = Same as Preset , but evaluated when editing existing entries. Preset on reply = Same as Preset , but evaluated for replies. Preset on first reply = While Preset on reply , is evaluated for any replies, this one is only executed for the first reply to an entry. It can be useful for example to so do something like this: Preset on first reply Subject = Re: $Subject So the \"Re:\" only gets added once, and you don't get long chains of \"Re: Re: Re: ....\". Preset on duplicate = Same as Preset , but evaluated for duplicted entries. Locked Attributes = The attributes specified here cannot be modified when a new entry is submitted. This makes only sense for preset attributes. Fixed Attributes Edit = The attributes specified here cannot be modified when an existing entry is modified via the Edit button. This feature can be useful to preserve the original author of the message, when using the Preset Author = $long_name option as described above. Fixed Attributes Reply = The attributes specified here cannot be modified when an existing entry is replied on via the Reply button. This feature can be useful to preserve the original subject of a message for example. Required Attributes = The attributes specified here are required when a new entry is submitted. The attribute names are marked with * on the entry form. Show Attributes = Attributes present in this list are shown in the single entry page. Omitting attributes can make sense for attributes which are automatically derived from other attributes via the Change command. Show Attributes Edit = The same as Show Attributes , but for the entry form. Propagate Attributes = With this option, changed in an attribute are autmatically propagated to all entries of a thread. This can be useful if one has an attribute \"problem status\" for example with the options \"open\", \"under investigation\", \"fixed\". A thread related to a specific problem can then have several replies. If the problem gets fixed, a new reply can be made with the attribute \"problem status\" being \"fixed\", and then the propagation causes all entries of this thread to become \"fixed\". Page title = The string specified here is used for the title of the web page. It is also used by most browsers for bookmark names. The string can contain substitutions as described unter the \" Subst \" option. Edit Page title = The string specified here is used for the title of the entry form. It is also used by most browsers for bookmark names. The string can contain substitutions as described unter the \" Subst \" option. List display = Specified the display and order of items in a message listing page or a search result page. In addition to all attributes, following items can be specified: ID for the entry ID Date for the entry date/time Edit to display a column with an edit icon to directly edit and entry Delete to display a column with a delete icon to directly delete and entry 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\\ List display = ID, Date, 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. If a search goes over \"all logbooks\", an additional colums with the logbook name of each entry is added in front. Guest List display = Same as List display , but for guest access (user level access with password, but not logged in). Please see also Guest display . In addition to List display , one can optionally specify Text as an attribute here. Without that attribute, the summary text of the entry body is not shown. This makes it possible to show the text for registered users and hide it for guest access. Link display = Normally, each column in the display list contains a link to the individual entry. If this is not desired, the list of attributes with links can be restricted to only a subset with this option. Thread display = Optional way to specify the line contents in the threaded search result. Following substitutions are possible: $**: The value of the attribute $logbook**: The name of the current logbook $entry time : The message date and time, formatted via \" Time format \" $message id**: The message ID A typical example would be Thread display = $subject, posted by $author on $entry time Thread icon = If a logbook uses some icons for an attribute, these icons can be displayed in the search result page instead of the default icons contained in the themes directory. RSS Title = ELOG supports so-called RSS feeds . Once can subscribe to new logbook entries with RSS readers such as Mozilla Firefox. Once new entries are submitted to the logbook, the become visible in the subscripition. By default, all attributes of the last 15 logbook entries are used as the RSS title. With this option once can changed this behaviour. Following substitutions are possible: $**: The value of the attribute $logbook**: The name of the current logbook $entry time : The message date and time, formatted via \" Time format \" $message id**: The message ID A typical example would be\\ RSS Title = $subject, posted by $author on $entry time RSS Entries = Number of entries to be shown in the RSS feed. Default is 15. Subst = When submitting logbook entries, attribute values can be substituted by some text. This text can contain arbitrary fixed text and following values: $**: The entered value of the attribute itself $host : The host name where elogd ** is running $remote_host**: The host name of the host from with the entry was submitted $short_name**: The login name (if password file is present) $long_name**: The full name from the password file for the current user $user_email**: The email address from the password file for the current user $logbook**: The name of the current logbook $date : The current date, formatted via \" Date format \" $utcdate : The current UTC date (GMT) and time, formatted via \" Date format \" $version**: The version of the ELOG server in the form x.y.z $revision**: The Subversion reversion of the ELOG server as an integer number $shell()**: gets passed to the operating system shell and the result is taken for substitution. Following example use this feature to add the remote host name to the author:\\ Subst Author = $author from $remote_host Following example substitutes an attribute with the contents of a file: Subst Info = $shell(cat /tmp/filename) (Unix) Subst Info = $shell(type c:\\tmp\\filename) (Windows) A special option are automatically generated tags, which are automatically incremented for each new message. This is achieved by putting #'s into the substitution string, which is used as a placeholder for the incrementing index. Each \"#\" stands for one digit, thus the statement Subst Number = XYZ-##### results in automatically created attributes \"Number\" of the form XYZ-00001 XYZ-00002 XYZ-00003 and so on. In addition to the #'s one may specify format specifiers which are passed to the strftime function. This allows to create tags wich contain the current year, month and so on. Once the date part of the attribute changes, the index restarts from one. The statement `Subst Number = XYZ-%Y-%b-### results in automatically created attributes \"Number\" of the form XYZ-2005-Oct-001 XYZ-2005-Oct-002 XYZ-2005-Oct-003 and XYZ-2005-Nov-001 XYZ-2005-Nov-002 on the next month. Remove on reply = This option clears one or more (separated by commata) attribute values from a logbook entry when creating a reply to that entry. This can make sense for example for the author, since the author of a reply can be different from the original author. Quote on reply = 0 | 1 This flag controls if the original text is quoted in a reply. Default is 1 Reply string = String used to mark original message lines. Default is \"> \" . Can be empty string (\"\") if no message marking is desired. Subst on reply = Substitution of attributes for replies. This option can be used to replace the current subject with a \"Re: \":\\ Subst on reply subject = Re: $subject Note that this option works only for the first reply. So a reply-to-a-reply would still have Re: and not Re: Re: . If you want the substitution for all replies, please use Preset on reply instead. Subst on edit = Substitution of attributes for edited messages. This option can be used to replace the author by the current author for example:\\ Subst on edit author = $full_name Quick filter = Specifies list of comma separated attributes for which a drop-down filter is displayed in the search result page. By selecting a value from that drop-down box, only entries with that value are displayed. In addition to all attributes defined in the Attributes = list, the attribute Date and the option Subtext can be listed here. Using the Date filter, the last day, week, month and so on can be displayed. The Subtext filter works on the entry body text. Last default = Some logbooks are very big and searching through all entries with a quick filter can be time consuming. This option sets a default value for the Date quick filter, so that by default only the last days are displayed. has to match one of the entries of the data quick filter options, which are 1, 3, 7, 31, 92, 182, 364. Format = ,,,, Optional formatting parameters for attributes. Following items can be defined in the comma-separated list: Values used for single message display page: ** Sum of following flags: 1 : Display attribute in same line as previous attribute 2 : Display radio buttons or check boxes in separate lines (if applicable) , Cascading Style Sheet class names used for cells containing attribute name or value, respectively. The classes must be defined in the style sheet file (usually themes/default/default.css ). Values used for new message entry form: ** Width of the text entry field in characters ** Maximum number of characters allowed. Default is \"0, attribname, attribvalue, 80, 500\" . Trailing parameters can be ommitted, so specifying for example only the flags is possible. Type = date | datetime | numeric | userlist | useremail | muserlist | museremail A normal attribute can contain strings of any type. With this option, attributes can be forced to be numeric or to be a date/time, or to consist of a list of all users from the password file. When new logbook entries are made, numeric attributes are checked to contain only digits. Note that JavaScript has to be enabled to do this. Attributes of type date are treated as a date. Their format for display can be controlled by the Date format option. Upon entry, drop-down boxes are displayed which let the user select the day, month and year. Alternatively, a pop-up date picker using a calendar can be displayed if JavaScript is enabled. Date attributes are saved internally as seconds since 1.1.1970, and can therefore be sorted propoerly by clicking on the header of a logbook entry list. On the find page, dates can be searched for via a start and end date. If date attributes are used in a quick filter (see above), a drop-down quick filter box is displayed which lets the user select \"last day\", \"last week\", \"next week\", and so on. The datetime type combines a date and time in HH:MM. The output of this combination is controlled by the Time format option. If the attribute type is userlist , a drop-down box is displayed which contains all user names from the current password file. This can be useful for example in a bug tracking system, where a new entry gets assigned to an individual. The type useremail is similar, just a list of email addresses of all registered users. This can be used to send email notification to assigned people by using this attribute in an Email all = statement. The type muserlist and museremail are the same that userlist and useremail , except that several user names or user emails can be selected at once using check boxes. Style