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

change README.md

Browse Source
This commit is contained in:
Thomas Oettli
2020-04-22 21:04:01 +02:00
parent e31c87ba6b
commit f7db51b5b2
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -21,7 +21,7 @@ curl https://raw.githubusercontent.com/spacefreak86/pymodmilter/master/docs/pymo
* Modify pymodmilter.conf according to your needs and you are ready to go. * Modify pymodmilter.conf according to your needs and you are ready to go.
## Configuration options ## Configuration options
Pymodmilter uses a configuration file in JSON format. The options are described below. Make a copy of the example configuration file in the [docs](https://github.com/spacefreak86/pymodmilter/tree/master/docs) folder to start with. 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. Rules and modifications are processed in the given order.
### Global ### Global
@@ -42,9 +42,9 @@ The following configuration options are optional for each rule:
* **conditions** * **conditions**
A list of conditions which all have to be true to process the rule. A list of conditions which all have to be true to process the rule.
* **local_addrs** * **local_addrs**
As described above in the global object section. As described above in the [Global](#Global) section.
* **log** * **log**
As described above in the global object section. As described above in the [Global](#Global) section.
### Modifications ### Modifications
The following configuration options are mandatory for each modification: The following configuration options are mandatory for each modification:
@@ -54,7 +54,7 @@ The following configuration options are mandatory for each modification:
* **del_header** * **del_header**
* **mod_header** * **mod_header**
Additional parameters are mandatory based on the modification type. The following configuration options are mandatory based on the modification type in use.
* **add_header** * **add_header**
* **header** * **header**
Name of the header. Name of the header.