add mkdocstrings requirement for building docs

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

diff --git a/docs/admin/Faq.md b/docs/admin/Faq.md
index 2e5a7c4334fb6e30a125af3659a63915788adeea..b8b900d019be9ecb50025aa212d33ceffee19e42 100644 (file)
--- a/docs/admin/Faq.md
+++ b/docs/admin/Faq.md
@@ -16,12 +16,27 @@ was killed. If it looks like this:
 then you can resume with the following command:
 
 ```sh
 then you can resume with the following command:
 
 ```sh

-./utils/setup.php --index --create-search-indices --create-country-names
+nominatim import --continue indexing

 ```
 
 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`.
 
 

+### PostgreSQL crashed "invalid page in block"
+
+Usually serious problem, can be a hardware issue, not all data written to disc
+for example. Check PostgreSQL log file and search PostgreSQL issues/mailing
+list for hints.
+
+If it happened during index creation you can try rerunning the step with
+
+```sh
+nominatim import --continue indexing
+```
+
+Otherwise it's best to start the full setup from the beginning.
+
+

 ### PHP "open_basedir restriction in effect" warnings
 
     PHP Warning:  file_get_contents(): open_basedir restriction in effect.
 ### PHP "open_basedir restriction in effect" warnings
 
     PHP Warning:  file_get_contents(): open_basedir restriction in effect.


@@ -38,7 +53,7 @@ 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.
 
 
 again once you are done with the PHP command line operations.
 
 

-### PHP timzeone warnings
+### PHP timezeone warnings

 
 The Apache log may contain lots of PHP warnings like this:
     `PHP Warning:  date_default_timezone_set() function.`
 
 The Apache log may contain lots of PHP warnings like this:
     `PHP Warning:  date_default_timezone_set() function.`


@@ -68,7 +83,7 @@ server development libraries (`postgresql-server-dev-9.5` on Ubuntu)
 and recompile (`cmake .. && make`).
 
 
 and recompile (`cmake .. && make`).
 
 

-## I see the error "ERROR: permission denied for language c"
+### 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
 
 `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


@@ -78,7 +93,7 @@ on a non-managed machine.
 
 ### I see the error: "function transliteration(text) does not exist"
 
 
 ### I see the error: "function transliteration(text) does not exist"
 

-Reinstall the nominatim functions with `setup.php --create--functions`
+Reinstall the nominatim functions with `nominatim refresh --functions`

 and check for any errors, e.g. a missing `nominatim.so` file.
 
 ### I see the error: "ERROR: mmap (remap) failed"
 and check for any errors, e.g. a missing `nominatim.so` file.
 
 ### I see the error: "ERROR: mmap (remap) failed"


@@ -91,9 +106,15 @@ 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.
 
 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`.
+

 ### nominatim UPDATE failed: ERROR: buffer 179261 is not owned by resource owner Portal
 
 ### 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
+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
 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


@@ -151,7 +172,8 @@ Example error message
 
 The PostgreSQL database, i.e. user `postgres`, needs to have access to that file.
 
 
 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.
+The permission need to be read & executable by everybody, but not writeable
+by everybody, e.g.

 
 ```
    -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so
 
 ```
    -rwxr-xr-x 1 nominatim nominatim 297984 build/module/nominatim.so


@@ -162,6 +184,16 @@ 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).
 
 When running SELinux, make sure that the
 [context is set up correctly](../appendix/Install-on-Centos-7/#adding-selinux-security-settings).
 

+When you recently updated your operating system, updated PostgreSQL to
+a new version or moved files (e.g. the build directory) you should
+recreate `nominatim.so`. Try
+
+```
+   cd build
+   rm -r module/
+   cmake $main_Nominatim_path && make
+```
+

 ### Setup.php fails with "DB Error: extension not found"
 
 Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed.
 ### Setup.php fails with "DB Error: extension not found"
 
 Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed.


@@ -171,36 +203,12 @@ See the installation instructions for a full list of required packages.
 ### 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](https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage)

 for more information.
 
 
 ## Running your own instance
 
 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).
 ### 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.
-
-