]> git.openstreetmap.org Git - nominatim.git/blob - docs/admin/Faq.md
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / docs / admin / Faq.md
1 # Troubleshooting Nominatim Installations
2
3 ## Installation Issues
4
5 ### Can a stopped/killed import process be resumed?
6
7 "I accidentally killed the import process after it has been running for many hours. Can it be resumed?"
8
9 It is possible if the import already got to the indexing stage.
10 Check the last line of output that was logged before the process
11 was killed. If it looks like this:
12
13
14     Done 844 in 13 @ 64.923080 per second - Rank 26 ETA (seconds): 7.886255
15
16 then you can resume with the following command:
17
18 ```sh
19 ./utils/setup.php --index --create-search-indices --create-country-names
20 ```
21
22 If the reported rank is 26 or higher, you can also safely add `--index-noanalyse`.
23
24
25 ### PHP "open_basedir restriction in effect" warnings
26
27     `PHP Warning:  file_get_contents(): open_basedir restriction in effect.`
28
29 You need to adjust the [open_basedir](http://www.php.net/manual/en/ini.core.php#ini.open-basedir) setting
30 in your PHP configuration (`php.ini file`). By default this setting may look like this:
31
32     open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/
33
34 Either add reported directories to the list or disable this setting temporarily by 
35 dding ";" at the beginning of the line. Don't forget to enable this setting again
36 once you are done with the PHP command line operations.
37
38
39 ### PHP timzeone warnings
40
41 The Apache log may contain lots of PHP warnings like this:
42     `PHP Warning:  date_default_timezone_set() function.`
43
44 You should set the default time zone as instructed in the warning in
45 your `php.ini` file. Find the entry about timezone and set it to
46 something like this:
47   
48     ; Defines the default timezone used by the date functions
49     ; http://php.net/date.timezone
50     date.timezone = 'America/Denver'
51
52 Or
53
54 ```
55 echo "date.timezone = 'America/Denver'" > /etc/php.d/timezone.ini
56 ```
57
58 ### nominatim.so version mismatch
59
60 When running the import you may get a version mismatch:
61 `COPY_END for place failed: ERROR: incompatible library "/srv/Nominatim/nominatim/build/module/nominatim.so": version mismatch`
62
63 pg_config seems to use bad includes sometimes when multiple versions
64 of PostgreSQL are available in the system. Make sure you remove the
65 server development libraries (`postgresql-server-dev-9.5` on Ubuntu)
66 and recompile (`cmake .. && make`).
67
68
69 ### I see the error: "function transliteration(text) does not exist"
70
71 Reinstall the nominatim functions with `setup.php --create--functions`
72 and check for any errors, e.g. a missing `nominatim.so` file.
73
74 ### I see the error: "ERROR: mmap (remap) failed"
75
76 This may be a simple out-of-memory error. Try reducing the memory used
77 for `--osm2pgsql-cache`. Also make sure that overcommitting memory is
78 allowed: `cat /proc/sys/vm/overcommit_memory` should print 0 or 1.
79
80 If you are using a flatnode file, then it may also be that the underlying
81 filesystem does not fully support 'mmap'. A notable candidate is virtualbox's
82 vboxfs.
83
84 ### The website shows: "Could not get word tokens"
85
86 The server cannot access your database. Add `&debug=1` to your URL
87 to get the full error message.
88
89
90 ### On CentOS the website shows "Could not connect to server"
91
92 `could not connect to server: No such file or directory`
93
94 On CentOS v7 the PostgreSQL server is started with `systemd`.
95 Check if `/usr/lib/systemd/system/httpd.service` contains a line `PrivateTmp=true`.
96 If so then Apache cannot see the `/tmp/.s.PGSQL.5432` file. It's a good security feature,
97 so use the [preferred solution](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
98
99 However, you can solve this the quick and dirty way by commenting out that line and then run
100
101     sudo systemctl daemon-reload
102     sudo systemctl restart httpd
103
104
105 ### "must be an array or an object that implements Countable" warning in /usr/share/pear/DB.php
106
107 As reported starting PHP 7.2. This external DB library is no longer maintained and will be replaced in future Nominatim versions. In the meantime you'd have to manually change the line near 774 from
108 `if (!count($dsn)) {` to  `if (!$dsn && !count($dsn))`. [More details](https://github.com/openstreetmap/Nominatim/issues/1184)
109
110
111
112
113 ### Website reports "DB Error: insufficient permissions"
114
115 The user the webserver, e.g. Apache, runs under needs to have access to the Nominatim database. You can find the user like [this](https://serverfault.com/questions/125865/finding-out-what-user-apache-is-running-as), for default Ubuntu operating system for example it's `www-data`.
116
117 1. Repeat the `createuser` step of the installation instructions.
118
119 2. Give the user permission to existing tables
120
121 ```
122    GRANT usage ON SCHEMA public TO "www-data";
123    GRANT SELECT ON ALL TABLES IN SCHEMA public TO "www-data";
124 ```
125
126 ### Website reports "Could not load library "nominatim.so"
127
128 Example error message
129
130 ```
131    SELECT make_standard_name('3039 E MEADOWLARK LN') [nativecode=ERROR: could not
132    load library "/srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so":
133    /srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so: cannot open shared
134    object file: Permission denied
135    CONTEXT: PL/pgSQL function make_standard_name(text) line 5 at assignment]
136 ```
137
138 The Postgresql database, i.e. user postgres, needs to have access to that file.
139
140 The permission need to be read & executable by everybody, e.g.
141
142 ```
143    -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so
144 ```
145
146 Try `chmod a+r nominatim.so; chmod a+x nominatim.so`.
147
148 When running SELinux, make sure that the
149 [context is set up correctly](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
150
151 ### Setup.php fails with "DB Error: extension not found"
152
153 Make sure you have the Postgres extensions hstore and postgis installed.
154 See the installation instruction for a full list of required packages.
155
156
157 ### Setup.php reports "Cannot redeclare getDB()"
158
159 `Cannot redeclare getDB() (previously declared in /your/path/Nominatim/lib/db.php:4)`
160
161 The message is a bit misleading as PHP needs to load the file `DB.php` and
162 instead re-loads Nominatim's `db.php`. To solve this make sure you
163 have the [Pear module 'DB'](http://pear.php.net/package/DB/) installed.
164
165     sudo pear install DB
166
167 ### I forgot to delete the flatnodes file before starting an import.
168
169 That's fine. For each import the flatnodes file get overwritten.
170 See [https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage]()
171 for more information.
172
173
174 ## Running your own instance
175
176 ### Can I import multiple countries and keep them up to date?
177
178 You should use the extracts and updates from https://download.geofabrik.de.
179 For the initial import, download the countries you need and merge them.
180 See [OSM Help](https://help.openstreetmap.org/questions/48843/merging-two-or-more-geographical-areas-to-import-two-or-more-osm-files-in-nominatim)
181 for examples how to do that. Use the resulting single osm file when
182 running `setup.php`.
183
184 For updates you need to download the change files for each country
185 once per day and apply them **separately** using
186
187     ./utils/update.php --import-diff <filename> --index
188     
189 See [this issue](https://github.com/openstreetmap/Nominatim/issues/60#issuecomment-18679446)
190 for a script that runs the updates using osmosis.
191
192 ### Can I import negative OSM ids into Nominatim?
193
194 See [this question of Stackoverflow](https://help.openstreetmap.org/questions/64662/nominatim-flatnode-with-negative-id).
195
196 ### Missing XML or text declaration
197
198 The website might show: `XML Parsing Error: XML or text declaration not at start of entity Location.`
199
200 Make sure there are no spaces at the beginning of your `settings/local.php` file.
201
202