Commit ba03ca7f authored by Daniel Salzman's avatar Daniel Salzman

doc: add maxmindb dependency and some tiny improvements

parent 90a6196d
......@@ -24,7 +24,8 @@ Install optional packages to override embedded libraries:
$ sudo apt-get install liblmdb-dev
Install optional packages:
$ sudo apt-get install libcap-ng-dev libsystemd-dev libidn2-0-dev protobuf-c-compiler libfstrm-dev
$ sudo apt-get install \
libcap-ng-dev libsystemd-dev libidn2-0-dev protobuf-c-compiler libfstrm-dev libmaxminddb-dev
Fedora like distributions
-------------------------
......@@ -42,7 +43,8 @@ Install optional packages to override embedded libraries:
# dnf install lmdb-devel
Install optional packages:
# dnf install libcap-ng-devel systemd-devel libidn-devel protobuf-c-devel fstrm-devel
# dnf install \
libcap-ng-devel systemd-devel libidn-devel protobuf-c-devel fstrm-devel libmaxminddb-devel
When compiling on RHEL based system, the Fedora EPEL repository has to be
enabled. Also for RHEL 6, forward compatibility package gnutls30-devel
......
......@@ -89,3 +89,8 @@ as a non-root user/group, binding to privileged ports (53), and giving up all
its capabilities, resulting in a completely unprivileged process:
* libcap-ng >= 0.6.4
MaxMind database for **geodb** support in module :ref:`geoip<mod-geoip>`:
* libmaxminddb0
......@@ -25,8 +25,9 @@ have a **default** RRset of the same type contained in the zone, so that the NSE
chain can be built correctly. Also, it is STRONGLY RECOMMENDED to use manual key rollover in this setting,
as the module has to be reloaded when the signing key changes.
Alternatively, the :ref:`geoip<mod-geoip>` module may be combined with the :ref:`onlinesign<mod-onlinesign>` module
and the tailored responses can be signed on the fly. This approach is more computationally demanding for the server.
Alternatively, the :ref:`geoip<mod-geoip>` module may be combined with the
:ref:`onlinesign<mod-onlinesign>` module and the tailored responses can be signed
on the fly. This approach is more computationally demanding for the server.
Example
......@@ -49,8 +50,9 @@ Example
Configuration file
------------------
Every instance of the module requires an additional :ref:`mod-geoip_config-file` in which the desired responses to queries from
various locations are configured. This file has the following simple format:
Every instance of the module requires an additional :ref:`mod-geoip_config-file`
in which the desired responses to queries from various locations are configured.
This file has the following simple format:
::
......@@ -143,10 +145,15 @@ The time to live of Resource Records returned by the module.
mode
....
The mode of operation of the module. When set to **subnet**, responses
are tailored according to subnets. When set to **geodb**, responses
are tailored according to geographic data retrieved from the configured
database.
The mode of operation of the module.
Possible values:
- ``subnet`` – Responses are tailored according to subnets.
- ``geodb`` – Responses are tailored according to geographic data retrieved
from the configured database.
*Default:* subnet
.. _mod-geoip_geodb-file:
......@@ -155,7 +162,7 @@ geodb-file
Full path to a .mmdb file containing the GeoIP database.
*Reqired if* **mode** *is set to* **geodb**
*Reqired if* :ref:`mod-geoip_mode` *is set to* **geodb**
.. _mod-geoip_geodb-key:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment