use mkdocs for compiling the documentation

Requires to shuffle around the documentation. make doc will now compile the documentation in the build directory. The markdowns created from the vagrant files are no longer versioned.
2018-01-14 23:43:15 +01:00
parent e080ccbcf8
commit b8f7563da9
10 changed files with 190 additions and 517 deletions
--- a/docs/admin/Faq.md
+++ b/docs/admin/Faq.md
@@ -0,0 +1,126 @@
+# Running Your Own Instance
+
+### Can I import only a few countries and also keep them up to date?
+
+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.
+
+
+# Installation
+
+### 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
+was killed. If it looks like this:
+
+
+    Done 844 in 13 @ 64.923080 per second - Rank 26 ETA (seconds): 7.886255
+
+then you can resume with the following command:
+
+```sh
+./utils/setup.php --index --create-search-indices --create-country-names
+```
+
+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.`
+
+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:
+
+    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.
+
+
+### The Apache log contains 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:
+  
+    ; Defines the default timezone used by the date functions
+    ; http://php.net/date.timezone
+    date.timezone = 'America/Denver'
+
+Or
+
+```
+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`
+
+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)
+and recompile (`cmake .. && make`).
+
+
+### 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.
+
+
+### 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.
+
+
+### On CentOS the website shows `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
+
+
+### Setup.php fails with the message: `DB Error: extension not found`
+
+Make sure you have the Postgres extensions hstore and postgis installed.
+See the installation instruction for a full list of required packages.
+
+### When running the setup.php script I get a error:
+    `Cannot redeclare getDB() (previously declared in /your/path/Nominatim/lib/db.php:4)`
+
+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.
+
+    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.
+See https://help.openstreetmap.org/questions/52419/nominatim-flatnode-storage
+for more information.
--- a/docs/admin/Import-and-Update.md
+++ b/docs/admin/Import-and-Update.md
@@ -0,0 +1,214 @@
+The following instructions explain how to create a Nominatim database
+from an OSM planet file and how to keep the database up to date. It
+is assumed that you have already successfully installed the Nominatim
+software itself, if not return to the [installation page](Installation.md).
+
+# Configuration setup in settings/local.php
+
+The Nominatim server can be customized via the file `settings/local.php`
+in the build directory. Note that this is a PHP file, so it must always
+start like this:
+
+    <?php
+
+without any leading spaces.
+
+There are lots of configuration settings you can tweak. Have a look
+at `settings/default.php` for a full list. Most should have a sensible default.
+
+### Flatnode files
+
+If you plan to import a large dataset (e.g. Europe, North America, planet),
+you should also enable flatnode storage of node locations. With this
+setting enabled, node coordinates are stored in a simple file instead
+of the database. This will save you import time and disk storage.
+Add to your `settings/local.php`:
+
+    @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
+
+Replace the second part with a suitable path on your system and make sure
+the directory exists. There should be at least 40GB of free space.
+
+# Downloading additional data
+
+## Wikipedia rankings
+
+Wikipedia can be used as an optional auxiliary data source to help indicate
+the importance of osm features. Nominatim will work without this information
+but it will improve the quality of the results if this is installed.
+This data is available as a binary download:
+
+    cd $NOMINATIM_SOURCE_DIR/data
+    wget https://www.nominatim.org/data/wikipedia_article.sql.bin
+    wget https://www.nominatim.org/data/wikipedia_redirect.sql.bin
+
+Combined the 2 files are around 1.5GB and add around 30GB to the install
+size of nominatim. They also increase the install time by an hour or so.
+
+*NOTE:* you'll need to download the Wikipedia rankings before performing
+the initial import of the data if you want the rankings applied to the
+loaded data.
+
+## UK postcodes
+
+Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded: 
+
+    cd $NOMINATIM_SOURCE_DIR/data
+    wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
+
+
+# Initial import of the data
+
+**Important:** first try the import with a small excerpt, for example from
+[Geofabrik](https://download.geofabrik.de).
+
+Download the data to import and load the data with the following command:
+
+```sh
+./utils/setup.php --osm-file <data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
+```
+
+The `--osm2pgsql-cache` parameter is optional but strongly recommended for
+planet imports. It sets the node cache size for the osm2pgsql import part
+(see `-C` parameter in osm2pgsql help). As a rule of thumb, this should be
+about the same size as the file you are importing but never more than
+2/3 of RAM available. If your machine starts swapping reduce the size.
+
+Computing word frequency for search terms can improve the performance of
+forward geocoding in particular under high load as it helps Postgres' query
+planner to make the right decisions. To recompute word counts run:
+
+```sh
+./utils/update.php --recompute-word-counts
+```
+
+This will take a couple of hours for a full planet installation. You can
+also defer that step to a later point in time when you realise that
+performance becomes an issue. Just make sure that updates are stopped before
+running this function.
+
+If you want to be able to search for places by their type through
+[special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
+you also need to enable these key phrases like this:
+
+    ./utils/specialphrases.php --wiki-import > specialphrases.sql
+    psql -d nominatim -f specialphrases.sql
+
+Note that this command downloads the phrases from the wiki link above.
+
+
+# Installing Tiger housenumber data for the US
+
+Nominatim is able to use the official TIGER address set to complement the
+OSM house number data in the US. You can add TIGER data to your own Nominatim
+instance by following these steps:
+
+  1. Install the GDAL library and python bindings and the unzip tool
+
+       * Ubuntu: `sudo apt-get install python-gdal unzip`
+       * CentOS: `sudo yum install gdal-python unzip`
+
+  2. Get preprocessed TIGER 2015 data and unpack it into the
+     data directory in your Nominatim sources:
+
+        cd Nominatim/data
+        wget https://nominatim.org/data/tiger2017-nominatim-preprocessed.tar.gz
+        tar xf tiger2017-nominatim-preprocessed.tar.gz
+
+  3. Import the data into your Nominatim database: 
+
+        ./utils/setup.php --import-tiger-data
+
+  4. Enable use of the Tiger data in your `settings/local.php` by adding:
+
+         @define('CONST_Use_US_Tiger_Data', true);
+
+  5. Apply the new settings:
+
+```sh
+    ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
+```
+
+The entire US adds about 10GB to your database.
+
+You can also process the data from the original TIGER data to create the
+SQL files, Nominatim needs for the import:
+
+  1. Get the TIGER 2017 data. You will need the EDGES files
+     (3,234 zip files, 11GB total). Choose one of the two sources:
+
+         wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2017/EDGES/
+         wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2017/EDGES/
+
+     The first one is the original source, the second a considerably faster
+     mirror.
+
+  2. Convert the data into SQL statements: 
+
+         ./utils/imports.php --parse-tiger <tiger edge data directory>
+
+Be warned that this can take quite a long time. After this process is finished,
+the same preprocessed files as above are available in `data/tiger`.
+
+# Updates
+
+There are many different possibilities to update your Nominatim database.
+The following section describes how to keep it up-to-date with Pyosmium.
+For a list of other methods see the output of `./utils/update.php --help`.
+
+### Installing the newest version of Pyosmium
+
+It is recommended to install Pyosmium via pip. Run (as the same user who
+will later run the updates):
+
+```sh
+pip install --user osmium
+```
+
+Nominatim needs a tool called `pyosmium-get-updates` that comes with
+Pyosmium. You need to tell Nominatim where to find it. Add the
+following line to your `settings/local.php`:
+
+    @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
+
+The path above is fine if you used the `--user` parameter with pip.
+Replace `user` with your user name.
+
+### Setting up the update process
+
+Next the update needs to be initialised. By default Nominatim is configured
+to update using the global minutely diffs.
+
+If you want a different update source you will need to add some settings
+to `settings/local.php`. For example, to use the daily country extracts
+diffs for Ireland from geofabrik add the following:
+
+    // base URL of the replication service
+    @define('CONST_Replication_Url', 'https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
+    // How often upstream publishes diffs
+    @define('CONST_Replication_Update_Interval', '86400');
+    // How long to sleep if no update found yet
+    @define('CONST_Replication_Recheck_Interval', '900');
+
+To set up the update process now run the following command:
+
+    ./utils/update.php --init-updates
+
+It outputs the date where updates will start. Recheck that this date is
+what you expect.
+
+The --init-updates command needs to be rerun whenever the replication service
+is changed.
+
+### Updating Nominatim
+
+The following command will keep your database constantly up to date:
+
+    ./utils/update.php --import-osmosis-all
+
+(Note that even though the old name "import-osmosis-all" has been kept for compatibility reasons, Osmosis is not required to run this - it uses pyosmium behind the scenes.)
+
+If you have imported multiple country extracts and want to keep them
+up-to-date, have a look at the script in
+[issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
+
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -0,0 +1,149 @@
+This page contains generic installation instructions for Nominatim and its
+prerequisites. There are also step-by-step instructions available for
+the following operating systems:
+
+  * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
+  * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
+
+These OS-specific instructions can also be found in executable form
+in the `vagrant/` directory.
+
+# Prerequisites
+
+## Software
+
+For compiling:
+
+  * [cmake](https://cmake.org/)
+  * [libxml2](http://xmlsoft.org/)
+  * a recent C++ compiler
+
+Nominatim comes with its own version of osm2pgsql. See the
+[osm2pgsql README](../osm2pgsql/README.md) for additional dependencies
+required for compiling osm2pgsql.
+
+For running tests:
+
+  * [behave](http://pythonhosted.org/behave/)
+  * [Psycopg2](http://initd.org/psycopg)
+  * [nose](https://nose.readthedocs.io)
+  * [phpunit](https://phpunit.de)
+
+For running Nominatim:
+
+  * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
+  * [PostGIS](http://postgis.refractions.net) (2.0 or later)
+  * [PHP](http://php.net) (5.4 or later)
+  * PHP-pgsql
+  * PHP-intl (bundled with PHP)
+  * [PEAR::DB](http://pear.php.net/package/DB)
+  * a webserver (apache or nginx are recommended)
+
+For running continuous updates:
+
+  * [pyosmium](http://osmcode.org/pyosmium/)
+
+## Hardware
+
+A minimum of 2GB of RAM is required or installation will fail. For a full
+planet import 32GB of RAM or more strongly are recommended.
+
+For a full planet install you will need about 600GB of hard disk space (as of
+January 2017, take into account that the OSM database is growing fast). SSD disks
+will help considerably to speed up import and queries.
+
+On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes
+a bit more than 2 days. Without SSDs 7-8 days are more realistic.
+
+
+# Setup of the server
+
+## PostgreSQL tuning
+
+You might want to tune your PostgreSQL installation so that the later steps
+make best use of your hardware. You should tune the following parameters in
+your `postgresql.conf` file.
+
+    shared_buffers (2GB)
+    maintenance_work_mem (10GB)
+    work_mem (50MB)
+    effective_cache_size (24GB)
+    synchronous_commit = off
+    checkpoint_segments = 100 # only for postgresql <= 9.4
+    checkpoint_timeout = 10min
+    checkpoint_completion_target = 0.9
+
+The numbers in brackets behind some parameters seem to work fine for
+32GB RAM machine. Adjust to your setup.
+
+For the initial import, you should also set:
+
+    fsync = off
+    full_page_writes = off
+
+Don't forget to reenable them after the initial import or you risk database
+corruption. Autovacuum must not be switched off because it ensures that the
+tables are frequently analysed.
+
+## Webserver setup
+
+The `website/` directory in the build directory contains the configured
+website. Include the directory into your webbrowser to serve php files
+from there.
+
+### Configure for use with Apache
+
+Make sure your Apache configuration contains the required permissions for the
+directory and create an alias:
+
+    <Directory "/srv/nominatim/build/website">
+      Options FollowSymLinks MultiViews
+      AddType text/html   .php
+      DirectoryIndex search.php
+      Require all granted
+    </Directory>
+    Alias /nominatim /srv/nominatim/build/website
+
+`/srv/nominatim/build` should be replaced with the location of your
+build directory.
+
+After making changes in the apache config you need to restart apache.
+The website should now be available on http://localhost/nominatim.
+
+### Configure for use with Nginx
+
+Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
+
+By default php listens on a network socket. If you want it to listen to a
+Unix socket instead, change the pool configuration (`pool.d/www.conf`) as
+follows:
+
+    ; Comment out the tcp listener and add the unix socket
+    ;listen = 127.0.0.1:9000
+    listen = /var/run/php5-fpm.sock
+
+    ; Ensure that the daemon runs as the correct user
+    listen.owner = www-data
+    listen.group = www-data
+    listen.mode = 0666
+
+Tell nginx that php files are special and to fastcgi_pass to the php-fpm
+unix socket by adding the location definition to the default configuration.
+
+    root /srv/nominatim/build/website;
+    index search.php index.html;
+    location ~ [^/]\.php(/|$) {
+        fastcgi_split_path_info ^(.+?\.php)(/.*)$;
+        if (!-f $document_root$fastcgi_script_name) {
+            return 404;
+        }
+        fastcgi_pass unix:/var/run/php5-fpm.sock;
+        fastcgi_index search.php;
+        include fastcgi.conf;
+    }
+
+Restart the nginx and php5-fpm services and the website should now be available
+at `http://localhost/`.
+
+
+Now continue with [importing the database](Import-and-Update.md).
--- a/docs/admin/Migration.md
+++ b/docs/admin/Migration.md
@@ -0,0 +1,66 @@
+Database Migrations
+===================
+
+This page describes database migrations necessary to update existing databases
+to newer versions of Nominatim.
+
+SQL statements should be executed from the postgres commandline. Execute
+`psql nominiatim` to enter command line mode.
+
+# 3.0.0 -> 3.1.0
+
+### Postcode Table
+
+A new separate table for artificially computed postcode centroids was introduced.
+Migration to the new format is possible but **not recommended**.
+
+Create postcode table and indexes, running the following SQL statements:
+
+```sql
+CREATE TABLE location_postcode
+  (place_id BIGINT, parent_place_id BIGINT, rank_search SMALLINT,
+   rank_address SMALLINT, indexed_status SMALLINT, indexed_date TIMESTAMP,
+   country_code varchar(2), postcode TEXT,
+   geometry GEOMETRY(Geometry, 4326));
+CREATE INDEX idx_postcode_geometry ON location_postcode USING GIST (geometry);
+CREATE UNIQUE INDEX idx_postcode_id ON location_postcode USING BTREE (place_id);
+CREATE INDEX idx_postcode_postcode ON location_postcode USING BTREE (postcode);
+GRANT SELECT ON location_postcode TO "www-data";
+```
+
+Add postcode column to `location_area` tables with SQL statement:
+
+```sql
+ALTER TABLE location_area ADD COLUMN postcode TEXT;
+```
+
+Then reimport the functions:
+
+```sh
+./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
+```
+
+Create appropriate triggers with SQL:
+
+```sql
+CREATE TRIGGER location_postcode_before_update BEFORE UPDATE ON location_postcode
+    FOR EACH ROW EXECUTE PROCEDURE postcode_update();
+```
+
+Finally populate the postcode table (will take a while):
+
+```sh
+./utils/setup.php --calculate-postcodes --index --index-noanalyse
+```
+
+This will create a working database. You may also delete the old artificial
+postcodes now. Note that this may be expensive and is not absolutely necessary.
+The following SQL statement will remove them:
+
+```sql
+DELETE FROM place_addressline a USING placex p
+ WHERE a.address_place_id = p.place_id and p.osm_type = 'P';
+ALTER TABLE placex DISABLE TRIGGER USER;
+DELETE FROM placex WHERE osm_type = 'P';
+ALTER TABLE placex ENABLE TRIGGER USER;
+```