Skip to content

Commit ec093be

Browse files
authored
update docs for the default non-maxmind source of the geoip db (#255)
1 parent a0b8f9f commit ec093be

File tree

1 file changed

+39
-22
lines changed

1 file changed

+39
-22
lines changed

cpt-replica.rst

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -198,30 +198,18 @@ One of the essential services supplied by Stratum 1s to CernVM-FS
198198
clients is the Geo API. This enables clients to share configurations
199199
worldwide while automatically sorting Stratum 1s geographically to
200200
prioritize connecting to the closest ones. This makes use of a GeoIP
201-
database from `Maxmind <https://dev.maxmind.com/geoip/geoip2/geolite2/>`_
202-
that translates IP addresses of clients to longitude and latitude.
203-
204-
The database is free, but the Maxmind
205-
`End User License Agreement <https://www.maxmind.com/en/geolite2/eula/>`_
206-
requires that each user of the database
207-
`sign up for an account <https://www.maxmind.com/en/geolite2/signup/>`_
208-
and promise to update the database to the latest version within 30 days
209-
of when they issue a new version. The signup process will end with
210-
giving you a License Key. The ``cvmfs_server`` ``add-replica`` and
211-
``snapshot`` commands will take care of automatically updating the
212-
database if you put a line like the following in
213-
``/etc/cvmfs/server.local``, replacing ``<license key>`` with the key
214-
you get from the signup process:
215-
216-
::
217-
218-
CVMFS_GEO_LICENSE_KEY=<license key>
219-
220-
To keep the key secret, set the mode of ``/etc/cvmfs/server.local`` to 600.
221-
You can test that it works by running ``cvmfs_server update-geodb``.
201+
database that translates IP addresses of clients to longitude and
202+
latitude. By default this database is automatically downloaded
203+
periodically by the ``cvmfs_server snapshot`` command.
204+
The format of the database is called ``MaxMind DB`` (.mmdb) but the
205+
database is no longer downloaded by default from Maxmind, it is
206+
instead downloaded from
207+
`cvmfs-contrib/config-repo on github <https://github.com/cvmfs-contrib/config-repo>`_.
208+
Maxmind can still be chosen as the automatic download source if desired,
209+
as described in the :ref:`next section <sct_legacy_geoip_db>`.
222210

223211
Alternatively, if you have a separate mechanism of installing and
224-
updating the Geolite2 City database file, you can instead set
212+
updating a city mmdb file, you can instead set
225213
``CVMFS_GEO_DB_FILE`` to the full path where you have installed it. If
226214
the path is ``NONE``, then no database will be required, but note that
227215
this will break the client Geo API so only use it for testing, when the
@@ -243,6 +231,35 @@ defined in ``cvmfs_server`` beginning with ``CVMFS_UPDATEGEO_``. Look
243231
in the ``cvmfs_server`` script for the details. An update can also be
244232
forced at any time by running ``cvmfs_server update-geodb``.
245233

234+
.. _sct_legacy_geoip_db:
235+
236+
Reverting to the legacy Maxmind source of the GeoIP database
237+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238+
239+
The `legacy Maxmind source <https://dev.maxmind.com/geoip/geoip2/geolite2/>`_
240+
of the database can still be selected as the source of the automatically
241+
downloaded GeoIP database. The database is free, but the Maxmind
242+
`End User License Agreement <https://www.maxmind.com/en/geolite2/eula/>`_
243+
requires that each user of the database
244+
`sign up for an account <https://www.maxmind.com/en/geolite2/signup/>`_
245+
and promise to update the database to the latest version within 30 days
246+
of when they issue a new version. The signup process will end with
247+
giving you a License Key. The ``cvmfs_server snapshot``
248+
command will take care of automatically updating the
249+
database if you put lines like the following in
250+
``/etc/cvmfs/server.local``, replacing ``<license key>`` with the
251+
account id and key you get from the signup process:
252+
253+
::
254+
255+
CVMFS_UPDATEGEO_SOURCE=maxmind
256+
CVMFS_GEO_ACCOUNT_ID=<account id>
257+
CVMFS_GEO_LICENSE_KEY=<license key>
258+
259+
To keep the key secret, set the mode of ``/etc/cvmfs/server.local`` to 600.
260+
You can test that it works by running ``cvmfs_server update-geodb``.
261+
262+
246263
Monitoring
247264
----------
248265

0 commit comments

Comments
 (0)