docs/admin/Update.md

   1 # Updating the Database
   2
   3 There are many different ways to update your Nominatim database.
   4 The following section describes how to keep it up-to-date using
   5 an [online replication service for OpenStreetMap data](https://wiki.openstreetmap.org/wiki/Planet.osm/diffs)
   6 For a list of other methods to add or update data see the output of
   7 `nominatim add-data --help`.
   8
   9 !!! important
  10     If you have configured a flatnode file for the import, then you
  11     need to keep this flatnode file around for updates.
  12
  13 ### Installing the newest version of Pyosmium
  14
  15 The replication process uses
  16 [Pyosmium](https://docs.osmcode.org/pyosmium/latest/updating_osm_data.html)
  17 to download update data from the server.
  18 It is recommended to install Pyosmium via pip.
  19 Run (as the same user who will later run the updates):
  20
  21 ```sh
  22 pip3 install --user osmium
  23 ```
  24
  25 ### Setting up the update process
  26
  27 Next the update process needs to be initialised. By default Nominatim is configured
  28 to update using the global minutely diffs.
  29
  30 If you want a different update source you will need to add some settings
  31 to `.env`. For example, to use the daily country extracts
  32 diffs for Ireland from Geofabrik add the following:
  33
  34     # base URL of the replication service
  35     NOMINATIM_REPLICATION_URL="https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates"
  36     # How often upstream publishes diffs (in seconds)
  37     NOMINATIM_REPLICATION_UPDATE_INTERVAL=86400
  38     # How long to sleep if no update found yet (in seconds)
  39     NOMINATIM_REPLICATION_RECHECK_INTERVAL=900
  40
  41 To set up the update process now run the following command:
  42
  43     nominatim replication --init
  44
  45 It outputs the date where updates will start. Recheck that this date is
  46 what you expect.
  47
  48 The `replication --init` command needs to be rerun whenever the replication
  49 service is changed.
  50
  51 ### Updating Nominatim
  52
  53 Nominatim supports different modes how to retrieve the update data from the
  54 server. Which one you want to use depends on your exact setup and how often you
  55 want to retrieve updates.
  56
  57 These instructions are for using a single source of updates. If you have
  58 imported multiple country extracts and want to keep them
  59 up-to-date, [Advanced installations section](Advanced-Installations.md)
  60 contains instructions to set up and update multiple country extracts.
  61
  62 #### One-time mode
  63
  64 When the `--once` parameter is given, then Nominatim will download exactly one
  65 batch of updates and then exit. This one-time mode still respects the
  66 `NOMINATIM_REPLICATION_UPDATE_INTERVAL` that you have set. If according to
  67 the update interval no new data has been published yet, it will go to sleep
  68 until the next expected update and only then attempt to download the next batch.
  69
  70 The one-time mode is particularly useful if you want to run updates continuously
  71 but need to schedule other work in between updates. For example, you might
  72 want to regularly recompute postcodes -- a process that
  73 must not be run while updates are in progress. An update script refreshing
  74 postcodes regularly might look like this:
  75
  76 ```sh
  77 #!/bin/bash
  78
  79 # Switch to your project directory.
  80 cd /srv/nominatim
  81
  82 while true; do
  83   nominatim replication --once
  84   if [ -f "/srv/nominatim/schedule-maintenance" ]; then
  85     rm /srv/nominatim/schedule-maintenance
  86     nominatim refresh --postcodes
  87   fi
  88 done
  89 ```
  90
  91 A cron job then creates the file `/srv/nominatim/schedule-maintenance` once per night.
  92
  93 ##### One-time mode with systemd
  94
  95 You can run the one-time mode with a systemd timer & service.
  96
  97 Create a timer description like `/etc/systemd/system/nominatim-updates.timer`:
  98
  99 ```
 100 [Unit]
 101 Description=Timer to start updates of Nominatim
 102
 103 [Timer]
 104 OnActiveSec=2
 105 OnUnitActiveSec=1min
 106 Unit=nominatim-updates.service
 107
 108 [Install]
 109 WantedBy=multi-user.target
 110 ```
 111
 112 `OnUnitActiveSec` defines how often the individual update command is run.
 113
 114 Then add a service definition for the timer in `/etc/systemd/system/nominatim-updates.service`:
 115
 116 ```
 117 [Unit]
 118 Description=Single updates of Nominatim
 119
 120 [Service]
 121 WorkingDirectory=/srv/nominatim-project
 122 ExecStart=/srv/nominatim-venv/bin/nominatim replication --once
 123 StandardOutput=journald
 124 StandardError=inherit
 125 User=nominatim
 126 Group=nominatim
 127 Type=simple
 128
 129 [Install]
 130 WantedBy=multi-user.target
 131 ```
 132
 133 Replace the `WorkingDirectory` with your project directory. `ExecStart` points
 134 to the nominatim binary that was installed in your virtualenv earlier.
 135 Finally, you might need to adapt user and group names as required.
 136
 137 Now activate the service and start the updates:
 138
 139 ```
 140 sudo systemctl daemon-reload
 141 sudo systemctl enable nominatim-updates.timer
 142 sudo systemctl start nominatim-updates.timer
 143 ```
 144
 145 You can stop future data updates while allowing any current, in-progress
 146 update steps to finish, by running `sudo systemctl stop
 147 nominatim-updates.timer` and waiting until `nominatim-updates.service` isn't
 148 running (`sudo systemctl is-active nominatim-updates.service`).
 149
 150 To check the output from the update process, use journalctl: `journalctl -u
 151 nominatim-updates.service`
 152
 153
 154 #### Catch-up mode
 155
 156 With the `--catch-up` parameter, Nominatim will immediately try to download
 157 all changes from the server until the database is up-to-date. The catch-up mode
 158 still respects the parameter `NOMINATIM_REPLICATION_MAX_DIFF`. It downloads and
 159 applies the changes in appropriate batches until all is done.
 160
 161 The catch-up mode is foremost useful to bring the database up to date after the
 162 initial import. Give that the service usually is not in production at this
 163 point, you can temporarily be a bit more generous with the batch size and
 164 number of threads you use for the updates by running catch-up like this:
 165
 166 ```
 167 cd /srv/nominatim-project
 168 NOMINATIM_REPLICATION_MAX_DIFF=5000 nominatim replication --catch-up --threads 15
 169 ```
 170
 171 The catch-up mode is also useful when you want to apply updates at a lower
 172 frequency than what the source publishes. You can set up a cron job to run
 173 replication catch-up at whatever interval you desire.
 174
 175 !!! hint
 176     When running scheduled updates with catch-up, it is a good idea to choose
 177     a replication source with an update frequency that is an order of magnitude
 178     lower. For example, if you want to update once a day, use an hourly updated
 179     source. This ensures that you don't miss an entire day of updates when
 180     the source is unexpectedly late to publish its update.
 181
 182     If you want to use the source with the same update frequency (e.g. a daily
 183     updated source with daily updates), use the
 184     once mode together with a frequently run systemd script as described above.
 185     It ensures to re-request the newest update until they have been published.
 186
 187
 188 #### Continuous updates
 189
 190 !!! danger
 191     This mode is no longer recommended to use and will removed in future
 192     releases. systemd is much better
 193     suited for running regular updates. Please refer to the setup
 194     instructions for running one-time mode with systemd above.
 195
 196 This is the easiest mode. Simply run the replication command without any
 197 parameters:
 198
 199     nominatim replication
 200
 201 The update application keeps running forever and retrieves and applies
 202 new updates from the server as they are published.