.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "geoipupdate" "1" "" "" ""
.SH NAME
geoipupdate \- GeoIP2 and GeoLite2 Update Program
.SH SYNOPSIS
\f[B]geoipupdate\f[R] [\-Vvh] [\-f \f[I]CONFIG_FILE\f[R]] [\-d
\f[I]TARGET_DIRECTORY\f[R]]
.SH DESCRIPTION
\f[CR]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[CR]\-d\f[R], \f[CR]\-\-database\-directory\f[R]
Install databases to a custom directory.
This is optional.
If provided, it overrides the \f[CR]DatabaseDirectory\f[R] value from
the configuration file and the \f[CR]GEOIPUPDATE_DB_DIR\f[R] environment
variable.
.TP
\f[CR]\-f\f[R], \f[CR]\-\-config\-file\f[R]
The configuration file to use.
See \f[CR]GeoIP.conf\f[R] and its documentation for more information.
This is optional.
It defaults to the environment variable \f[CR]GEOIPUPDATE_CONF_FILE\f[R]
if it is set, or /etc/GeoIP.conf otherwise.
.TP
\f[CR]\-\-parallelism\f[R]
Set the number of parallel database downloads.
.TP
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
Display help and exit.
.TP
\f[CR]\-\-stack\-trace\f[R]
Show a stack trace on any error message.
This is primarily useful for debugging.
.TP
\f[CR]\-V\f[R], \f[CR]\-\-version\f[R]
Display version information and exit.
.TP
\f[CR]\-v\f[R], \f[CR]\-\-verbose\f[R]
Enable verbose mode.
Prints out the steps that \f[CR]geoipupdate\f[R] takes.
If provided, it overrides any \f[CR]GEOIPUPDATE_VERBOSE\f[R] environment
variable.
.TP
\f[CR]\-o\f[R], \f[CR]\-\-output\f[R]
Output download/update results in JSON format.
.SH EXIT STATUS
\f[CR]geoipupdate\f[R] returns 0 on success and 1 on error.
.SH NOTES
Typically you should run \f[CR]geoipupdate\f[R] at least twice a week.
Consult our \c
.UR
https://support.maxmind.com/hc/en-us/articles/4408216129947-Download-and-Update-Databases#h_01G3XX402XKD3J1CMWKNKMDYYZ
database release schedule
.UE \c
\ for more information.
.PP
On most Unix\-like systems, this can be achieved by using cron.
You can find \c
.UR https://dev.maxmind.com/geoip/updating-databases#3-run-geoip-update
an example crontab file on our Developer Portal
.UE \c
\&.
.PP
To use with a proxy server, update your \f[CR]GeoIP.conf\f[R] file as
specified in the \f[CR]GeoIP.conf\f[R] man page.
Alternatively, set the \f[CR]GEOIPUPDATE_PROXY\f[R] or
\f[CR]http_proxy\f[R] environment variable.
.SH BUGS
Report bugs to \c
.MT support@maxmind.com
.ME \c
\&.
.SH AUTHORS
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
Visit \c
.UR https://www.maxmind.com/en/geoip2-services-and-databases
our website
.UE \c
\ to learn more about the GeoIP2 databases or to sign up for a
subscription.
.SH SEE ALSO
\f[CR]GeoIP.conf\f[R](5)