.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "geoipupdate" "1" "" "" ""
.hy
.SH NAME
.PP
geoipupdate - GeoIP2 and GeoLite2 Update Program
.SH SYNOPSIS
.PP
\f[B]geoipupdate\f[R] [-Vvh] [-f \f[I]CONFIG_FILE\f[R]] [-d
\f[I]TARGET_DIRECTORY\f[R]]
.SH DESCRIPTION
.PP
\f[V]geoipupdate\f[R] automatically updates GeoIP2 and GeoLite2
databases.
The program connects to the MaxMind GeoIP Update server to check for new
databases.
If a new database is available, the program will download and install
it.
.PP
If you are using a firewall, you must have the DNS and HTTPS ports open.
.SH OPTIONS
.TP
\f[V]-d\f[R], \f[V]--database-directory\f[R]
Install databases to a custom directory.
This is optional.
If provided, it overrides the \f[V]DatabaseDirectory\f[R] value from the
configuration file and the \f[V]GEOIPUPDATE_DB_DIR\f[R] environment
variable.
.TP
\f[V]-f\f[R], \f[V]--config-file\f[R]
The configuration file to use.
See \f[V]GeoIP.conf\f[R] and its documentation for more information.
This is optional.
It defaults to the environment variable \f[V]GEOIPUPDATE_CONF_FILE\f[R]
if it is set, or /etc/GeoIP.conf otherwise.
.TP
\f[V]--parallelism\f[R]
Set the number of parallel database downloads.
.TP
\f[V]-h\f[R], \f[V]--help\f[R]
Display help and exit.
.TP
\f[V]--stack-trace\f[R]
Show a stack trace on any error message.
This is primarily useful for debugging.
.TP
\f[V]-V\f[R], \f[V]--version\f[R]
Display version information and exit.
.TP
\f[V]-v\f[R], \f[V]--verbose\f[R]
Enable verbose mode.
Prints out the steps that \f[V]geoipupdate\f[R] takes.
If provided, it overrides any \f[V]GEOIPUPDATE_VERBOSE\f[R] environment
variable.
.TP
\f[V]-o\f[R], \f[V]--output\f[R]
Output download/update results in JSON format.
.SH EXIT STATUS
.PP
\f[V]geoipupdate\f[R] returns 0 on success and 1 on error.
.SH NOTES
.PP
Typically you should run \f[V]geoipupdate\f[R] weekly.
On most Unix-like systems, this can be achieved by using cron.
Below is a sample crontab file that runs \f[V]geoipupdate\f[R] on each
Wednesday at noon:
.IP
.nf
\f[C]
# top of crontab

MAILTO=your\[at]email.com

0 12 * * 3 geoipupdate

# end of crontab
\f[R]
.fi
.PP
To use with a proxy server, update your \f[V]GeoIP.conf\f[R] file as
specified in the \f[V]GeoIP.conf\f[R] man page.
Alternatively, set the \f[V]GEOIPUPDATE_PROXY\f[R] or
\f[V]http_proxy\f[R] environment variable.
.SH BUGS
.PP
Report bugs to <support@maxmind.com>.
.SH AUTHORS
.PP
Written by William Storey.
.PP
This software is Copyright (c) 2018-2024 by MaxMind, Inc.
.PP
This is free software, licensed under the Apache License, Version 2.0 or
the MIT License, at your option.
.SH MORE INFORMATION
.PP
Visit our
website (https://www.maxmind.com/en/geoip2-services-and-databases) to
learn more about the GeoIP2 databases or to sign up for a subscription.
.SH SEE ALSO
.PP
\f[V]GeoIP.conf\f[R](5)