]> git.openstreetmap.org Git - nominatim.git/blob - docs/admin/Faq.md
add documentation for public interface of SearchDescription
[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 nominatim import --continue indexing
20 ```
21
22 If the reported rank is 26 or higher, you can also safely add `--index-noanalyse`.
23
24
25 ### PostgreSQL crashed "invalid page in block"
26
27 Usually serious problem, can be a hardware issue, not all data written to disc
28 for example. Check PostgreSQL log file and search PostgreSQL issues/mailing
29 list for hints.
30
31 If it happened during index creation you can try rerunning the step with
32
33 ```sh
34 nominatim import --continue indexing
35 ```
36
37 Otherwise it's best to start the full setup from the beginning.
38
39
40 ### PHP "open_basedir restriction in effect" warnings
41
42     PHP Warning:  file_get_contents(): open_basedir restriction in effect.
43
44 You need to adjust the
45 [open_basedir](https://www.php.net/manual/en/ini.core.php#ini.open-basedir)
46 setting in your PHP configuration (`php.ini` file). By default this setting may
47 look like this:
48
49     open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/
50
51 Either add reported directories to the list or disable this setting temporarily
52 by adding ";" at the beginning of the line. Don't forget to enable this setting
53 again once you are done with the PHP command line operations.
54
55
56 ### PHP timezeone warnings
57
58 The Apache log may contain lots of PHP warnings like this:
59     `PHP Warning:  date_default_timezone_set() function.`
60
61 You should set the default time zone as instructed in the warning in
62 your `php.ini` file. Find the entry about timezone and set it to
63 something like this:
64
65     ; Defines the default timezone used by the date functions
66     ; https://php.net/date.timezone
67     date.timezone = 'America/Denver'
68
69 Or
70
71 ```
72 echo "date.timezone = 'America/Denver'" > /etc/php.d/timezone.ini
73 ```
74
75 ### nominatim.so version mismatch
76
77 When running the import you may get a version mismatch:
78 `COPY_END for place failed: ERROR: incompatible library "/srv/Nominatim/nominatim/build/module/nominatim.so": version mismatch`
79
80 pg_config seems to use bad includes sometimes when multiple versions
81 of PostgreSQL are available in the system. Make sure you remove the
82 server development libraries (`postgresql-server-dev-9.5` on Ubuntu)
83 and recompile (`cmake .. && make`).
84
85
86 ### I see the error "ERROR: permission denied for language c"
87
88 `nominatim.so`, written in C, is required to be installed on the database
89 server. Some managed database (cloud) services like Amazon RDS do not allow
90 this. There is currently no work-around other than installing a database
91 on a non-managed machine.
92
93
94 ### I see the error: "function transliteration(text) does not exist"
95
96 Reinstall the nominatim functions with `nominatim refresh --functions`
97 and check for any errors, e.g. a missing `nominatim.so` file.
98
99 ### I see the error: "ERROR: mmap (remap) failed"
100
101 This may be a simple out-of-memory error. Try reducing the memory used
102 for `--osm2pgsql-cache`. Also make sure that overcommitting memory is
103 allowed: `cat /proc/sys/vm/overcommit_memory` should print 0 or 1.
104
105 If you are using a flatnode file, then it may also be that the underlying
106 filesystem does not fully support 'mmap'. A notable candidate is virtualbox's
107 vboxfs.
108
109 ### I see the error: "clang: Command not found" on CentOS
110
111 On CentOS 7 users reported `/opt/rh/llvm-toolset-7/root/usr/bin/clang: Command not found`.
112 Double-check clang is installed. Instead of `make` try running `make CLANG=true`.
113
114 ### nominatim UPDATE failed: ERROR: buffer 179261 is not owned by resource owner Portal
115
116 Several users [reported this](https://github.com/openstreetmap/Nominatim/issues/1168)
117 during the initial import of the database. It's
118 something PostgreSQL internal Nominatim doesn't control. And PostgreSQL forums
119 suggest it's threading related but definitely some kind of crash of a process.
120 Users reported either rebooting the server, different hardware or just trying
121 the import again worked.
122
123 ### The website shows: "Could not get word tokens"
124
125 The server cannot access your database. Add `&debug=1` to your URL
126 to get the full error message.
127
128
129 ### On CentOS the website shows "Could not connect to server"
130
131 `could not connect to server: No such file or directory`
132
133 On CentOS v7 the PostgreSQL server is started with `systemd`. Check if
134 `/usr/lib/systemd/system/httpd.service` contains a line `PrivateTmp=true`. If
135 so then Apache cannot see the `/tmp/.s.PGSQL.5432` file. It's a good security
136 feature, so use the
137 [preferred solution](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
138
139 However, you can solve this the quick and dirty way by commenting out that line and then run
140
141     sudo systemctl daemon-reload
142     sudo systemctl restart httpd
143
144
145 ### Website reports "DB Error: insufficient permissions"
146
147 The user the webserver, e.g. Apache, runs under needs to have access to the
148 Nominatim database. You can find the user like
149 [this](https://serverfault.com/questions/125865/finding-out-what-user-apache-is-running-as),
150 for default Ubuntu operating system for example it's `www-data`.
151
152 1. Repeat the `createuser` step of the installation instructions.
153
154 2. Give the user permission to existing tables
155
156 ```
157    GRANT usage ON SCHEMA public TO "www-data";
158    GRANT SELECT ON ALL TABLES IN SCHEMA public TO "www-data";
159 ```
160
161 ### Website reports "Could not load library "nominatim.so"
162
163 Example error message
164
165 ```
166    SELECT make_standard_name('3039 E MEADOWLARK LN') [nativecode=ERROR: could not
167    load library "/srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so":
168    /srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so: cannot open shared
169    object file: Permission denied
170    CONTEXT: PL/pgSQL function make_standard_name(text) line 5 at assignment]
171 ```
172
173 The PostgreSQL database, i.e. user `postgres`, needs to have access to that file.
174
175 The permission need to be read & executable by everybody, but not writeable
176 by everybody, e.g.
177
178 ```
179    -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so
180 ```
181
182 Try `chmod a+r nominatim.so; chmod a+x nominatim.so`.
183
184 When running SELinux, make sure that the
185 [context is set up correctly](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
186
187 When you recently updated your operating system, updated PostgreSQL to
188 a new version or moved files (e.g. the build directory) you should
189 recreate `nominatim.so`. Try
190
191 ```
192    cd build
193    rm -r module/
194    cmake $main_Nominatim_path && make
195 ```
196
197 ### Setup.php fails with "DB Error: extension not found"
198
199 Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed.
200 See the installation instructions for a full list of required packages.
201
202
203 ### I forgot to delete the flatnodes file before starting an import.
204
205 That's fine. For each import the flatnodes file get overwritten.
206 See [https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage](https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage)
207 for more information.
208
209
210 ## Running your own instance
211
212 ### Can I import negative OSM ids into Nominatim?
213
214 See [this question of Stackoverflow](https://help.openstreetmap.org/questions/64662/nominatim-flatnode-with-negative-id).