Commit 84c3cea2 authored by Stephane Glondu's avatar Stephane Glondu
Browse files

Minor changes in documentation

parent 3483e7ea
...@@ -33,7 +33,7 @@ dependencies of Belenios, everything into a single directory. You can ...@@ -33,7 +33,7 @@ dependencies of Belenios, everything into a single directory. You can
chose the directory by setting the `BELENIOS_SYSROOT` environment chose the directory by setting the `BELENIOS_SYSROOT` environment
variable, or it will take `~/.belenios` by default. Just run: variable, or it will take `~/.belenios` by default. Just run:
./opam-boostap.sh ./opam-bootstrap.sh
On a modern desktop system, this needs approximately 10 minutes and 1 On a modern desktop system, this needs approximately 10 minutes and 1
gigabyte of disk space. gigabyte of disk space.
...@@ -43,7 +43,8 @@ update your shell environment, then run: ...@@ -43,7 +43,8 @@ update your shell environment, then run:
make all make all
and you can skip the next two sections. and you can skip the next two sections and go directly to the
_Documentation_ section.
If you are familiar with OCaml, please read the `opam-bootstrap.sh` If you are familiar with OCaml, please read the `opam-bootstrap.sh`
shell script, or the following two sections to compile Belenios with shell script, or the following two sections to compile Belenios with
......
...@@ -84,9 +84,9 @@ To generate the credentials, run: ...@@ -84,9 +84,9 @@ To generate the credentials, run:
where `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` is the UUID of the where `XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` is the UUID of the
election given by the administrator, and `N` the number of credentials election given by the administrator, and `N` the number of credentials
to generate. It will generate two files, `TTTTTTTTTT.public` and to generate. It will generate two files, `TTTTTTTTTT.public` and
`TTTTTTTTTT.private`, each with `N` lines. Send the public file as a `TTTTTTTTTT.private` (where `TTTTTTTTTT` is a timestamp), each with
whole to the administator, and each line of the private file to each `N` lines. Send the public file as a whole to the administator, and
voter. each line of the private file to each voter.
You can optionally add a `--dir` option to specify the directory where You can optionally add a `--dir` option to specify the directory where
these files will be written. these files will be written.
...@@ -215,18 +215,28 @@ In the following, we assume `ocsigenserver` is properly configured. ...@@ -215,18 +215,28 @@ In the following, we assume `ocsigenserver` is properly configured.
4. Go to Belenios source tree (we assume its full path is 4. Go to Belenios source tree (we assume its full path is
`$BELENIOS`). `$BELENIOS`).
5. Edit `demo/template.ml` with the election parameters, and run 5. Edit `demo/template.ml` with the election parameters, and run
`make all`. `make all`. In particular, you should edit:
* the UUID
* questions and answers
* dates of the voting period
6. Go to `$DIR`. 6. Go to `$DIR`.
7. Concatenate all trustee public keys into a `public_keys.jsons` 7. Concatenate all trustee public keys into a `public_keys.jsons`
file, and run `$BELENIOS/_build/demo/template.native`. It should file, and run `$BELENIOS/_build/demo/template.byte`. It should
generate `election.json` and `metadata.json`. The `ydump` tool generate `election.json` and `metadata.json`. The `ydump` tool
(from Yojson) can be used to pretty-print them. (from Yojson) can be used to pretty-print them.
8. (Optionally) Edit `election.json` and `metadata.json` to your 8. (Optionally) Edit `election.json` and `metadata.json` to your
convenience. convenience.
9. Save the file with public credentials generated by the credential 9. Save the file with public credentials generated by the credential
authority into `public_creds.txt`. authority into `public_creds.txt`.
10. Adapt `demo/ocsigenserver.conf.in` if needed. 10. Go to `$BELENIOS`.
11. Run `demo/run-server.sh`. 11. Edit `demo/ocsigenserver.conf.in`, in particular:
* the admin password
* the UUID of the main election
* the data directory (see above)
12. Run `demo/run-server.sh`. This script is a wrapper around
`ocsigenserver` and takes the same options. In particular, the
`-V` option is useful for debugging and `--help` can be used to
get help.
### Update a credential ### Update a credential
......
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