cleanup documentation

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

diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index fbdff93e68896469d1f3ddc692b6c8a2cfa540b9..3d276c0615948ba8fa7aaf5ba88a8183f9e1f5e1 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -1,3 +1,5 @@
+# Basic Installation
+
 This page contains generic installation instructions for Nominatim and its
 prerequisites. There are also step-by-step instructions available for
 the following operating systems:
@@ -8,9 +10,16 @@ the following operating systems:
 These OS-specific instructions can also be found in executable form
 in the `vagrant/` directory.
 
-# Prerequisites
+Users have created instructions for other frameworks. We haven't tested those
+and can't offer support.
+
+  * [Docker](https://github.com/mediagis/nominatim-docker)
+  * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
+  * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
+
+## Prerequisites
 
-## Software
+### Software
 
 For compiling:
 
@@ -19,8 +28,7 @@ For compiling:
   * 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.
+osm2pgsql README for additional dependencies required for compiling osm2pgsql.
 
 For running tests:
 
@@ -43,22 +51,22 @@ For running continuous updates:
 
   * [pyosmium](http://osmcode.org/pyosmium/)
 
-## Hardware
+### 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
+For a full planet install you will need at least 700GB of hard disk space
+(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
+## Setup of the server
 
-## PostgreSQL tuning
+### 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
@@ -85,13 +93,13 @@ 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
+### 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
+#### Configure for use with Apache
 
 Make sure your Apache configuration contains the required permissions for the
 directory and create an alias:
@@ -110,7 +118,7 @@ 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
+#### Configure for use with Nginx
 
 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.