Installation🔗
Warning
This documentation has not been reviewed for version 9.0.0. Please consider submitting a pull request to update it.
Prerequisites🔗
parsedmarc works with Python 3 only.
Testing multiple report analyzers🔗
If you would like to test parsedmarc and another report processing
solution at the same time, you can have up to two mailto URIs in each of the rua and ruf
tags in your DMARC record, separated by commas.
Using a web proxy🔗
If your system is behind a web proxy, you need to configure your system
to use that proxy. To do this, edit /etc/environment and add your
proxy details there, for example:
http_proxy=http://user:password@prox-server:3128
https_proxy=https://user:password@prox-server:3128
ftp_proxy=http://user:password@prox-server:3128
Or if no credentials are needed:
http_proxy=http://prox-server:3128
https_proxy=https://prox-server:3128
ftp_proxy=http://prox-server:3128
This will set the proxy up for use system-wide, including for parsedmarc.
Using Microsoft Exchange🔗
If your mail server is Microsoft Exchange, ensure that it is patched to at least:
- Exchange Server 2010 Update Rollup 22 (KB4295699)
- Exchange Server 2013 Cumulative Update 21 (KB4099855)
- Exchange Server 2016 Cumulative Update 11 (KB4134118)
geoipupdate setup🔗
Note
Starting in parsedmarc 7.1.0, a static copy of the IP to Country Lite database
from IPDB is distributed with parsedmarc, under the terms of the
[Creative Commons Attribution 4.0 International License] as a fallback if the
MaxMind GeoLite2 Country database is not installed. However, parsedmarc
cannot install updated versions of these databases as they are released,
so MaxMind's databases and the geoipupdate tool is still the preferable solution.
The location of the database file can be overridden by using the ip_db_path setting.
On Debian 10 (Buster) or later, run:
Note
Component "contrib" is required in your apt sources.
On Ubuntu systems run:
On CentOS or RHEL systems, run:
The latest builds for Linux, macOS, and Windows can be downloaded from the geoipupdate releases page on GitHub.
On December 30th, 2019, MaxMind started requiring free accounts to access the free Geolite2 databases, in order to comply with various privacy regulations.
Start by registering for a free GeoLite2 account, and signing in.
Then, navigate to the License Keys page under your account,
and create a new license key for the version of
geoipupdate that was installed.
Warning
The configuration file format is different for older (i.e. \<=3.1.1) and
newer (i.e. >=3.1.1) versions of geoipupdate. Be sure to select the correct
version for your system.
You can use parsedmarc as the description for the key.
Once you have generated a key, download the config pre-filled
configuration file. This file should be saved at /etc/GeoIP.conf
on Linux or macOS systems, or at
%SystemDrive%\ProgramData\MaxMind\GeoIPUpdate\GeoIP.conf on
Windows systems.
Then run
To download the databases for the first time.
The GeoLite2 Country, City, and ASN databases are updated weekly,
every Tuesday. geoipupdate can be run weekly by adding a cron
job or scheduled task.
More information about geoipupdate can be found at the
MaxMind geoipupdate page.
Installing parsedmarc🔗
On Debian or Ubuntu systems, run:
On CentOS or RHEL systems, run:
sudo dnf install -y python39 python3-virtualenv python3-setuptools python3-devel libxml2-devel libxslt-devel
Python 3 installers for Windows and macOS can be found at https://www.python.org/downloads/.
Create a system user
Install parsedmarc in a virtualenv
CentOS/RHEL 8 systems use Python 3.6 by default, so on those systems
explicitly tell virtualenv to use python3.9 instead
Activate the virtualenv
To install or upgrade parsedmarc inside the virtualenv, run:
Optional dependencies🔗
If you would like to be able to parse emails saved from Microsoft
Outlook (i.e. OLE .msg files), install msgconvert:
On Debian or Ubuntu systems, run: