systemli.schleuder

ansible-role-schleuder

Installieren und verwalten Sie einen schleuder Dienst und dessen Schleuder-Listen.

Was wird während des Ansible-Laufs installiert?

Dieses Modul richtet standardmäßig schleuder, schleuder-cli und schleuder-web ein.

Die Weboberfläche ist über localhost:3000 erreichbar und Sie können sich mit den Standardanmeldeinformationen von Schleuder einloggen ("root@localhost" - "slingit!").

Zusätzlich können Sie das schleuder-gitlab-ticketing-plugin installieren und Ihre Schleuder-Listen an eine GitLab-Instanz anbinden. Dazu müssen Sie in Ihrer Variablendatei schleuder_install_gitlab_ticket_plugin: True setzen.

Was wird noch benötigt?

Sie müssen einen Mail-Transport auf dem Server einrichten, auf dem Schleuder ausgeführt wird. Außerdem benötigen Sie einen laufenden Webserver mit einem virtuellen Host, der auf Ihre schleuder-web-Schnittstelle und deren Port zeigt.

Bitte konsultieren Sie die Schleuder-Dokumentation für weitere Informationen.

Wie können neue Listen/List-Administratoren ihre Listen verwalten?

Wenn ein öffentlicher Schlüssel des List-Administrators vorhanden ist, wird dieses Modul/Schleuder Sie über die Erstellung der Liste informieren.

Schleuder-Listen-Administratoren können ihr Passwort anfordern, indem sie sich über die Weboberfläche einloggen, nachdem ihre Liste erstellt wurde.

Rollenv Variablen

### Definieren Sie, welche Playbooks ausgeführt werden sollen:
schleuder_install_web: True
schleuder_install_cli: True
schleuder_install_gitlab_ticket_plugin: False

### Schleuder-Variablen:
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]
  #  # Stellen Sie sicher, dass der öffentliche Schlüssel des Listenadministrators in
  #  # files/schleuder/adminkeys/{{ name }}_{{ admin }}.pub kopiert wird
  #  # andernfalls setzen Sie admin_pubkey_present auf false
  #  # ---
  #  send_list_key: True
  #  present: True
  #  # ---
  #  admin_pubkey_present: True
  #  # Wenn admin_pubkey_present auf false gesetzt ist,
  #  # wird die schleuder-Liste erstellt, ist jedoch nicht funktionsfähig

### schleuder-web-Variablen:
schleuder_schleuder_web_repo: https://0xacab.org/schleuder/schleuder-web
schleuder_schleuder_web_home: "/var/www/schleuder-web"
schleuder_schleuder_web_user: schleuder-web
schleuder_schleuder_web_path: "{{ schleuder_schleuder_web_home }}/schleuder-web"
schleuder_schleuder_web_git_update: False
schleuder_schleuder_web_systemd_path: "/etc/systemd/system/schleuder-web.service"
schleuder_schleuder_web_environment_vars_path: "/etc/default/schleuder-web"
# false setzen lässt den Rails-Server nur auf localhost hören
schleuder_schleuder_web_allow_access_from_outside: True

### schleuder-gitlab-ticketing-plugin-Variablen:
schleuder_gitlab_plugin_repo: https://0xacab.org/schleuder/schleuder-gitlab-ticketing
schleuder_gitlab_plugin_path: "/opt/local/gitlab-ticketing"
schleuder_gitlab_plugin_git_update: False

### schleuder-cli-Variablen:
schleuder_cli_path: "/root/.schleuder-cli"

###### Datei Abschnitt

### schleuder/schleuder.yml.j2
schleuder_lists_dir: "/var/lib/schleuder/lists"
schleuder_listlogs_dir: "/var/lib/schleuder/lists"
schleuder_plugins_dir: "/etc/schleuder/plugins"
schleuder_filters_dir: "/usr/local/lib/schleuder/filters"
schleuder_log_level: "warn"
schleuder_keyserver: "hkps://keys.openpgp.org"
schleuder_superadmin: "root@localhost"
schleuder_smtp_settings:
  address: localhost
  port: 25
  #domain:
  #enable_starttls_auto:
  #openssl_verify_mode:
  #authentication:
  #user_name:
  #password:
schleuder_database:
  production:
    adapter: "'sqlite3'"
    database: "/var/lib/schleuder/db.sqlite"
    pool: 5
    timeout: 5000
schleuder_api:
  host: localhost
  port: 4443
  # Zertifikat und Schlüssel, die verwendet werden sollen. Sie können neue mit `schleuder cert generate` erstellen.
  tls_cert_file: "/etc/schleuder/schleuder-certificate.pem"
  tls_key_file: "/etc/schleuder/schleuder-private-key.pem"

# Liste der api_keys, die den Zugriff auf die API erlauben.
# Beispiel:
# valid_api_keys:
#   - abcdef...
#   - zyxwvu...
schleuder_valid_api_keys: []

### schleuder/list-defaults.yml.j2
schleuder_send_encrypted_only: "true"
schleuder_receive_encrypted_only: "true"
schleuder_receive_signed_only: "false"
schleuder_receive_authenticated_only: "false"
schleuder_receive_from_subscribed_emailaddresses_only: "true"
schleuder_receive_admin_only: "false"
schleuder_headers_to_meta:
  - from
  - to
  - cc
  - date
  - sig
  - enc
schleuder_keep_msgid: "true"
schleuder_keywords_admin_only:
  - subscribe
  - unsubscribe
  - delete-key
schleuder_keywords_admin_notify:
  - add-key
schleuder_internal_footer: ""
schleuder_public_footer: ""
schleuder_subject_prefix: ""
schleuder_subject_prefix_in: ""
schleuder_subject_prefix_out: ""
schleuder_bounces_drop_all: "false"
schleuder_bounces_drop_on_headers:
  x-spam-flag: "yes"
schleuder_bounces_notify_admins: "true"
schleuder_include_list_headers: "true"
schleuder_include_openpgp_header: "true"
schleuder_openpgp_header_preference: signencrypt
schleuder_max_message_size_kb: 10240
schleuder_lists_log_level: warn
schleuder_logfiles_to_keep: 2
# Verfügbar: en, de.
schleuder_language: en
schleuder_forward_all_incoming_to_admins: "false"

### schleuder-web/database.yml
# schleuder-web verwendet eine eigene Datenbank zur Speicherung der Benutzeranmeldeinformationen
schleuder_web_database:
  production:
    adapter: "'sqlite3'"
    database: "db/production.sqlite"
    pool: 5
    timeout: 5000

### schleuder/gitlab.yml
# globale Einstellungen
schleuder_gitlab_default_subject_filters: []
schleuder_gitlab_default_sender_filters: []
schleuder_gitlab_default_gitlab_connection: {}

# Einstellungen pro Liste
# siehe https://0xacab.org/schleuder/schleuder-gitlab-ticketing
schleuder_gitlab_lists: []
#  - [email protected]:
#      project: tickets
#      namespace: support
#      subject_filters:
#        - 'ignore me'
#  - [email protected]:
#      gitlab:
#        endpoint: https://gitlab2.example.com/api/v4
#        token: aaaa
#      sender_filters:
#        - 'noreply@example\.com'

Herunterladen

Laden Sie die neueste Version mit ansible-galaxy herunter.

ansible-galaxy install systemli.schleuder

Beispiel Playbook

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

Erweitertes Variablenbeispiel

schleuder_lists:
  - name: [email protected]
    admin: [email protected]
    # Öffentlicher Schlüssel muss in 
    # files/adminkeys/{{ name }}_{{ admin }}.pub sein
  - name: [email protected]
    admin: [email protected]
    admin_pubkey_present: False
    send_list_key: False
    # Öffentlicher Schlüssel wird nicht auf den Server gelegt
    # Liste wird erstellt, ist aber nicht funktionsfähig
    # list_key wird nicht an Abonnenten gesendet
  - name: [email protected]
    admin: [email protected]
    state: absent
    # Liste wird im nächsten Ansible-Lauf gelöscht           


# GitLab-Einstellungen pro Liste
# siehe https://0xacab.org/schleuder/schleuder-gitlab-ticketing
schleuder_gitlab_lists:
  - [email protected] 
      project: tickets
      namespace: support
      subject_filters:
        - 'ignore me'
  - [email protected]:
      gitlab:
        endpoint: https://gitlab2.example.com/api/v4
        token: 1234aaaa1234
      sender_filters:
        - 'noreply@example\.com'

Testen & Entwicklung

Tests

Zur Entwicklung und zum Testen des Moduls verwenden wir Github Actions, Molecule und Vagrant. In der lokalen Umgebung können Sie das Modul einfach testen mit:

Führen Sie lokale Tests aus:

molecule test

Benötigt Molecule, Vagrant und python-vagrant, um installiert zu sein. Für Entwicklung und Tests verwenden wir auch Travis CI, Molecule und Vagrant. In der lokalen Umgebung können Sie das Modul einfach testen mit:

Dies wird eine virtuelle Maschine mit Debian Bookworm hochfahren. Danach können Sie auf die Schleuder-Weboberfläche zugreifen über: