X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/603367dced978cfec5642764367a093dc37ccabf..5d6aabc457e673e825c4cf46585938bcc77aec3b:/docs/admin/Import.md?ds=inline diff --git a/docs/admin/Import.md b/docs/admin/Import.md index 853cde61..39c45a6e 100644 --- a/docs/admin/Import.md +++ b/docs/admin/Import.md @@ -1,22 +1,54 @@ # Importing the Database 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). +from an OSM planet file. It is assumed that you have already successfully +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). -## Configuration setup in settings/local.php +## Creating the project directory -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: +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 and change into the directory: - --all 2>&1 | tee setup.log +nominatim import --osm-file 2>&1 | tee setup.log ``` +The **project directory** is the one that you have set up at the beginning. +See [creating the project directory](Import#creating-the-project-directory). + ### Notes on full planet imports Even on a perfectly configured machine @@ -192,29 +235,19 @@ MB. Make sure you leave enough RAM for PostgreSQL and osm2pgsql as mentioned above. If the system starts swapping or you are getting out-of-memory errors, reduce the cache size or even consider using a flatnode file. -### Verify the import -Run this script to verify all required tables and indices got created successfully. +### Testing the installation -```sh -./utils/check_import_finished.php -``` - -### Setting up the website - -Run the following command to set up the configuration file for the API frontend -`settings/settings-frontend.php`. These settings are used in website/*.php files. +Run this script to verify all required tables and indices got created successfully. ```sh -./utils/setup.php --setup-website +nominatim admin --check-database ``` -!!! Note - This step is not necessary if you use `--all` option while setting up the DB. Now you can try out your installation by running: ```sh -make serve +nominatim serve ``` This runs a small test server normally used for development. You can use it @@ -222,6 +255,9 @@ to verify that your installation is working. Go to `http://localhost:8088/status.php` and you should see the message `OK`. You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`. +Note that search query is not supported for reverse-only imports. You can run a +reverse query, e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`. + To run Nominatim via webservers like Apache or nginx, please read the [Deployment chapter](Deployment.md). @@ -232,7 +268,7 @@ planner to make the right decisions. Recomputing them can improve the performanc of forward geocoding in particular under high load. To recompute word counts run: ```sh -./utils/update.php --recompute-word-counts +nominatim refresh --word-counts ``` This will take a couple of hours for a full planet installation. You can @@ -242,44 +278,14 @@ 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. You -need internet access for the step. - - -## Installing Tiger housenumber data for the US - -Nominatim is able to use the official [TIGER](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html) -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. The -entire US adds about 10GB to your database. - - 1. Get preprocessed TIGER 2019 data and unpack it into the - data directory in your Nominatim sources: - - cd Nominatim/data - wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz - tar xf tiger2019-nominatim-preprocessed.tar.gz - - 2. Import the data into your Nominatim database: - - ./utils/setup.php --import-tiger-data - - 3. Enable use of the Tiger data in your `settings/local.php` by adding: - - @define('CONST_Use_US_Tiger_Data', true); - - 4. Apply the new settings: +you also need to import these key phrases like this: ```sh - ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions +nominatim special-phrases --import-from-wiki ``` +Note that this command downloads the phrases from the wiki link above. You +need internet access for the step. -See the [developer's guide](../develop/data-sources.md#us-census-tiger) for more -information on how the data got preprocessed. - +You can also import special phrases from a csv file, for more +information please read the [Customization chapter](Customization.md).