2ac8cb406e
Switch the bundled IP-to-country database from DB-IP Country Lite to IPinfo Lite for greater lookup accuracy. The download URL, cached filename, and packaged module path all move from dbip/dbip-country-lite.mmdb to ipinfo/ipinfo_lite.mmdb. IPinfo Lite uses a different MMDB schema (flat country_code) that is incompatible with geoip2's Reader.country() helper, so get_ip_address_country() now uses maxminddb directly and handles both the IPinfo schema and the MaxMind/DBIP nested country.iso_code schema so users who drop in their own MMDB from any of these providers continue to work. Drop the geoip2 dependency (it was only used for the incompatible helper) and add maxminddb as a direct dependency — it was already installed transitively through geoip2. Callers that imported parsedmarc.resources.dbip directly need to switch to parsedmarc.resources.ipinfo. Old parsedmarc versions downloading from the dbip/ GitHub raw URL will 404 and fall back to their bundled copy — this is the documented behavior of load_ip_db(). Co-authored-by: Sean Whalen <seanthegeek@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
6.1 KiB
Installation
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 9.8.0, a static copy of the
IPinfo Lite database is distributed with parsedmarc, under the
terms of the Creative Commons Attribution-ShareAlike 4.0 License,
as a fallback if the MaxMind GeoLite2 Country database is not
installed. Prior versions bundled the DB-IP Country Lite database
instead; both share the same MMDB format, so users who have installed
either (or a MaxMind GeoLite2) database locally will continue to work
without changes.
The bundled database is automatically updated at startup by downloading
the latest copy from GitHub, unless the offline flag is set. The
database is cached locally and refreshed on each run (or on SIGHUP
in watch mode). If the download fails, a previously cached copy or the
bundled database is used as a fallback.
The download URL can be overridden with the ip_db_url setting, and
the location of a local database file can be overridden with the
ip_db_path setting.
:::
On Debian 10 (Buster) or later, run:
sudo apt-get install -y geoipupdate
:::{note} Component "contrib" is required in your apt sources. :::
On Ubuntu systems run:
sudo add-apt-repository ppa:maxmind/ppa
sudo apt update
sudo apt install -y geoipupdate
On CentOS or RHEL systems, run:
sudo dnf install -y geoipupdate
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.
:::
:::{note}
To check the version of geoipupdate that is installed, run:
geoipupdate -V
:::
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
sudo geoipupdate
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:
sudo apt-get install -y python3-pip python3-virtualenv python3-dev libxml2-dev libxslt-dev
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
sudo mkdir /opt
sudo useradd parsedmarc -r -s /bin/false -m -b /opt
Install parsedmarc in a virtualenv
sudo -u parsedmarc virtualenv /opt/parsedmarc/venv
CentOS/RHEL 8 systems use Python 3.6 by default, so on those systems
explicitly tell virtualenv to use python3.10 instead
sudo -u parsedmarc virtualenv -p python3.10 /opt/parsedmarc/venv
Activate the virtualenv
source /opt/parsedmarc/venv/bin/activate
To install or upgrade parsedmarc inside the virtualenv, run:
sudo -u parsedmarc /opt/parsedmarc/venv/bin/pip install -U parsedmarc
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:
sudo apt-get install libemail-outlook-message-perl