]> git.openstreetmap.org Git - nominatim.git/blob - docs/customize/Overview.md
allow None and str for project_dir in NominatimAPI init
[nominatim.git] / docs / customize / Overview.md
1 Nominatim comes with a predefined set of configuration options that should
2 work for most standard installations. If you have special requirements, there
3 are many places where the configuration can be adapted. This chapter describes
4 the following configurable parts:
5
6 * [Global Settings](Settings.md) has a detailed description of all parameters that
7   can be set in your local `.env` configuration
8 * [Import styles](Import-Styles.md) explains how to write your own import style
9   in order to control what kind of OSM data will be imported
10 * [API Result Formatting](Result-Formatting.md) shows how to change the
11   output of the Nominatim API
12 * [Place ranking](Ranking.md) describes the configuration around classifing
13   places in terms of their importance and their role in an address
14 * [Tokenizers](Tokenizers.md) describes the configuration of the module
15   responsible for analysing and indexing names
16 * [Special Phrases](Special-Phrases.md) are common nouns or phrases that
17   can be used in search to identify a class of places
18
19 There are also guides for adding the following external data:
20
21 * [US house numbers from the TIGER dataset](Tiger.md)
22 * [External postcodes](Postcodes.md)