]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/admin/Installation.md
Merge pull request #2084 from lonvia/fix-term-count
[nominatim.git] / docs / admin / Installation.md
index c67ff46ff3f15cd115f85aa76545b2e92e511ffa..8ca41e8f407592fe6327e30e58d6dd18f03fc337 100644 (file)
@@ -4,8 +4,9 @@ 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 20.04](../appendix/Install-on-Ubuntu-20.md)
   * [Ubuntu 18.04](../appendix/Install-on-Ubuntu-18.md)
-  * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
+  * [CentOS 8](../appendix/Install-on-Centos-8.md)
   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
 
 These OS-specific instructions can also be found in executable form
@@ -25,33 +26,31 @@ and can't offer support.
 For compiling:
 
   * [cmake](https://cmake.org/)
-  * [libxml2](http://xmlsoft.org/)
+  * [expat](https://libexpat.github.io/)
+  * [proj](https://proj.org/)
+  * [bzip2](http://www.bzip.org/)
+  * [zlib](https://www.zlib.net/)
+  * [Boost libraries](https://www.boost.org/), including system and filesystem
+  * PostgreSQL client libraries
   * a recent C++ compiler (gcc 5+ or Clang 3.8+)
 
-Nominatim comes with its own version of osm2pgsql. See the
-[osm2pgsql README](https://github.com/openstreetmap/osm2pgsql/blob/master/README.md#building)
-for additional dependencies required for compiling osm2pgsql.
-
-For running tests:
-
-  * [behave](http://pythonhosted.org/behave/)
-  * [Psycopg2](https://initd.org/psycopg)
-  * [nose](https://nose.readthedocs.io)
-  * [phpunit](https://phpunit.de)
-
 For running Nominatim:
 
-  * [PostgreSQL](https://www.postgresql.org) (9.3 or later)
-  * [PostGIS](https://postgis.org) (2.2 or later)
+  * [PostgreSQL](https://www.postgresql.org) (9.3+)
+  * [PostGIS](https://postgis.net) (2.2+)
+  * [Python 3](https://www.python.org/)
+  * [Psycopg2](https://www.psycopg.org)
   * [PHP](https://php.net) (7.0 or later)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)
-  * a webserver (apache or nginx are recommended)
 
 For running continuous updates:
 
   * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
 
+For dependencies for running tests and building documentation, see
+the [Development section](../develop/Development-Environment.md).
+
 ### Hardware
 
 A minimum of 2GB of RAM is required or installation will fail. For a full
@@ -65,9 +64,7 @@ will help considerably to speed up import and queries.
 Even on a well configured machine the import of a full planet takes
 at least 2 days. Without SSDs 7-8 days are more realistic.
 
-## Setup of the server
-
-### PostgreSQL tuning
+## Tuning the PostgreSQL database
 
 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
@@ -107,65 +104,44 @@ Don't forget to reenable them after the initial import or you risk database
 corruption.
 
 
-### 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:
+## Downloading and building Nominatim
 
-    <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
+### Downloading the latest release
 
-`/srv/nominatim/build` should be replaced with the location of your
-build directory.
+You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
+The release contains all necessary files. Just unpack it.
 
-After making changes in the apache config you need to restart apache.
-The website should now be available on http://localhost/nominatim.
+### Downloading the latest development version
 
-#### Configure for use with Nginx
+If you want to install latest development version from github, make sure to
+also check out the osm2pgsql subproject:
 
-Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
+```
+git clone --recursive git://github.com/openstreetmap/Nominatim.git
+```
 
-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:
+The development version does not include the country grid. Download it separately:
 
-    ; Comment out the tcp listener and add the unix socket
-    ;listen = 127.0.0.1:9000
-    listen = /var/run/php5-fpm.sock
+```
+wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
+```
 
-    ; Ensure that the daemon runs as the correct user
-    listen.owner = www-data
-    listen.group = www-data
-    listen.mode = 0666
+### Building Nominatim
 
-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.
+The code must be built in a separate directory. Create the directory and
+change into it.
 
-    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;
-    }
+```
+mkdir build
+cd build
+```
 
-Restart the nginx and php5-fpm services and the website should now be available
-at `http://localhost/`.
+Nominatim uses cmake and make for building. Assuming that you have created the
+build at the same level as the Nominatim source directory run:
 
+```
+cmake ../Nominatim
+make
+```
 
-Now continue with [importing the database](Import-and-Update.md).
+Now continue with [importing the database](Import.md).