aboutsummaryrefslogtreecommitdiff
path: root/src/mailman_pgp/config
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman_pgp/config')
-rw-r--r--src/mailman_pgp/config/mailman.cfg13
-rw-r--r--src/mailman_pgp/config/mailman_pgp.cfg7
2 files changed, 16 insertions, 4 deletions
diff --git a/src/mailman_pgp/config/mailman.cfg b/src/mailman_pgp/config/mailman.cfg
index 24dc3bc..b2adfe8 100644
--- a/src/mailman_pgp/config/mailman.cfg
+++ b/src/mailman_pgp/config/mailman.cfg
@@ -15,19 +15,30 @@
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
-# Example additions to mailman.cfg to enable PGP
+# Example additions to mailman.cfg to enable mailman-pgp.
+# Setup the mailman-pgp plugin under the `pgp` name. To use the django-pgpmailman
+# web UI. The `MAILMAN_PGP_PLUGIN_NAME` in its project settings.py must be set
+# to the name of the plugin, as thats where Mailman roots the plugins REST api
+# endpoint.
[plugin.pgp]
class: mailman_pgp.plugin.PGPMailman
path: mailman_pgp
enable: yes
configuration: python:mailman_pgp.config.mailman_pgp
+# Use the custom PGP enabled deliver callable, performs the signing and encryption
+# on PGP enabled lists which are configured to do so.
[mta]
outgoing: mailman_pgp.mta.deliver.deliver
+# Use the custom PGP enabled runner on the default `in` queue.
[runner.in]
class: mailman_pgp.runners.incoming.PGPIncomingRunner
+# This runners name needs to be the same as the `[queues].in` config option in
+# the mailman-pgp config file. It runs the default IncomingRunner on a queue
+# of a different name, so that messages come into the mailman-pgp incoming runner
+# and can be then passed to the default incoming runner, defined here.
[runner.in_default]
class: mailman.runners.incoming.IncomingRunner
diff --git a/src/mailman_pgp/config/mailman_pgp.cfg b/src/mailman_pgp/config/mailman_pgp.cfg
index 4c52e10..5db31dd 100644
--- a/src/mailman_pgp/config/mailman_pgp.cfg
+++ b/src/mailman_pgp/config/mailman_pgp.cfg
@@ -75,11 +75,12 @@ shred: yes
# similar.
shred_command:
-# Delete list keypair on list deletion?
+# Delete list keypair on list deletion.
delete: yes
[queues]
-# The queue to which processed incoming messages are passed.
+# The queue to which processed incoming messages are passed. Must be a name of
+# a queue which is managed by the Mailman IncomingRunner.
in: in_default
@@ -94,7 +95,7 @@ change_request_lifetime: 1d
# to export the list private key.
allow_read_private_key: yes
-# Allow the modification of a list private key through the REST API?
+# Allow the modification of a list private key through the REST API.
# This is necessary for the django-pgpmailman web ui to allow a list owner
# to change the list private key.
allow_write_private_key: yes