systemli.schleuder

ansible-role-schleuder

Instaluj i utrzymuj usługę schleuder oraz jej listy schleuder.

Co jest instalowane podczas uruchamiania ansible?

Ta rola skonfiguruje schleuder, schleuder-cli oraz schleuder-web domyślnie.

Interfejs webowy jest dostępny pod adresem localhost:3000, a logowanie można przeprowadzić przy użyciu domyślnych danych logowania schleuder ("root@localhost" - "slingit!").

Dodatkowo można zainstalować plugin do zgłaszania biletów gitlab dla schleuder oraz powiązać swoje listy schleuder z instancją gitlab. W tym celu w pliku zmiennych należy ustawić schleuder_install_gitlab_ticket_plugin: True.

Co jeszcze jest potrzebne?

Należy skonfigurować i zainstalować transport pocztowy na serwerze, na którym działa schleuder. Dodatkowo musisz mieć działający serwer webowy z vhost wskazującym na interfejs schleuder-web i jego port.

Proszę zapoznać się z dokumentacją schleuder po dodatkowe informacje.

Jak nowi administratorzy list mogą zarządzać swoimi listami?

Jeśli klucz publiczny administratora listy jest dostępny, ta rola/schleuder powiadomi cię o utworzeniu listy.

Administratorzy list schleuder mogą zażądać swojego hasła, logując się przez interfejs webowy, po utworzeniu swojej listy.

Zmienne Roli

### Określ, które playbooki mają być uruchamiane:
schleuder_install_web: True
schleuder_install_cli: True
schleuder_install_gitlab_ticket_plugin: False

### zmienne schleuder:
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]
  #  # upewnij się, że skopiujesz klucz publiczny administratora listy do
  #  # files/schleuder/adminkeys/{{ name }}_{{ admin }}.pub
  #  # w przeciwnym razie ustaw admin_pubkey_present na false
  #  # ---
  #  send_list_key: True
  #  present: True
  #  # ---
  #  admin_pubkey_present: True
  #  # jeśli admin_pubkey_present jest ustawione na false
  #  schleuder lista zostanie utworzona, ale nie będzie działać

### zmienne schleuder-web:
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"
# ustawienie na false sprawi, że serwer rails będzie słuchał tylko na localhost
schleuder_schleuder_web_allow_access_from_outside: True

### zmienne schleuder-gitlab-ticketing-plugin:
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

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

###### Sekcja Plików

### 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
  # Certyfikat i klucz do użycia. Możesz stworzyć nowe za pomocą `schleuder cert generate`.
  tls_cert_file: "/etc/schleuder/schleuder-certificate.pem"
  tls_key_file: "/etc/schleuder/schleuder-private-key.pem"

# Lista api_keys, które pozwalają na dostęp do API.
# Przykład:
# 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
# Dostępne: en, de.
schleuder_language: en
schleuder_forward_all_incoming_to_admins: "false"

### schleuder-web/database.yml
# schleuder-web używa swojej własnej bazy danych do przechowywania danych logowania użytkowników
schleuder_web_database:
  production:
    adapter: "'sqlite3'"
    database: "db/production.sqlite"
    pool: 5
    timeout: 5000

### schleuder/gitlab.yml
# globalne ustawienia
schleuder_gitlab_default_subject_filters: []
schleuder_gitlab_default_sender_filters: []
schleuder_gitlab_default_gitlab_connection: {}

# ustawienia per lista
# zobacz 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'

Pobieranie

Pobierz najnowszą wersję za pomocą ansible-galaxy

ansible-galaxy install systemli.schleuder

Przykład Playbook

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

Przykład Rozszerzonych Zmiennych

schleuder_lists:
  - name: [email protected]
    admin: [email protected]
    # klucz publiczny musi być w 
    # files/adminkeys/{{ name }}_{{ admin }}.pub
  - name: [email protected]
    admin: [email protected]
    admin_pubkey_present: False
    send_list_key: False
    # klucz publiczny nie jest umieszczany na serwerze
    # lista jest tworzona, ale nie działa
    # list_key nie jest wysyłany do subskrybentów
  - name: [email protected]
    admin: [email protected]
    state: absent
    # lista zostanie usunięta przy następnym uruchomieniu ansible         

# ustawienia gitlab per lista
# zobacz 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'

Testowanie i Rozwój

Testy

Do rozwijania i testowania roli używamy Github Actions, Molecule i Vagrant. W lokalnym środowisku można łatwo przetestować rolę za pomocą

Uruchom lokalne testy:

molecule test

Wymaga zainstalowania Molecule, Vagrant i python-vagrant. Do rozwijania i testowania roli używamy Travis CI, Molecule i Vagrant. W lokalnym środowisku można łatwo przetestować rolę za pomocą

To uruchomi maszynę wirtualną z Debian Bookworm. Następnie możesz połączyć się z interfejsem webowym Schleuder pod adresem: