document torschleuder account usage for schleuder-cli authored by Jérôme Charaoui's avatar Jérôme Charaoui
Also, the daemon is configured to start automatically so there should be
no need to launch it manually.
......@@ -44,35 +44,33 @@ And then:
### Pre-requisites
#### schleuder-api-daemon
#### 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.
SCHLEUDER_CONFIG="/srv/schleuder.torproject.org/data/schleuder.yml" schleuder-api-daemon
The daemon is configured to start automatically, but you can verify it's running using systemctl:
#### schleuder-cli
sudo systemctl status schleuder-api-daemon
The program `schleuder-cli` program expects to find a configuration file in `$HOME/.schleuder-cli/schleuder-cli.yml`.
#### Permissions
If it's absent, the following error may appear:
The `schleuder-cli` program should be executed in the context of the `torschleuder` user account:
Error: 'tls_fingerprint' is empty but required (in /root/.schleuder-cli/schleuder-cli.yml).
sudo -u torchleuder schleuder-cli
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"
For this to work, your user account must be a member of the `torschleuder` group.
### List creation
To create a list you can:
schleuder-cli lists new secret-team@lists.torproject.org admin@torproject.org /path/to/public.key
sudo -u torschleuder schleuder-cli lists new secret-team@lists.torproject.org admin@torproject.org /path/to/public.key
Schleuder will create the list gpg key together with the list. Please not that the created keys do not expires. For more information about how Schlueder creates keys you can check: https://0xacab.org/schleuder/schleuder/blob/master/lib/schleuder/list_builder.rb#L120
To export a list public key you can do the following:
schleuder-cli keys export secret-team@lists.torproject.org <list-key-fingerprint>
sudo -u torschleuder schleuder-cli keys export secret-team@lists.torproject.org <list-key-fingerprint>
### Subscriptions management
......@@ -80,15 +78,15 @@ 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
sudo -u torschleuder schleuder-cli subscriptions new secret-team@lists.torproject.org person@torproject.org <fingerprint> /path/to/public.key
To list current list subscribers:
schleuder-cli subscriptions list secret-team@lists.torproject.org
sudo -u torschleuder schleuder-cli subscriptions list secret-team@lists.torproject.org
To designate (or undesignate) a list admin:
schleuder-cli subscriptions set secret-team@lists.torproject.org person@torproject.org admin true
sudo -u torschleuder schleuder-cli subscriptions set secret-team@lists.torproject.org person@torproject.org admin true
Lists can also be administered via email commands sent to `secret-team-request@lists.torproject.org` (list name followed by `-request`).
......@@ -98,5 +96,5 @@ Available commands are described in the [Schleuder documentation for list-admins
All the other commands are available by typing:
schleuder-cli help
sudo -u torschleuder schleuder-cli help