restructure schleuder doc page authored by Jérôme Charaoui's avatar Jérôme Charaoui
Also adds a fix for schleuder-cli config
# Schleuder # Schleuder
Schleuder is a gpg-enabled mailing list manager with resending-capabilities. Subscribers can communicate encrypted (and pseudonymously) among themselves, receive emails from non-subscribers and send emails to non-subscribers via the list.
For more details see https://schleuder.nadir.org/docs/.
Schleuder runs on [Eugeni](https://db.torproject.org/machines.cgi?host=eugeni). The version of Schleuder currently installed is: 3.1.2
## Using Schleuder ## Using Schleuder
Schleuder has it's own gpg key, and also it's own keyring that you can use if you are subscribed to the list. Schleuder has it's own gpg key, and also it's own keyring that you can use if you are subscribed to the list.
...@@ -36,19 +42,29 @@ And then: ...@@ -36,19 +42,29 @@ And then:
X-LIST-NAME: listname@withtheemail.org X-LIST-NAME: listname@withtheemail.org
X-GET-KEY: someone@important.org X-GET-KEY: someone@important.org
## Administration ## Administration of lists
Schleuder is a gpg-enabled mailing list manager with resending-capabilities. Subscribers can communicate encrypted (and pseudonymously) among themselves, receive emails from non-subscribers and send emails to non-subscribers via the list.
For more details see https://schleuder.nadir.org/docs/. ### Pre-requisites
Schleuder runs on [Eugeni](https://db.torproject.org/machines.cgi?host=eugeni). The version of Schleuder currently installed is: 3.1.2 #### schleuder-api-daemon
Mailing lists are managed through schleuder-cli which needs schleuder-api-daemon running. If the daemon is not running you can start it with: Mailing lists are managed through schleuder-cli which needs schleuder-api-daemon running. If the daemon is not running you can start it with:
SCHLEUDER_CONFIG="/srv/schleuder.torproject.org/data/schleuder.yml" schleuder-api-daemon SCHLEUDER_CONFIG="/srv/schleuder.torproject.org/data/schleuder.yml" schleuder-api-daemon
Lists also need to be setup in postfix in order to forward to Schleuder. #### schleuder-cli
The program `schleuder-cli` program expects to find a configuration file in `$HOME/.schleuder-cli/schleuder-cli.yml`.
If it's absent, the following error may appear:
Error: 'tls_fingerprint' is empty but required (in /root/.schleuder-cli/schleuder-cli.yml).
The workaround for this problem is to simply tell the program to look elsewhere for that file:
export SCHLEUDER_CLI_CONFIG="/srv/schleuder.torproject.org/home/.schleuder-cli/schleuder-cli.yml"
### List creation
To create a list you can: To create a list you can:
...@@ -60,10 +76,14 @@ To export a list public key you can do the following: ...@@ -60,10 +76,14 @@ To export a list public key you can do the following:
schleuder-cli keys export secret-team@lists.torproject.org <list-key-fingerprint> schleuder-cli keys export secret-team@lists.torproject.org <list-key-fingerprint>
### Subscriptions management
Subscription are managed with the subscriptions command. To subscribe a new user to a list do: Subscription are managed with the subscriptions command. To subscribe a new user to a list do:
schleuder-cli subscriptions new secret-team@lists.torproject.org person@torproject.org <fingerprint> /path/to/public.key schleuder-cli subscriptions new secret-team@lists.torproject.org person@torproject.org <fingerprint> /path/to/public.key
### Other commands
All the other commands are available by typing: All the other commands are available by typing:
schleuder-cli help schleuder-cli help
... ...
......