]> git.openstreetmap.org Git - nominatim.git/commitdiff
add 'make install' to installation instructions
authorSarah Hoffmann <lonvia@denofr.de>
Wed, 10 Feb 2021 10:15:21 +0000 (11:15 +0100)
committerSarah Hoffmann <lonvia@denofr.de>
Wed, 10 Feb 2021 10:15:21 +0000 (11:15 +0100)
README.md
docs/admin/Advanced-Installations.md
docs/admin/Import.md
docs/admin/Installation.md

index d4bb0936657cd2d57de351aaa836faf1fa4951d1..6fd0cd4595fbce93ecd499e1758a8f92cb2b67ec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -41,12 +41,13 @@ A quick summary of the necessary steps:
         cd build
         cmake ..
         make
         cd build
         cmake ..
         make
+        sudo make install
 
 2. Create a project directory, get OSM data and import:
 
         mkdir nominatim-project
         cd nominatim-project
 
 2. Create a project directory, get OSM data and import:
 
         mkdir nominatim-project
         cd nominatim-project
-        ~/build/nominatim import --osm-file <your planet file>
+        nominatim import --osm-file <your planet file>
 
 3. Point your webserver to the nominatim-project/website directory.
 
 
 3. Point your webserver to the nominatim-project/website directory.
 
index 4f59900d3317c3828395dece425c92416192d027..d5e6e889b2da1c92dd4fd3b4cfe1266b60a04894 100644 (file)
@@ -155,7 +155,7 @@ Make sure that the PostgreSQL server package is installed on the machine
 the PostgreSQL server itself.
 
 Download and compile Nominatim as per standard instructions. Once done, you find
 the PostgreSQL server itself.
 
 Download and compile Nominatim as per standard instructions. Once done, you find
-the nomrmalization library in `build/module/nominatim.so`. Copy the file to
+the normalization library in `build/module/nominatim.so`. Copy the file to
 the database server at a location where it is readable and executable by the
 PostgreSQL server process.
 
 the database server at a location where it is readable and executable by the
 PostgreSQL server process.
 
index 280231b670dfaab8a948bbb4c14874022b46ecdd..b810c37e3b3a7df3b28d8ea4406f359a58f767cb 100644 (file)
@@ -2,7 +2,8 @@
 
 The following instructions explain how to create a Nominatim database
 from an OSM planet file. It is assumed that you have already successfully
 
 The following instructions explain how to create a Nominatim database
 from an OSM planet file. It is assumed that you have already successfully
-installed the Nominatim software itself. If this is not the case, return to the
+installed the Nominatim software itself and the `nominatim` tool can be found
+in your `PATH`. If this is not the case, return to the
 [installation page](Installation.md).
 
 ## Creating the project directory
 [installation page](Installation.md).
 
 ## Creating the project directory
@@ -10,10 +11,11 @@ installed the Nominatim software itself. If this is not the case, return to the
 Before you start the import, you should create a project directory for your
 new database installation. This directory receives all data that is related
 to a single Nominatim setup: configuration, extra data, etc. Create a project
 Before you start the import, you should create a project directory for your
 new database installation. This directory receives all data that is related
 to a single Nominatim setup: configuration, extra data, etc. Create a project
-directory apart from the Nominatim software:
+directory apart from the Nominatim software and change into the directory:
 
 ```
 mkdir ~/nominatim-planet
 
 ```
 mkdir ~/nominatim-planet
+cd ~/nominatim-planet
 ```
 
 In the following, we refer to the project directory as `$PROJECT_DIR`. To be
 ```
 
 In the following, we refer to the project directory as `$PROJECT_DIR`. To be
@@ -25,18 +27,8 @@ export PROJECT_DIR=~/nominatim-planet
 
 The Nominatim tool assumes per default that the current working directory is
 the project directory but you may explicitly state a different directory using
 
 The Nominatim tool assumes per default that the current working directory is
 the project directory but you may explicitly state a different directory using
-the `--project-dir` parameter. The following instructions assume that you have
-added the Nominatim build directory to your PATH and run all directories from
-the project directory. If you haven't done yet, add the build directory to your
-path and change to the new project directory:
-
-```
-export PATH=~/Nominatim/build:$PATH
-cd $PROJECT_DIR
-```
-
-Of course, you have to replace the path above with the location of your build
-directory.
+the `--project-dir` parameter. The following instructions assume that you run
+all commands from the project directory.
 
 !!! tip "Migration Tip"
 
 
 !!! tip "Migration Tip"
 
index d8c98ef5056dfecb1a6b2b4761214eee8e8f22a9..0013e993d2f7188a106dcfedf67581b6038961ed 100644 (file)
@@ -40,14 +40,15 @@ For running Nominatim:
   * [PostGIS](https://postgis.net) (2.2+)
   * [Python 3](https://www.python.org/) (3.5+)
   * [Psycopg2](https://www.psycopg.org)
   * [PostGIS](https://postgis.net) (2.2+)
   * [Python 3](https://www.python.org/) (3.5+)
   * [Psycopg2](https://www.psycopg.org)
+  * [Python Dotenv](https://github.com/theskumar/python-dotenv)
   * [PHP](https://php.net) (7.0 or later)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)
   * [PHP](https://php.net) (7.0 or later)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)
-  * [Python Dotenv](https://github.com/theskumar/python-dotenv)
+  ( PHP-cgi (for running queries from the command line)
 
 For running continuous updates:
 
 
 For running continuous updates:
 
-  * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
+  * [pyosmium](https://osmcode.org/pyosmium/)
 
 For dependencies for running tests and building documentation, see
 the [Development section](../develop/Development-Environment.md).
 
 For dependencies for running tests and building documentation, see
 the [Development section](../develop/Development-Environment.md).
@@ -143,6 +144,16 @@ build at the same level as the Nominatim source directory run:
 ```
 cmake ../Nominatim
 make
 ```
 cmake ../Nominatim
 make
+sudo make install
+```
+
+Nominatim installs itself into `/usr/local` per default. To choose a different
+installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
+cmake command. Make sure that the `bin` directory is available in your path
+in that case, e.g.
+
+```
+export PATH=<install root>/bin:$PATH
 ```
 
 Now continue with [importing the database](Import.md).
 ```
 
 Now continue with [importing the database](Import.md).