ansible-role-schleuder

This role helps you install and manage a schleuder service and its mailing lists.

What does the Ansible role install?

By default, this role installs:

• schleuder
• schleuder-cli
• schleuder-web

You can access the web interface at localhost:3000 and log in using the default credentials ("root@localhost" - "slingit!").

You can also add the schleuder-gitlab-ticketing-plugin to connect your schleuder lists to a GitLab instance. To do this, set schleuder_install_gitlab_ticket_plugin: True in your variables file.

Additional Requirements

You must set up a mail transport on the server running schleuder. Additionally, you need a working web server that points to your schleuder-web interface and its port.

For further information, refer to the schleuder documentation.

How do new list admins manage their lists?

If a list admin's public key is available, this role will notify you about the list creation. Admins can request their password by logging into the web interface after their list is created.

Role Variables

Playbook configuration:

schleuder_install_web: True
schleuder_install_cli: True
schleuder_install_gitlab_ticket_plugin: False

Schleuder variables:

schleuder_schleuder_user: "schleuder"
schleuder_gpg_use_tor: True
schleuder_gpg_tor_keyserver: "hkp://zkaan2xfbuxia2wpf7ofnkbz6r5zdbbvxbunvp5g2iebopbfc4iqmbad.onion"
schleuder_admin_keys_path: "/var/lib/schleuder/adminkeys"

schleuder_lists: []
  #- name: [email protected]
  #  admin: [email protected]
  #  ...

Web interface variables:

schleuder_schleuder_web_repo: https://0xacab.org/schleuder/schleuder-web
schleuder_schleuder_web_home: "/var/www/schleuder-web"
# Other configuration options...

Downloading the Role

To install the latest release, use ansible-galaxy:

ansible-galaxy install systemli.schleuder

Example Playbook

- hosts: servers
  roles:
     - { role: systemli.schleuder }

Testing & Development

To test and develop the role, use GitHub Actions, Molecule, and Vagrant. You can run local tests with:

molecule test 

This will set up a virtual machine with Debian Bookworm. You can then access the Schleuder web interface at:

http://localhost:3000

License

GPLv3

Author Information

For more info, visit systemli.org