From 60624b9113ab55d493ea3560f0350f686be2676c Mon Sep 17 00:00:00 2001 From: J08nY Date: Tue, 22 Aug 2017 00:01:47 +0200 Subject: Add docs and Sphinx conf.py. --- README.md | 47 ++--------------------------------------------- 1 file changed, 2 insertions(+), 45 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7369cf0..de8ddf7 100644 --- a/README.md +++ b/README.md @@ -9,55 +9,12 @@ Simply install into the same environment as Mailman Core and follow configuratio ``` pip install mailman-pgp ``` +For more, see [install.rst](docs/install.rst) ## Configuration See [mailman.cfg](src/mailman_pgp/config/mailman.cfg) for example configuration which enables the mailman-pgp plugin in Mailman Core and sets up the plugin configuration to the example [mailman_pgp.cfg](src/mailman_pgp/config/mailman_pgp.cfg). - -```ini -[db] -# db path the PGP plugin will use to store list/user configuration (not keys!). -url = sqlite:////$DATA_DIR/pgp.db - - -[keydirs] -# Key directory used to store user public keys. -user_keydir = $DATA_DIR/pgp/user_keydir/ - -# Key directory used to store list keypairs. -list_keydir = $DATA_DIR/pgp/list_keydir/ - -# Key directory used to store archive public keys. -archive_keydir = $DATA_DIR/pgp/archive_keydir/ - - -[keypairs] -# Whether to autogenerate the list key on list creation. -autogenerate = yes - -# Type of primary list key and its size. -# Format: type:size -# type is one of: -# RSA, DSA, ECDSA. -# size is the key size or curve name for ECDSA, which can be one of: -# nistp256, nistp384, nistp521, brainpoolP256r1, brainpoolP384r1, -# brainpoolP512r1, secp256k1 -primary_key = RSA:4096 - -# Type of list encryption subkey and its size. -# Format: type:size -# type is one of: -# RSA, ECDH -# size is the key size or curve name for ECDH, which can be one of: -# nistp256, nistp384, nistp521, brainpoolP256r1, brainpoolP384r1, -# brainpoolP512r1, secp256k1 -sub_key = RSA:4096 - - -[queues] -# The queue to which processed incoming messages are passed. -in = in_default -``` +For more, see [config.rst](docs/config.rst). ## License -- cgit v1.2.3-70-g09d2