systemli.schleuder

ansible-role-schleuder

安装和维护一个 schleuder 服务及其 schleuder 列表。

ansible 运行期间安装了什么？

此角色将默认设置 schleuder， schleuder-cli， schleuder-web。

Web 界面可以通过 localhost:3000 访问，你可以使用 schleuder 的默认凭据登录（"root@localhost" - "slingit!"）。

此外，你还可以安装 schleuder-gitlab-ticketing-plugin，并将你的 schleuder 列表连接到一个 gitlab 实例。为此，你需要在变量文件中设置 schleuder_install_gitlab_ticket_plugin: True。

还需要什么？

你需要在运行 schleuder 的服务器上设置和安装一个邮件传输代理。另外，你需要有一个运行中的 Web 服务器，并且有一个 vhost 指向你的 schleuder-web 界面及其端口。

请参考 schleuder 文档获取更多信息。

新列表/list 管理员如何管理他们的列表？

如果列表管理员的公钥存在，此角色/schleuder 将通知你有关列表创建的信息。

schleuder 列表管理员可以通过 Web 界面登录请求他们的密码，列表创建后即可访问。

角色变量

### 定义应运行哪些剧本：
schleuder_install_web: True
schleuder_install_cli: True
schleuder_install_gitlab_ticket_plugin: False

### 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]
  #  # 确保将列表管理员的公钥复制到
  #  # files/schleuder/adminkeys/{{ name }}_{{ admin }}.pub
  #  # 否则将 admin_pubkey_present 设置为 false
  #  # ---
  #  send_list_key: True
  #  present: True
  #  # ---
  #  admin_pubkey_present: True
  #  # 如果 admin_pubkey_present 设置为 false
  #  schleuder 列表将被创建，但无法使用

### 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"
# 设置为 false 将使 rails 服务器仅监听 localhost
schleuder_schleuder_web_allow_access_from_outside: True

### 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

### schleuder-cli 变量：
schleuder_cli_path: "/root/.schleuder-cli"

###### 文件部分

### 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
  # 使用的证书和密钥。你可以通过 `schleuder cert generate` 创建新的。
  tls_cert_file: "/etc/schleuder/schleuder-certificate.pem"
  tls_key_file: "/etc/schleuder/schleuder-private-key.pem"

# 允许访问 API 的 api_keys 列表。
# 示例：
# 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
# 可用语言：en, de.
schleuder_language: en
schleuder_forward_all_incoming_to_admins: "false"

### schleuder-web/database.yml
# schleuder-web 使用自己的数据库来存储用户凭据
schleuder_web_database:
  production:
    adapter: "'sqlite3'"
    database: "db/production.sqlite"
    pool: 5
    timeout: 5000

### schleuder/gitlab.yml
# 全局设置
schleuder_gitlab_default_subject_filters: []
schleuder_gitlab_default_sender_filters: []
schleuder_gitlab_default_gitlab_connection: {}

# 每个列表的设置
# 参见 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'

下载

使用 ansible-galaxy 下载最新版本

ansible-galaxy install systemli.schleuder

示例 Playbook

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

扩展变量示例

schleuder_lists:
  - name: [email protected]
    admin: [email protected]
    # 公钥必须在 
    # files/adminkeys/{{ name }}_{{ admin }}.pub 中
  - name: [email protected]
    admin: [email protected]
    admin_pubkey_present: False
    send_list_key: False
    # 公钥未放置到服务器
    # 列表已创建但不功能
    # 列表密钥未发送给订阅者
  - name: [email protected]
    admin: [email protected]
    state: absent
    # 列表将在下次 ansible 运行时删除         


# 每个列表的 gitlab 设置
# 参见 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'