Commit 11df675c authored by Stephane Glondu's avatar Stephane Glondu
Browse files

More documentation of ocsigen config

parent 5f55354a
......@@ -131,17 +131,38 @@ from the compiled source tree.
Here is an excerpt of the sample configuration file:
<eliom module="_build/src/web/server.cma">
<enable-dummy/>
<source file="../belenios.tar.gz"/>
<main-election uuid="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"/>
<admin hash="XXX"/>
<log file="_RUNDIR_/log/security.log"/>
<data dir="tests/data"/>
<data dir="demo/data"/>
</eliom>
The `admin` tag indicates the SHA256 of the admin password.
The `<enable-dummy>` tag enables the dummy authentication method,
which just asks for a name. No security is intended. This is useful
for debugging or demonstration purposes but obviously not suitable for
production. This is the only authentication method supported at the
moment.
The `log` tag indicates a file where some security-sentive events will
be logged. The `data` tag indicates a directory with election
data. This directory must contain one subdirectory per election, and
in each of these directories, the following files are expected:
The `<source>` tag gives the path of the source tarball. Note that this
is a path on the local filesystem and not a URL. If you made local
changes, an easy way to comply with the AGPL license is to commit them
in a local git checkout, and put in the `source` tag the path to the
tarball generated by `make archive`.
If the `<main-election>` tag is present, the home page will be a
redirection to the referenced election, and not a mere listing of open
elections. This is useful if there is a single election.
The `<admin>` tag indicates the SHA256 of the admin password.
The `<log>` tag indicates a file where some security-sentive events will
be logged. It is optional.
The `<data>` tag indicates a directory with election data. This
directory must contain one subdirectory per election, and in each of
these directories, the following files are expected:
* `election.json`: election parameters
* `metadata.json`: additional parameters that are not published
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment