aboutsummaryrefslogtreecommitdiff
path: root/docs/install.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/install.rst')
-rw-r--r--docs/install.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..152c92d
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,12 @@
+============
+Installation
+============
+
+Mailman-pgp currently depends on a development version of both `Mailman <https://gitlab.com/mailman/mailman>`_ and `PGPy <https://github.com/SecurityInnovation/PGPy>`_.
+However, the required changes are slowly getting merged into both. Until they are fully merged, doing::
+
+ pip install mailman-pgp
+
+pulls in those development versions from `J08nY/mailman/plugin <https://gitlab.com/J08nY/mailman/tree/plugin>`_, `J08nY/PGPy/dev <https://github.com/J08nY/PGPy/tree/dev>`_.
+
+See :doc:`config` for configuration which enables the mailman-pgp plugin after installation. \ No newline at end of file