From 42f86329a994955e10e25deb1932dd085564771d Mon Sep 17 00:00:00 2001 From: K Rahul Reddy Date: Wed, 15 Apr 2020 17:18:57 +0530 Subject: [PATCH] Added Advanced Installations documentation --- docs/admin/Advanced-Installations.md | 105 +++++++++++++++++++++++++++ docs/admin/Import-and-Update.md | 2 + docs/mkdocs.yml | 1 + 3 files changed, 108 insertions(+) create mode 100644 docs/admin/Advanced-Installations.md diff --git a/docs/admin/Advanced-Installations.md b/docs/admin/Advanced-Installations.md new file mode 100644 index 00000000..d68bf580 --- /dev/null +++ b/docs/admin/Advanced-Installations.md @@ -0,0 +1,105 @@ +# Advanced installations + +This page contains instructions for setting up multiple countries in +your Nominatim database. It is assumed that you have already successfully +installed the Nominatim software itself, if not return to the +[installation page](Installation.md). + +## Importing multiple regions + +To import multiple regions in your database, you need to configure and run `utils/import_multiple_regions.sh` file. This script will set up the update directory which has the following structure: + +```bash +update +    ├── europe +    │   ├── andorra +    │   │   └── sequence.state +    │   └── monaco +    │   └── sequence.state +    └── tmp + ├── combined.osm.pbf + └── europe + ├── andorra-latest.osm.pbf + └── monaco-latest.osm.pbf + + +``` + +The `sequence.state` files will contain the sequence ID, which will be used be pyosmium to get updates. The tmp folder is used for import dump. + +### Configuring multiple regions + +The file `import_multiple_regions.sh` needs to be edited as per your requirement: + +1. List of countries. eg: + + COUNTRIES="europe/monaco europe/andorra" + +2. Path to Build directory. eg: + + NOMINATIMBUILD="/srv/nominatim/build" + +3. Path to Update directory. eg: + + UPDATEDIR="/srv/nominatim/update" + +4. Replication URL. eg: + + BASEURL="https://download.geofabrik.de" + DOWNCOUNTRYPOSTFIX="-latest.osm.pbf" + +!!! tip + If your database already exists and you want to add more countries, replace the setting up part + `${SETUPFILE} --osm-file ${UPDATEDIR}/tmp/combined.osm.pbf --all 2>&1` + with `${UPDATEFILE} --import-file ${UPDATEDIR}/tmp/combined.osm.pbf 2>&1`. + +### Setting up multiple regions + +Run the following command from your Nominatim directory after configuring the file. + + bash ./utils/import_multiple_regions.sh + +## Updating multiple regions + +To import multiple regions in your database, you need to configure and run ```utils/update_database.sh```. +This uses the update directory set up while setting up the DB. + +### Configuring multiple regions + +The file `update_database.sh` needs to be edited as per your requirement: + +1. List of countries. eg: + + COUNTRIES="europe/monaco europe/andorra" + +2. Path to Build directory. eg: + + NOMINATIMBUILD="/srv/nominatim/build" + +3. Path to Update directory. eg: + + UPDATEDIR="/srv/nominatim/update" + +4. Replication URL. eg: + + BASEURL="https://download.geofabrik.de" + DOWNCOUNTRYPOSTFIX="-updates" + +5. Followup can be set according to your installation. eg: For Photon, + + FOLLOWUP="curl http://localhost:2322/nominatim-update" + + will handle the indexing. + +### Updating the database + +Run the following command from your Nominatim directory after configuring the file. + + bash ./utils/update_database.sh + +This will get diffs from the replication server, import diffs and index the database. The default replication server in the script([Geofabric](https://download.geofabrik.de)) provides daily updates. + +## Verification and further setup + +Instructions for import verification and other details like importing Wikidata can be found in [import and update page](Import-and-Update.md) + diff --git a/docs/admin/Import-and-Update.md b/docs/admin/Import-and-Update.md index 554633ae..630e563f 100644 --- a/docs/admin/Import-and-Update.md +++ b/docs/admin/Import-and-Update.md @@ -321,3 +321,5 @@ If you have imported multiple country extracts and want to keep them up-to-date, have a look at the script in [issue #60](https://github.com/openstreetmap/Nominatim/issues/60). +**Update**: [Advanced installations section](Advanced-Installations.md) contains instructions +to set up and update multiple country extracts. \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0c89dbc3..20909ff4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -16,6 +16,7 @@ pages: - 'Administration Guide': - 'Basic Installation': 'admin/Installation.md' - 'Importing and Updating' : 'admin/Import-and-Update.md' + - 'Advanced Installations' : 'admin/Advanced-Installations.md' - 'Migration from older Versions' : 'admin/Migration.md' - 'Troubleshooting' : 'admin/Faq.md' - 'Developers Guide': -- 2.45.2