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
2022-01-11 21:22:37 +01:00
parent e59aa11eca
commit 873b740a44
1 changed files with 24 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -23,15 +23,35 @@ pyquarantine is depending on these python packages, they are installed automatic
## Installation ## Installation
```sh ```sh
# Install pyquarantine with pip. # install pyquarantine with pip.
pip install pyquarantine pip install pyquarantine
# Copy the example config file and modify it according to your needs. # install service files, default config and templates
cp /etc/pyquarantine/pyquarantine.conf.example /etc/pyquarantine/pyquarantine.conf pyquarantine-milter --install
# Check the validity of the config file. # Check the validity of the your config file.
pyquarantine-milter -t pyquarantine-milter -t
``` ```
## Autostart
The following init systems are supported.
### systemd
```sh
# start the daemon at boot time
systemctl enable pyquarantine-milter.service
# start the daemon immediately
systemctl start pyquarantine-milter.service
```
### OpenRC (Gentoo)
```sh
# start the daemon at boot time
rc-update add pyquarantine-milter default
# start the daemon immediately
rc-service pyquarantine-milter start
```
## Configuration ## Configuration
pyquarantine uses a config file in JSON format. It has to be JSON valid with the exception of allowed comment lines starting with **#**. pyquarantine uses a config file in JSON format. It has to be JSON valid with the exception of allowed comment lines starting with **#**.