Release v0.1.2

CHANGELOG.md

@@ -1,5 +1,19 @@
 # MultiSchleuder Changelog
 
+<!-- BEGIN RELEASE v0.1.2 -->
+## Version 0.1.2
+
+Documentation & Bugfix release
+
+### Changes
+
+<!-- BEGIN CHANGES 0.1.2 -->
+- Commented config file
+- Fix a typo in the Debian systemd service
+<!-- END CHANGES 0.1.2 -->
+
+<!-- END RELEASE v0.1.2 -->
+
 <!-- BEGIN RELEASE v0.1.1 -->
 ## Version 0.1.1
 

multischleuder/__init__.py

@@ -1,2 +1,2 @@
 
-__version__ = '0.1.1'
+__version__ = '0.1.2'

package/debian/multischleuder/etc/multischleuder/multischleuder.yml

@@ -1,31 +1,60 @@
 ---
 
+# Configure this to talk to your schleuder-api-daemon.
 api:
   url: "https://localhost:4443"
-  token: "putAschleuderApiTokenHere"
+  token: "130a8c095d14fa51e73727e9d8ef5db3a3bf0cae7d995c1f"
   cafile: /etc/multischleuder/schleuder-ca.pem
 
 lists: []
 
+#    # The Schleuder list to manage.  Must exist
 #  - target: global@schleuder.example.org
 #    unmanaged:
+#      # Adresses to ignore everywhere.  Usually you want to
+#      # put the admins of your target Schleuder here, in order
+#      # to prevent them from becoming unsubscribed.
 #      - admin@example.org
 #    banned:
+#      # If for some reason, you need to ban a subscriber from the
+#      # target list only, put them here
 #      - banned@example.org
 #    sources:
+#      # The Schleuder lists to take subscribers and keys from.
+#      # They must already exist.
 #      - east@schleuder.example.org
 #      - west@schleuder.example.org
 #      - north@schleuder.example.org
 #      - south@schleuder.example.org
+#    # When sending mails, use this as the sender address.  If absent,
+#    # the -owner address is used.
 #    from: global-owner@schleuder.example.org
+#    # Whether to notify subscribers of key or email address conflicts.
+#    send_conflict_messages: yes
+#    # Whether to notify the target Schleuder's admins about changes.
+#    send_admin_reports: yes
 
+# Hook this up to your MTA, 
 smtp:
-  hostname: localhost
-  port: 8025
+  hostname: localhost  # default: localhost
+  port: 10025  # default: 25
+  tls: PLAIN  # PLAIN|STARTTLS|SMTPS; default: PLAIN
+  username: admin     # optional
+  password: password  # optional
 
 conflict:
+  # How often to notify users about conflicts
   interval: 604800  # 1 week
+  # The file where Schleuder memorizes when it has last sent messages for
+  # which conflicts
   statefile: /var/lib/multischleuder/conflict.json
+  # The template used when sending mails to a subscriber involved in a key conflict
+  # (multiple keys used by the same subscriber).  You can use the following fields:
+  #   {subscriber}:  Email address of the affected subscriber
+  #   {schleuder}:   Name (email) of the target Schleuder
+  #   {chosen}:      The key that was chosen to subscribe to the target Schleuder
+  #   {affected}:    A list of "fingerprint: source schleuder" candidates involved
+  #                  in the conflict.
   key_template: |
     Hi {subscriber},
     
@@ -53,6 +82,14 @@ conflict:
   
     Regards
     MultiSchleuder {schleuder}
+  # The template used when sending mails to subscribers involved in a user conflict
+  # (multiple subscribers using the same key).  You can use the following fields:
+  #   {subscriber}:  Email address of the subscriber addressed in this email
+  #   {fingerprint}: Fingerprint of the key used multiple times
+  #   {schleuder}:   Name (email) of the target Schleuder
+  #   {chosen}:      The email that was chosen to subscribe to the target Schleuder
+  #   {affected}:    A list of "email address: source schleuder" candidates involved
+  #                  in the conflict.
   user_template: |
     Hi {subscriber},