]> git.openstreetmap.org Git - nominatim.git/blob - docs/customize/Settings.md
docs: make customization chapter a separate section
[nominatim.git] / docs / customize / Settings.md
1 This section provides a reference of all configuration parameters that can
2 be used with Nominatim.
3
4 # Configuring Nominatim
5
6 Nominatim uses [dotenv](https://github.com/theskumar/python-dotenv) to manage
7 its configuration settings. There are two means to set configuration
8 variables: through an `.env` configuration file or through an environment
9 variable.
10
11 The `.env` configuration file needs to be placed into the
12 [project directory](../admin/Import/#creating-the-project-directory). It
13 must contain configuration parameters in `<parameter>=<value>` format.
14 Please refer to the dotenv documentation for details.
15
16 The configuration options may also be set in the form of shell environment
17 variables. This is particularly useful, when you want to temporarily change
18 a configuration option. For example, to force the replication serve to
19 download the next change, you can temporarily disable the update interval:
20
21     NOMINATIM_REPLICATION_UPDATE_INTERVAL=0 nominatim replication --once
22
23 If a configuration option is defined through .env file and environment
24 variable, then the latter takes precedence. 
25
26 # Configuration Parameter Reference
27