Merge remote-tracking branch 'upstream/master'

[nominatim.git] / docs / admin / Faq.md

diff --git a/docs/admin/Faq.md b/docs/admin/Faq.md
index 470e936c95f159bcaa30101a589c01f07c71a0a0..d618d2b5705edb865bde690c6cb9a3f0d231040d 100644 (file)
--- a/docs/admin/Faq.md
+++ b/docs/admin/Faq.md
@@ -1,29 +1,10 @@
-# Running Your Own Instance
+# Troubleshooting Nominatim Installations

 
 

-### Can I import only a few countries and also keep them up to date?
+## Installation Issues

 
 

-You should use the extracts and updates from https://download.geofabrik.de.
-For the intial import, download the countries you need and merge them.
-See [OSM Help](https://help.openstreetmap.org/questions/48843/merging-two-or-more-geographical-areas-to-import-two-or-more-osm-files-in-nominatim)
-for examples how to do that. Use the resulting single osm file when
-running `setup.php`.
-
-For updates you need to download the change files for each country
-once per day and apply them **separately** using
-
-    ./utils/update.php --import-diff <filename> --index
-    
-See [this issue](https://github.com/openstreetmap/Nominatim/issues/60#issuecomment-18679446)
-for a script that runs the updates using osmosis.
-
-### My website shows: `XML Parsing Error: XML or text declaration not at start of entity Location</code>.`
-
-Make sure there are no spaces at the beginning of your `settings/local.php` file.
+### Can a stopped/killed import process be resumed?

 
 

-
-# Installation
-
-### I accidentally killed the import process after it has been running for many hours. Can it be resumed?
+"I accidentally killed the import process after it has been running for many hours. Can it be resumed?"

 
 It is possible if the import already got to the indexing stage.
 Check the last line of output that was logged before the process
 
 It is possible if the import already got to the indexing stage.
 Check the last line of output that was logged before the process


@@ -41,28 +22,33 @@ then you can resume with the following command:
 If the reported rank is 26 or higher, you can also safely add `--index-noanalyse`.
 
 
 If the reported rank is 26 or higher, you can also safely add `--index-noanalyse`.
 
 

-### When running the setup.php script I get a warning:
-    `PHP Warning:  file_get_contents(): open_basedir restriction in effect.`
+### PHP "open_basedir restriction in effect" warnings

 
 

-You need to adjust the [open_basedir](http://www.php.net/manual/en/ini.core.php#ini.open-basedir) setting
-in your PHP configuration (php.ini file). By default this setting may look like this:
+    PHP Warning:  file_get_contents(): open_basedir restriction in effect.
+
+You need to adjust the
+[open_basedir](https://www.php.net/manual/en/ini.core.php#ini.open-basedir)
+setting in your PHP configuration (`php.ini` file). By default this setting may
+look like this:

 
     open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/
 
 
     open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/
 

-Either add reported directories to the list or disable this setting temporarily by 
-dding ";" at the beginning of the line. Don't forget to enable this setting again
-once you are done with the PHP command line operations.
+Either add reported directories to the list or disable this setting temporarily
+by adding ";" at the beginning of the line. Don't forget to enable this setting
+again once you are done with the PHP command line operations.
+

 
 

+### PHP timzeone warnings

 
 

-### The Apache log contains lots of PHP warnings like this:
+The Apache log may contain lots of PHP warnings like this:

     `PHP Warning:  date_default_timezone_set() function.`
 
 You should set the default time zone as instructed in the warning in
 your `php.ini` file. Find the entry about timezone and set it to
 something like this:
     `PHP Warning:  date_default_timezone_set() function.`
 
 You should set the default time zone as instructed in the warning in
 your `php.ini` file. Find the entry about timezone and set it to
 something like this:

-  
+

     ; Defines the default timezone used by the date functions
     ; Defines the default timezone used by the date functions

-    ; http://php.net/date.timezone
+    ; https://php.net/date.timezone

     date.timezone = 'America/Denver'
 
 Or
     date.timezone = 'America/Denver'
 
 Or


@@ -71,33 +57,68 @@ Or
 echo "date.timezone = 'America/Denver'" > /etc/php.d/timezone.ini
 ```
 
 echo "date.timezone = 'America/Denver'" > /etc/php.d/timezone.ini
 ```
 

-### When running the import I get a version mismatch:
-    `COPY_END for place failed: ERROR: incompatible library "/opt/Nominatim/module/nominatim.so": version mismatch`
+### nominatim.so version mismatch
+
+When running the import you may get a version mismatch:
+`COPY_END for place failed: ERROR: incompatible library "/srv/Nominatim/nominatim/build/module/nominatim.so": version mismatch`

 
 pg_config seems to use bad includes sometimes when multiple versions
 of PostgreSQL are available in the system. Make sure you remove the
 
 pg_config seems to use bad includes sometimes when multiple versions
 of PostgreSQL are available in the system. Make sure you remove the

-server development libraries (`postgresql-server-dev-9.1` on Ubuntu)
+server development libraries (`postgresql-server-dev-9.5` on Ubuntu)

 and recompile (`cmake .. && make`).
 
 
 and recompile (`cmake .. && make`).
 
 

-### I see the error: `function transliteration(text) does not exist`
+### I see the error "ERROR: permission denied for language c"
+
+`nominatim.so`, written in C, is required to be installed on the database
+server. Some managed database (cloud) services like Amazon RDS do not allow
+this. There is currently no work-around other than installing a database
+on a non-managed machine.
+
+
+### I see the error: "function transliteration(text) does not exist"

 
 Reinstall the nominatim functions with `setup.php --create--functions`
 and check for any errors, e.g. a missing `nominatim.so` file.
 
 
 Reinstall the nominatim functions with `setup.php --create--functions`
 and check for any errors, e.g. a missing `nominatim.so` file.
 

+### I see the error: "ERROR: mmap (remap) failed"
+
+This may be a simple out-of-memory error. Try reducing the memory used
+for `--osm2pgsql-cache`. Also make sure that overcommitting memory is
+allowed: `cat /proc/sys/vm/overcommit_memory` should print 0 or 1.
+
+If you are using a flatnode file, then it may also be that the underlying
+filesystem does not fully support 'mmap'. A notable candidate is virtualbox's
+vboxfs.
+
+### I see the error: "clang: Command not found" on CentOS
+
+On CentOS 7 users reported `/opt/rh/llvm-toolset-7/root/usr/bin/clang: Command not found`.
+Double-check clang is installed. Instead of `make` try running `make CLANG=true`.

 
 

-### The website shows: `Could not get word tokens`
+### nominatim UPDATE failed: ERROR: buffer 179261 is not owned by resource owner Portal
+
+Several users [reported this](https://github.com/openstreetmap/Nominatim/issues/1168) during the initial import of the database. It's
+something PostgreSQL internal Nominatim doesn't control. And PostgreSQL forums
+suggest it's threading related but definitely some kind of crash of a process.
+Users reported either rebooting the server, different hardware or just trying
+the import again worked.
+
+### The website shows: "Could not get word tokens"

 
 The server cannot access your database. Add `&debug=1` to your URL
 to get the full error message.
 
 
 
 The server cannot access your database. Add `&debug=1` to your URL
 to get the full error message.
 
 

-### On CentOS the website shows `could not connect to server: No such file or directory`
+### On CentOS the website shows "Could not connect to server"
+
+`could not connect to server: No such file or directory`

 
 

-On CentOS v7 the PostgreSQL server is started with `systemd`.
-Check if `/usr/lib/systemd/system/httpd.service` contains a line `PrivateTmp=true`.
-If so then Apache cannot see the `/tmp/.s.PGSQL.5432` file. It's a good security feature,
-so use the [preferred solution](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
+On CentOS v7 the PostgreSQL server is started with `systemd`. Check if
+`/usr/lib/systemd/system/httpd.service` contains a line `PrivateTmp=true`. If
+so then Apache cannot see the `/tmp/.s.PGSQL.5432` file. It's a good security
+feature, so use the
+[preferred solution](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).

 
 However, you can solve this the quick and dirty way by commenting out that line and then run
 
 
 However, you can solve this the quick and dirty way by commenting out that line and then run
 


@@ -105,22 +126,86 @@ However, you can solve this the quick and dirty way by commenting out that line
     sudo systemctl restart httpd
 
 
     sudo systemctl restart httpd
 
 

-### Setup.php fails with the message: `DB Error: extension not found`
+### Website reports "DB Error: insufficient permissions"

 
 

-Make sure you have the Postgres extensions hstore and postgis installed.
-See the installation instruction for a full list of required packages.
+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`.

 
 

-### When running the setup.php script I get a error:
-    `Cannot redeclare getDB() (previously declared in /your/path/Nominatim/lib/db.php:4)`
+1. Repeat the `createuser` step of the installation instructions.

 
 

-The message is a bit misleading as PHP needs to load the file `DB.php` and
-instead re-loads Nominatim's `db.php`. To solve this make sure you
-have the [http://pear.php.net/package/DB/ Pear module 'DB'] installed.
+2. Give the user permission to existing tables
+
+```
+   GRANT usage ON SCHEMA public TO "www-data";
+   GRANT SELECT ON ALL TABLES IN SCHEMA public TO "www-data";
+```
+
+### Website reports "Could not load library "nominatim.so"
+
+Example error message
+
+```
+   SELECT make_standard_name('3039 E MEADOWLARK LN') [nativecode=ERROR: could not
+   load library "/srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so":
+   /srv/nominatim/Nominatim-3.1.0/build/module/nominatim.so: cannot open shared
+   object file: Permission denied
+   CONTEXT: PL/pgSQL function make_standard_name(text) line 5 at assignment]
+```
+
+The PostgreSQL database, i.e. user `postgres`, needs to have access to that file.
+
+The permission need to be read & executable by everybody, e.g.
+
+```
+   -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so
+```
+
+Try `chmod a+r nominatim.so; chmod a+x nominatim.so`.
+
+When running SELinux, make sure that the
+[context is set up correctly](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
+
+### Setup.php fails with "DB Error: extension not found"
+
+Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed.
+See the installation instructions for a full list of required packages.

 
 

-    sudo pear install DB

 
 ### I forgot to delete the flatnodes file before starting an import.
 
 That's fine. For each import the flatnodes file get overwritten.
 
 ### I forgot to delete the flatnodes file before starting an import.
 
 That's fine. For each import the flatnodes file get overwritten.

-See https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage
+See [https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage]()

 for more information.
 for more information.

+
+
+## Running your own instance
+
+### Can I import multiple countries and keep them up to date?
+
+You should use the extracts and updates from https://download.geofabrik.de.
+For the initial import, download the countries you need and merge them.
+See [OSM Help](https://help.openstreetmap.org/questions/48843/merging-two-or-more-geographical-areas-to-import-two-or-more-osm-files-in-nominatim)
+for examples how to do that. Use the resulting single osm file when
+running `setup.php`.
+
+For updates you need to download the change files for each country
+once per day and apply them **separately** using
+
+    ./utils/update.php --import-diff <filename> --index
+
+See [this issue](https://github.com/openstreetmap/Nominatim/issues/60#issuecomment-18679446)
+for a script that runs the updates using osmosis.
+
+### Can I import negative OSM ids into Nominatim?
+
+See [this question of Stackoverflow](https://help.openstreetmap.org/questions/64662/nominatim-flatnode-with-negative-id).
+
+### Missing XML or text declaration
+
+The website might show: `XML Parsing Error: XML or text declaration not at start of entity Location.`
+
+Make sure there are no spaces at the beginning of your `settings/local.php` file.
+
+