1 INSTALLING OPENDMARC 2 3OVERVIEW 4======== 5 6In order to install the opendkim as a milter to an MTA you will need to 7perform the following steps: 8 9* Compile the opendmarc program itself. 10 11* Configure the opendmarc filter. 12 13* Install the opendmarc and configure your MTA to use it. 14 15Note that there is a difference between "OpenDMARC" and "opendmarc". 16"OpenDMARC" is a package containing a library, a filter and some tools to 17be used in testing and using your DMARC installation. "opendmarc" is the 18filter program contained in the "OpenDMARC" package. 19 20libopendmarc is a library available as an API for programmers everywhere. 21That API is described in a set of HTML files in the OpenDMARC source code 22package. 23 24The opendmarc filter program incorporates the libopendmarc library and works 25with recent versions of sendmail and Postfix or any other MTA that supports 26"milter". For more information about milter, see <http://www.milter.org>. 27 28Sendmail is available at <http://www.sendmail.org> and Postfix is available 29at <http://www.postfix.org>. 30 31 32OPTIONAL PACKAGES 33================= 34 35OpenDMARC supports a few optional packages that can be included in the build 36to provide additional services. A few of these become mandatory when 37enabling certain features below. Specifying only the "--with-xxx" parameter 38to the "configure" command (described below) enables the package and makes a 39guess at where it might be installed on your system. If the configure script 40doesn't find it, you will need to specify the location with 41"--with-xxx=location". 42 43--with-milter Sendmail's "milter" include file and library. Required 44 unless compilation of the filter is disabled (see below). 45 Enabled by default. 46 47--with-sql-backend 48 Names the SQL backend in use on your system. The default 49 is "mysql". You can also specify "--without-sql-backend" 50 to suppres building of SQL support. 51 52FEATURES 53======== 54 55There are several compile-time features you may select. Some of these 56are present but unsupported while others are fully-supported. Read the 57FEATURES file for a description of the unsupported features. 58 59The supported features are as follows. The can be turned on at compile 60time by adding "--enable-xxx" to the "configure" command line (described 61below), where "xxx" is the name of the feature. 62 63filter Compile the opendmarc filter. Requires libmilter (see 64 "--with-milter" above). This is on by default; if you 65 don't want the filter, specify "--disable-filter". 66 67filter-tests Includes filter unit tests when doing "make check". 68 Requires the "miltertest" program, which is available as 69 part of the OpenDKIM package (see http://www.opendkim.org). 70 71 72COMPILING 73========= 74 75The opendmarc filter requires either sendmail v8.13.0 or Postfix v2.3 or later 76for required milter protocol enhancements. 77 78As Postfix currently does not provide the milter library, you need to have 79sendmail sources or development package installed. See 80http://www.postfix.org/MILTER_README.html 81 82You can view the configuration options with the following command (once you 83have built the configure script (see step 3, below)): 84 85 ./configure --help 86 87The commands shown below assume a UNIX system with standard build tools 88installed. 89 90Steps to compiling the library and the milter: 91 92(1) Download the source from github 93 git clone https://github.com/trusteddomainproject/OpenDMARC.git 94 95(2) Change directories to the repository directory that 96 was created in step 2. 97 cd opendmarc-<version> 98 99(3) Run gnu autoreconf to generate the configure and make files. 100 autoreconf -v -i 101 102(4) Run the "configure" script to configure the package for your operating 103 system. 104 ./configure 105 106(5) Compile the package. 107 make 108 109(6) Install the output of the build. You probably need to become the 110 superuser to run this step. 111 make install 112 113 114CONFIGURING OPENDMARC 115===================== 116 117The README document (in the opendmarc directory) covers the installation and 118configuration of opendmarc. 119