spacefreak/pyquarantine-milter
1
0
Fork 0
Code Issues Pull Requests Releases Activity

add config option socket, rework example config and release 1.0.0

Browse Source
This commit is contained in:
Thomas Oettli
2020-04-22 23:02:05 +02:00
parent 2d73d525b8
commit 01b516ce7c
6 changed files with 51 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -10,22 +10,21 @@ Pymodmilter is depending on these python packages, but they are installed automa
* [netaddr](https://github.com/drkjam/netaddr/)
## Installation
* Install pymodmilter with pip.
* Install pymodmilter with pip and copy the example configuration file.
```sh
pip install pymodmilter
```
* Copy the example configuration file.
```sh
cp /usr/share/doc/pymodmilter/pymodmilter.conf.example /etc/pymodmilter.conf
```
* Modify /etc/pymodmilter.conf according to your needs and you are ready to go.
* Modify /etc/pymodmilter.conf according to your needs.
## Configuration options
Pymodmilter uses a configuration file in JSON format. The options are described below. Make a copy of the [example configuration file](https://github.com/spacefreak86/pymodmilter/blob/master/docs/pymodmilter.conf.example) in the [docs](https://github.com/spacefreak86/pymodmilter/tree/master/docs) folder to start with.
Rules and modifications are processed in the given order.
### Global
The following optional global configuration options are available:
The following global configuration options are optional:
* **socket**
The socket used to communicate with the MTA.
* **local_addrs**
A list of hosts and network addresses which are considered local. It is used to for the condition option [local](#Conditions). This option may be overriden within a rule object.
* **log**