### Configuration setup in `.env`
-The Nominatim server can be customized via an `.env` configuration file in the
+The Nominatim server can be customized via an `.env` configuration file in the
project directory. This is a file in [dotenv](https://github.com/theskumar/python-dotenv)
format which looks the same as variable settings in a standard shell environment.
You can also set the same configuration via environment variables. All
settings have a `NOMINATIM_` prefix to avoid conflicts with other environment
variables.
-There are lots of configuration settings you can tweak. Have a look
-at `settings/env.default` for a full list. Most should have a sensible default.
+There are lots of configuration settings you can tweak. A full reference
+can be found in the chapter [Configuration Settings](../customize/Settings.md).
+Most should have a sensible default.
#### Flatnode files
The file is about 400MB and adds around 4GB to the Nominatim database.
+### OSM views
+OSM publishes aggregate map access numbers that are generated based on the users’
+behavior when viewing locations on the map. This data is also optional and
+it complements wikipedia/wikidata rankings to further enhance the search results
+if added.
+OSM views data is avalaible as a GeoTIFF file. Put it into your project directory:
+
+ cd $PROJECT_DIR
+ wget https://qrank.wmcloud.org/download/osmviews.tiff
+
+The file is about 380MB and adds around 4GB to the Nominatim database. Importing
+OSM views into Nominatim takes a little over 3 hours.
+
+!!! warning
+ Importing OSM views is currently an experimental feature. OSM views data are
+ not yet included in the importance values calculations.
+
!!! tip
- If you forgot to download the wikipedia rankings, you can also add
- importances after the import. Download the files, then run
- `nominatim refresh --wiki-data --importance`. Updating importances for
- a planet can take a couple of hours.
+ If you forgot to download the wikipedia rankings or OSM views, then you can
+ also add importances after the import. To add both, download their files, then
+ run `nominatim refresh --wiki-data --osm-views --importance`. Updating
+ importances for a planet will take a couple of hours.
### External postcodes
wget https://www.nominatim.org/data/us_postcodes.csv.gz
You can also add your own custom postcode sources, see
-[Customization of postcodes](Customization.md#external-postcode-data).
+[Customization of postcodes](../customize/Postcodes.md).
## Choosing the data to import
are a good way to reduce the database size and import time.
[Geofabrik](https://download.geofabrik.de) offers extracts for most countries.
They even have daily updates which can be used with the update process described
-[in the next section](../Update). There are also
+[in the next section](Update.md). There are also
[other providers for extracts](https://wiki.openstreetmap.org/wiki/Planet.osm#Downloading).
Please be aware that some extracts are not cut exactly along the country
import. So this option is particularly interesting if you plan to transfer the
database or reuse the space later.
+!!! warning
+ The data structure for updates are also required when adding additional data
+ after the import, for example [TIGER housenumber data](../customize/Tiger.md).
+ If you plan to use those, you must not use the `--no-updates` parameter.
+ Do a normal import, add the external data and once you are done with
+ everything run `nominatim freeze`.
+
+
### Reverse-only Imports
If you only want to use the Nominatim database for reverse lookups or
if you plan to use the installation only for exports to a
-[photon](https://photon.komoot.de/) database, then you can set up a database
+[photon](https://photon.komoot.io/) database, then you can set up a database
without search indexes. Add `--reverse-only` to your setup command above.
This saves about 5% of disk space.
boundaries, places, streets, addresses and POI data. There are also other
import styles available which only read selected data:
-* **settings/import-admin.style**
+* **admin**
Only import administrative boundaries and places.
-* **settings/import-street.style**
+* **street**
Like the admin style but also adds streets.
-* **settings/import-address.style**
+* **address**
Import all data necessary to compute addresses down to house number level.
-* **settings/import-full.style**
+* **full**
Default style that also includes points of interest.
-* **settings/import-extratags.style**
+* **extratags**
Like the full style but also adds most of the OSM tags into the extratags
column.
extratags | 54h | 650 GB | 340 GB
You can also customize the styles further.
-A [description of the style format](../develop/Import.md#configuring-the-import)
-can be found in the development section.
+A [description of the style format](../customize/Import-Styles.md)
+can be found in the customization guide.
## Initial import of the data
[Geofabrik](https://download.geofabrik.de).
Download the data to import. Then issue the following command
-from the **build directory** to start the import:
+from the **project directory** to start the import:
```sh
nominatim import --osm-file <data 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](#creating-the-project-directory).
+
### Notes on full planet imports
Even on a perfectly configured machine
in terms of RAM usage. osm2pgsql and PostgreSQL are running in parallel at
this point. PostgreSQL blocks at least the part of RAM that has been configured
with the `shared_buffers` parameter during
-[PostgreSQL tuning](Installation#postgresql-tuning)
+[PostgreSQL tuning](Installation.md#postgresql-tuning)
and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
its internal data structures, potentially more when it has to process very large
relations. In addition it needs to maintain a cache for node locations. The size
### Testing the installation
-Run this script to verify all required tables and indices got created successfully.
+Run this script to verify that all required tables and indices got created
+successfully.
```sh
nominatim admin --check-database
To run Nominatim via webservers like Apache or nginx, please read the
[Deployment chapter](Deployment.md).
-## Tuning the database
-
-Accurate word frequency information for search terms helps PostgreSQL's query
-planner to make the right decisions. Recomputing them can improve the performance
-of forward geocoding in particular under high load. To recompute word counts run:
-
-```sh
-nominatim refresh --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.
+## Adding search through category phrases
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)
+[special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
you also need to import these key phrases like this:
```sh
need internet access for the step.
You can also import special phrases from a csv file, for more
-information please read the [Customization chapter](Customization.md).
+information please see the [Customization part](../customize/Special-Phrases.md).
projects / nominatim.git / blobdiff