docs: rework library getting started

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

diff --git a/docs/admin/Faq.md b/docs/admin/Faq.md
index 2e5a7c4334fb6e30a125af3659a63915788adeea..efcd5741229fa20914c3328c88ef077a46c3aa9d 100644 (file)
--- a/docs/admin/Faq.md
+++ b/docs/admin/Faq.md
@@ -16,46 +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`.
 
 

-### PHP "open_basedir restriction in effect" warnings
+### PostgreSQL crashed "invalid page in block"

 
 

-    PHP Warning:  file_get_contents(): open_basedir restriction in effect.
+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.

 
 

-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:
+If it happened during index creation you can try rerunning the step with

 
 

-    open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/
-
-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 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:
+```sh
+nominatim import --continue indexing
+```

 
 

-    ; Defines the default timezone used by the date functions
-    ; https://php.net/date.timezone
-    date.timezone = 'America/Denver'
+Otherwise it's best to start the full setup from the beginning.

 
 

-Or

 
 

-```
-echo "date.timezone = 'America/Denver'" > /etc/php.d/timezone.ini
-```

 
 ### nominatim.so version mismatch
 
 
 ### nominatim.so version mismatch
 


@@ -64,11 +45,11 @@ When running the import you may get a 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.5` on Ubuntu)
+server development libraries (`postgresql-server-dev-13` 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 +59,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"


@@ -93,7 +74,8 @@ vboxfs.
 
 ### 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


@@ -105,22 +87,6 @@ The server cannot access your database. Add `&debug=1` to your URL
 to get the full error message.
 
 
 to get the full error message.
 
 

-### 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).
-
-However, you can solve this the quick and dirty way by commenting out that line and then run
-
-    sudo systemctl daemon-reload
-    sudo systemctl restart httpd
-
-

 ### Website reports "DB Error: insufficient permissions"
 
 The user the webserver, e.g. Apache, runs under needs to have access to the
 ### Website reports "DB Error: insufficient permissions"
 
 The user the webserver, e.g. Apache, runs under needs to have access to the


@@ -151,7 +117,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


@@ -159,48 +126,50 @@ The permission need to be read & executable by everybody, e.g.
 
 Try `chmod a+r nominatim.so; chmod a+x 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).
+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"
+### Setup 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.
 
 
 
 Make sure you have the PostgreSQL extensions "hstore" and "postgis" installed.
 See the installation instructions for a full list of required packages.
 
 

-### I forgot to delete the flatnodes file before starting an import.
+### UnicodeEncodeError: 'ascii' codec can't encode character

 
 

-That's fine. For each import the flatnodes file get overwritten.
-See [https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage]()
-for more information.
+Make sure that the operating system's locale is UTF-8. With some prebuilt
+images (e.g. LXC containers from Proxmox, see
+[discussion](https://github.com/osm-search/Nominatim/discussions/2343)) or
+images that optimize for size it might be missing.

 
 

+On Ubuntu you can check the locale is installed:

 
 

-## Running your own instance
+```
+   grep UTF-8 /etc/default/locale
+```
+
+And install it using

 
 

-### Can I import multiple countries and keep them up to date?
+```
+   dpkg-reconfigure locales
+```

 
 

-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`.
+### I forgot to delete the flatnodes file before starting an import.

 
 

-For updates you need to download the change files for each country
-once per day and apply them **separately** using
+That's fine. For each import the flatnodes file get overwritten.
+See [https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage](https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage)
+for more information.

 
 

-    ./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.
+## Running your own instance

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