Commit cf6fe577 authored by georg's avatar georg

Add docs for schleuder version 3.3

Closes #36
Closes #43
parent 4d5967a2
Pipeline #20351 passed with stages
in 1 minute and 23 seconds
---
title: Changes from Schleuder 3.1 to 3.2
title: Changes from Schleuder 3.2 to 3.3
---
{: .note}
This list describes changes that users or list-admins of Schleuder should be aware of. For a more technical changelog, please see the [repository](https://0xacab.org/schleuder/schleuder).
User-relevant changes in version 3.2 compared to version 3.1:
* To improve consistency with the English language, `X-LISTNAME` has been renamed to `X-LIST-NAME`. `X-LISTNAME` still works, but will be deprecated, therefore please use `X-LIST-NAME` from now on.
* Lists can have an internal-footer now. It's appended to each message sent to a subscriber (if it's not blank).
* New keywords: `X-RESEND-UNENCRYPTED` and `X-RESEND-CC-UNENCRYPTED`. With them you can enforce that resent-email will be sent in the clear, regardless of whether we would find a key for the recipient or not.
* The short representation of GnuPG keys became more human-friendly. Besides the fingerprint we now show the email-address of the first UID, the generation-date, and (if present) the expiration-date.
* The resend-keywords now check the given arguments to be valid email-addresses, and block resending if any one is found invalid.
* `X-LIST-KEYS` does not require an argument anymore.
* `X-SUBSCRIBE` now handles the combination of space-separated fingerprint and additional arguments (admin-flag, delivery-enabled-flag) correctly.
* `X-RESEND` now respects the encoding the mail was sent with.
* Fixed broken encoding of certain character-sequences in encrypted+signed messages.
User-relevant changes in version 3.3 compared to version 3.2:
* Handle missing arguments for several keywords and reply with a helpful error-message.
* Send replies to keyword-usage and notices to admins regardless of the delivery-flag of their subscription.
* `X-UNSUBSCRIBE` will refuse to unsubscribe the last admin of a list.
* Handle "protected subjects" in a way that Thunderbird/Enigmail recognize.
* `X-SET-FINGERPRINT` will not anymore allow setting an empty fingerprint.
* To remove a fingerprint from a subscription one can use the new keyword `X-UNSET-FINGERPRINT`.
* The output of the keywords `X-ADD-KEY` and `X-DELETE-KEY` now also show the "oneline"-format to represent keys.
* In the response to `X-ADD-KEY`, differentiate between "newly imported" and "updated" keys.
* Parse keywords up to the first line detected as mail content.
* Extend the pseudoheaders configuration option to support `sig` and `enc` as configurable and sortable fields.
{% include feedback.md %}
......@@ -2,7 +2,7 @@
title: Concept
---
{% include docs-head.md version=3.2 %}
{% include docs-head.md version=3.3 %}
Schleuder is a gpg-enabled mailing list manager with resending capabilities. This document tries to explain what that means.
......
......@@ -2,7 +2,7 @@
title: Documentation for list-admins
---
{% include docs-head.md version=3.2 %}
{% include docs-head.md version=3.3 %}
{% include_relative _list_usage_basics.md %}
......@@ -18,14 +18,16 @@ x-subscribe: person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
: Subscribe the given address and assign it the given OpenPGP-fingerprint.
x-unsubscribe: person@example.org
: Unsubscribe the given address.
: Unsubscribe the given address. It is not possible to unsubscribe the last admin of a list.
x-set-fingerprint: 0x12345678DEADBEEF12345678DEADBEEF12345678
: Assign the key with the given fingerprint to your subscription.
: Assign the key with the given fingerprint to your subscription. It is not possible to set an empty fingerprint. To unset a fingerprint use `x-unset-fingerprint`.
x-set-fingerprint: person@example.org 0x12345678DEADBEEF12345678DEADBEEF12345678
: Assign the key with the given fingerprint to the given subscription. This variant of this command may only be used by list-admins.
: Assign the key with the given fingerprint to the given subscription. This variant of this command may only be used by list-admins. To unset a fingerprint use `x-unset-fingerprint`.
x-unset-fingerprint: person@example.org
: Remove the fingerprint associated with a given subscription.
x-list-keys
: Lists all public keys known to the list. To see only keys that match a given string, use `x-list-keys: something`.
......
......@@ -2,7 +2,7 @@
title: Documentation for server-admins
---
{% include docs-head.md version=3.2 %}
{% include docs-head.md version=3.3 %}
## Setup Schleuder
......
......@@ -2,7 +2,7 @@
title: Documentation for subscribers
---
{% include docs-head.md version=3.2 %}
{% include docs-head.md version=3.3 %}
{% include_relative _list_usage_basics.md %}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment