]> git.openstreetmap.org Git - nominatim.git/blob - docs/admin/Advanced-Installations.md
Code cleaning, tests simplification and use of python3-icu package
[nominatim.git] / docs / admin / Advanced-Installations.md
1 # Advanced installations
2
3 This page contains instructions for setting up multiple countries in 
4 your Nominatim database. It is assumed that you have already successfully
5 installed the Nominatim software itself, if not return to the 
6 [installation page](Installation.md).
7
8 ## Importing multiple regions
9
10 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:
11
12 ```bash
13 update
14     ├── europe
15     │   ├── andorra
16     │   │   └── sequence.state
17     │   └── monaco
18     │       └── sequence.state
19     └── tmp
20         ├── combined.osm.pbf
21         └── europe
22                 ├── andorra-latest.osm.pbf
23                 └── monaco-latest.osm.pbf
24
25
26 ```
27
28 The `sequence.state` files will contain the sequence ID, which will be used by pyosmium to get updates. The tmp folder is used for import dump.
29
30 ### Configuring multiple regions
31
32 The file `import_multiple_regions.sh` needs to be edited as per your requirement:
33
34 1. List of countries. eg:
35
36         COUNTRIES="europe/monaco europe/andorra"
37
38 2. Path to Build directory. eg:
39
40         NOMINATIMBUILD="/srv/nominatim/build"
41
42 3. Path to Update directory. eg:
43         
44         UPDATEDIR="/srv/nominatim/update"
45
46 4. Replication URL. eg:
47     
48         BASEURL="https://download.geofabrik.de"
49         DOWNCOUNTRYPOSTFIX="-latest.osm.pbf"
50
51 ### Setting up multiple regions
52
53 !!! tip
54     If your database already exists and you want to add more countries,
55     replace the setting up part
56     `${SETUPFILE} --osm-file ${UPDATEDIR}/tmp/combined.osm.pbf --all 2>&1`
57     with `${UPDATEFILE} --import-file ${UPDATEDIR}/tmp/combined.osm.pbf --index --index-instances N 2>&1`
58     where N is the numbers of CPUs in your system.
59
60 Run the following command from your Nominatim directory after configuring the file.
61
62     bash ./utils/import_multiple_regions.sh
63
64 !!! danger "Important"
65         This file uses osmium-tool. It must be installed before executing the import script.
66         Installation instructions can be found [here](https://osmcode.org/osmium-tool/manual.html#installation).
67
68 ### Updating multiple regions
69
70 To import multiple regions in your database, you need to configure and run ```utils/update_database.sh```.
71 This uses the update directory set up while setting up the DB.   
72
73 ### Configuring multiple regions
74
75 The file `update_database.sh` needs to be edited as per your requirement:
76
77 1. List of countries. eg:
78
79         COUNTRIES="europe/monaco europe/andorra"
80
81 2. Path to Build directory. eg:
82
83         NOMINATIMBUILD="/srv/nominatim/build"
84
85 3. Path to Update directory. eg:
86         
87         UPDATEDIR="/srv/nominatim/update"
88
89 4. Replication URL. eg:
90     
91         BASEURL="https://download.geofabrik.de"
92         DOWNCOUNTRYPOSTFIX="-updates"
93
94 5. Followup can be set according to your installation. eg: For Photon,
95
96         FOLLOWUP="curl http://localhost:2322/nominatim-update"
97
98     will handle the indexing.
99
100 ### Updating the database
101
102 Run the following command from your Nominatim directory after configuring the file.
103
104     bash ./utils/update_database.sh
105
106 This will get diffs from the replication server, import diffs and index the database. The default replication server in the script([Geofabrik](https://download.geofabrik.de)) provides daily updates.
107
108 ## Importing Nominatim to an external PostgreSQL database
109
110 You can install Nominatim using a database that runs on a different server when
111 you have physical access to the file system on the other server. Nominatim
112 uses a custom normalization library that needs to be made accessible to the
113 PostgreSQL server. This section explains how to set up the normalization
114 library.
115
116 ### Option 1: Compiling the library on the database server
117
118 The most sure way to get a working library is to compile it on the database
119 server. From the prerequisites you need at least cmake, gcc and the
120 PostgreSQL server package.
121
122 Clone or unpack the Nominatim source code, enter the source directory and
123 create and enter a build directory.
124
125 ```sh
126 cd Nominatim
127 mkdir build
128 cd build
129 ```
130
131 Now configure cmake to only build the PostgreSQL module and build it:
132
133 ```
134 cmake -DBUILD_IMPORTER=off -DBUILD_API=off -DBUILD_TESTS=off -DBUILD_DOCS=off -DBUILD_OSM2PGSQL=off ..
135 make
136 ```
137
138 When done, you find the normalization library in `build/module/nominatim.so`.
139 Copy it to a place where it is readable and executable by the PostgreSQL server
140 process.
141
142 ### Option 2: Compiling the library on the import machine
143
144 You can also compile the normalization library on the machine from where you
145 run the import.
146
147 !!! important
148     You can only do this when the database server and the import machine have
149     the same architecture and run the same version of Linux. Otherwise there is
150     no guarantee that the compiled library is compatible with the PostgreSQL
151     server running on the database server.
152
153 Make sure that the PostgreSQL server package is installed on the machine
154 **with the same version as on the database server**. You do not need to install
155 the PostgreSQL server itself.
156
157 Download and compile Nominatim as per standard instructions. Once done, you find
158 the normalization library in `build/module/nominatim.so`. Copy the file to
159 the database server at a location where it is readable and executable by the
160 PostgreSQL server process.
161
162 ### Running the import
163
164 On the client side you now need to configure the import to point to the
165 correct location of the library **on the database server**. Add the following
166 line to your your `.env` file:
167
168 ```php
169 NOMINATIM_DATABASE_MODULE_PATH="<directory on the database server where nominatim.so resides>"
170 ```
171
172 Now change the `NOMINATIM_DATABASE_DSN` to point to your remote server and continue
173 to follow the [standard instructions for importing](/admin/Import).