change README.md

This commit is contained in:
2022-01-11 21:22:37 +01:00
parent e59aa11eca
commit 873b740a44

View File

@@ -23,15 +23,35 @@ pyquarantine is depending on these python packages, they are installed automatic
## Installation
```sh
# Install pyquarantine with pip.
# install pyquarantine with pip.
pip install pyquarantine
# Copy the example config file and modify it according to your needs.
cp /etc/pyquarantine/pyquarantine.conf.example /etc/pyquarantine/pyquarantine.conf
# install service files, default config and templates
pyquarantine-milter --install
# Check the validity of the config file.
# Check the validity of the your config file.
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
pyquarantine uses a config file in JSON format. It has to be JSON valid with the exception of allowed comment lines starting with **#**.