geoipupdate(1)

1geoipupdate(1)                                                  geoipupdate(1)
2
3
4

NAME

6       geoipupdate - GeoIP2 and GeoLite2 Update Program
7

SYNOPSIS

9       geoipupdate [-Vvh] [-f CONFIG_FILE] [-d TARGET_DIRECTORY]
10

DESCRIPTION

12       geoipupdate  automatically  updates GeoIP2 and GeoLite2 databases.  The
13       program connects to the MaxMind GeoIP Update server to  check  for  new
14       databases.   If  a new database is available, the program will download
15       and install it.
16
17       If you are using a firewall, you must have  the  DNS  and  HTTPS  ports
18       open.
19

OPTIONS

21       -d, --database-directory
22              Install  databases to a custom directory.  This is optional.  If
23              provided, it overrides the DatabaseDirectory value from the con‐
24              figuration file and the GEOIPUPDATE_DB_DIR environment variable.
25
26       -f, --config-file
27              The  configuration file to use.  See GeoIP.conf and its documen‐
28              tation for more information.  This is optional.  It defaults  to
29              the  environment variable GEOIPUPDATE_CONF_FILE if it is set, or
30              /etc/GeoIP.conf otherwise.
31
32       --parallelism
33              Set the number of parallel database downloads.
34
35       -h, --help
36              Display help and exit.
37
38       --stack-trace
39              Show a stack trace on any error message.  This is primarily use‐
40              ful for debugging.
41
42       -V, --version
43              Display version information and exit.
44
45       -v, --verbose
46              Enable  verbose  mode.   Prints  out  the steps that geoipupdate
47              takes.  If provided, it overrides any GEOIPUPDATE_VERBOSE  envi‐
48              ronment variable.
49
50       -o, --output
51              Output download/update results in JSON format.
52

EXIT STATUS

54       geoipupdate returns 0 on success and 1 on error.
55

NOTES

57       Typically  you  should  run geoipupdate weekly.  On most Unix-like sys‐
58       tems, this can be achieved by using cron.  Below is  a  sample  crontab
59       file that runs geoipupdate on each Wednesday at noon:
60
61              # top of crontab
62
63              MAILTO=your@email.com
64
65              0 12 * * 3 geoipupdate
66
67              # end of crontab
68
69       To use with a proxy server, update your GeoIP.conf file as specified in
70       the GeoIP.conf man page.  Alternatively, set the  GEOIPUPDATE_PROXY  or
71       http_proxy environment variable.
72

BUGS

74       Report bugs to <support@maxmind.com>.
75

AUTHORS

77       Written by William Storey.
78
79       This software is Copyright (c) 2018-2023 by MaxMind, Inc.
80
81       This  is  free software, licensed under the Apache License, Version 2.0
82       or the MIT License, at your option.
83

MORE INFORMATION

85       Visit our website (https://www.maxmind.com/en/geoip2-services-and-data‐
86       bases)  to  learn  more  about the GeoIP2 databases or to sign up for a
87       subscription.
88