]> git.openstreetmap.org Git - nominatim.git/blob - settings/env.defaults
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / settings / env.defaults
1 # .env
2 # Default configuration settings for Nominatim.
3 # This file uses the dotenv format.
4
5 # Database connection string.
6 # Add host, port, user etc through additional semicolon-separated attributes.
7 # e.g. ;host=...;port=...;user=...;password=...
8 # Changing this variable requires to run 'nominatim refresh --website'.
9 NOMINATIM_DATABASE_DSN="pgsql:dbname=nominatim"
10
11 # Database web user.
12 # Nominatim sets up read-only access for this user during installation.
13 NOMINATIM_DATABASE_WEBUSER="www-data"
14
15 # Directory where to find the PostgreSQL server module.
16 # When empty the module is expected to be located in the 'module' subdirectory
17 # in the project directory.
18 # Changing this value requires to run 'nominatim refresh --functions'.
19 NOMINATIM_DATABASE_MODULE_PATH=
20
21 # Number of occurances of a word before it is considered frequent.
22 # Similar to the concept of stop words. Frequent partial words get ignored
23 # or handled differently during search.
24 # Changing this value requires a reimport.
25 NOMINATIM_MAX_WORD_FREQUENCY=50000
26
27 # If true, admin level changes on places with many contained children are blocked.
28 NOMINATIM_LIMIT_REINDEXING=yes
29
30 # Restrict search languages.
31 # Normally Nominatim will include all language variants of name:XX
32 # in the search index. Set this to a comma separated list of language
33 # codes, to restrict import to a subset of languages.
34 # Currently only affects the initial import of country names and special phrases.
35 NOMINATIM_LANGUAGES=
36
37 # Rules for normalizing terms for comparisons.
38 # The default is to remove accents and punctuation and to lower-case the
39 # term. Spaces are kept but collapsed to one standard space.
40 # Changing this value requires a reimport.
41 NOMINATIM_TERM_NORMALIZATION=":: NFD (); [[:Nonspacing Mark:] [:Cf:]] >;  :: lower (); [[:Punctuation:][:Space:]]+ > ' '; :: NFC ();"
42
43 # Search in the Tiger house number data for the US.
44 # Note: The tables must already exist or queries will throw errors.
45 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
46 NOMINATIM_USE_US_TIGER_DATA=no
47
48 # Search in the auxilary housenumber table.
49 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
50 NOMINATIM_USE_AUX_LOCATION_DATA=no
51
52 # Proxy settings
53 # The following settings allow to set a proxy to use when remotely downloading
54 # data. Host and port are required. Login and password are optional.
55 NOMINATIM_HTTP_PROXY=no
56 NOMINATIM_HTTP_PROXY_HOST=proxy.mydomain.com
57 NOMINATIM_HTTP_PROXY_PORT=3128
58 NOMINATIM_HTTP_PROXY_LOGIN=
59 NOMINATIM_HTTP_PROXY_PASSWORD=
60 # Also set these standard environment variables.
61 # HTTP_PROXY="http://user:pass@10.10.1.10:1080"
62 # HTTPS_PROXY="http://user:pass@10.10.1.10:1080"
63
64 # Location of the osm2pgsql binary.
65 # When empty, osm2pgsql is expected to reside in the osm2pgsql directory in
66 # the project directory.
67 # EXPERT ONLY. You should usually use the supplied osm2pgsql.
68 NOMINATIM_OSM2PGSQL_BINARY=
69
70 # Directory where to find US Tiger data files to import.
71 # OBSOLETE: use `nominatim add-data --tiger-data <dir>` to explicitly state
72 #           the directory on import
73 NOMINATIM_TIGER_DATA_PATH=
74
75 # Directory where to find pre-computed Wikipedia importance files.
76 # When unset, the data is expected to be located in the project directory.
77 NOMINATIM_WIKIPEDIA_DATA_PATH=
78
79 # Configuration file for special phrase import.
80 # When unset, the internal default settings from 'settings/phrase-settings.json'
81 # are used.
82 NOMINATIM_PHRASE_CONFIG=
83
84 # Configuration file for rank assignments.
85 # When unset, the internal default settings from 'settings/address-levels.json'
86 # are used.
87 NOMINATIM_ADDRESS_LEVEL_CONFIG=
88
89 # Configuration file for OSM data import.
90 # This may either be the name of one of an internal style or point
91 # to a file with a custom style.
92 # Internal styles are: admin, street, address, full, extratags
93 NOMINATIM_IMPORT_STYLE=extratags
94
95 # Location of the flatnode file used by osm2pgsql to store node locations.
96 # When unset, osm2pgsql stores the location in the PostgreSQL database. This
97 # is especially useful for imports of larger areas, like continents or the
98 # full planet. The file needs at least 70GB storage.
99 NOMINATIM_FLATNODE_FILE=
100
101 ### Tablespace settings
102 #
103 # The following settings allow to move parts of the database tables into
104 # different tablespaces. This is especially interesting if you have disks
105 # with different speeds. When unset, the default tablespace is used.
106 # Only has an effect during import.
107
108 # Tablespace used for tables used when searching.
109 NOMINATIM_TABLESPACE_SEARCH_DATA=
110 # Tablespace used for indexes used when searching.
111 NOMINATIM_TABLESPACE_SEARCH_INDEX=
112
113 # Tablespace used for the OSM data cache tables. Used for import and update only.
114 NOMINATIM_TABLESPACE_OSM_DATA=
115 # Tablespace used for the OSM data cache indexes. Used for import and update only.
116 NOMINATIM_TABLESPACE_OSM_INDEX=
117
118 # Tablespace used for place import table. Used for import and update only.
119 NOMINATIM_TABLESPACE_PLACE_DATA=
120 # Tablespace used for place import indexes. Used for import and update only.
121 NOMINATIM_TABLESPACE_PLACE_INDEX=
122
123 # Tablespace for tables used during address computation. Used for import and update only.
124 NOMINATIM_TABLESPACE_ADDRESS_DATA=
125 # Tablespace for indexes used during address computation. Used for import and update only.
126 NOMINATIM_TABLESPACE_ADDRESS_INDEX=
127
128 # Tablespace for tables for auxilary data, e.g. TIGER data, postcodes.
129 NOMINATIM_TABLESPACE_AUX_DATA=
130 # Tablespace for indexes for auxilary data, e.g. TIGER data, postcodes.
131 NOMINATIM_TABLESPACE_AUX_INDEX=
132
133
134 ### Replication settings
135 #
136 # The following settings control where and how updates for the database are
137 # retrieved.
138 #
139
140 #
141 # Base URL of replication service.
142 # A replication service provides change files of OSM data at regular intervals.
143 # These are used to keep the database up to date. Per default it points to
144 # the minutely updates for the main OSM database. There are other services
145 # geared towards larger update intervals or data extracts.
146 # Changing this value requires to rerun 'nominatim replication --init'.
147 NOMINATIM_REPLICATION_URL="https://planet.openstreetmap.org/replication/minute"
148
149 # Maximum amount of data to download per batch.
150 # Size is in MB.
151 NOMINATIM_REPLICATION_MAX_DIFF=50
152
153 # Publication interval of the replication service.
154 # Determines when Nominatim will attempt again to download again a new
155 # update. The time is computed from the publication date of the last diff
156 # downloaded. Setting this to a slightly higher value than the actual
157 # publication interval avoids unnecessary rechecks.
158 NOMINATIM_REPLICATION_UPDATE_INTERVAL=75
159
160 # Wait time to recheck for a pending update.
161 # Time to wait after an expected update was not available on the server.
162 NOMINATIM_REPLICATION_RECHECK_INTERVAL=60
163
164 ### API settings
165 #
166 # The following settings configure the API responses. You must rerun
167 # 'nominatim refresh --website' after changing any of them.
168
169 # Send permissive CORS access headers.
170 # When enabled, send CORS headers to allow access to everybody.
171 NOMINATIM_CORS_NOACCESSCONTROL=yes
172
173 # URL for static icon images.
174 # Set this to the /mapicon directory of your nominatim-ui to enable returning
175 # icon URLs with the results.
176 NOMINATIM_MAPICON_URL=
177
178 # Language to assume when no particular language is requested.
179 # When unset, the local language (i.e. the name tag without suffix) will be used.
180 NOMINATIM_DEFAULT_LANGUAGE=
181
182 # Enable a special batch query mode.
183 # This features is currently undocumented and potentially broken.
184 NOMINATIM_SEARCH_BATCH_MODE=no
185
186 # Threshold for searches by name only.
187 # Threshold where the lookup strategy in the database is switched. If there
188 # are less occurences of a tem than given, the search does the lookup only
189 # against the name, otherwise it uses indexes for name and address.
190 NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD=500
191
192 # Maximum number of OSM ids accepted by /lookup.
193 NOMINATIM_LOOKUP_MAX_COUNT=50
194
195 # Number of different geometry formats that may be queried in parallel.
196 # Set to zero to disable polygon output.
197 NOMINATIM_POLYGON_OUTPUT_MAX_TYPES=1
198
199 ### Log settings
200 #
201 # The following options allow to enable logging of API requests.
202 # You must rerun 'nominatim refresh --website' after changing any of them.
203 #
204 # Enable logging of requests into the DB.
205 # The request will be logged into the new_query_log table.
206 # You should set up a cron job that regularly clears out this table.
207 NOMINATIM_LOG_DB=no
208
209 # Enable logging of requests into a file.
210 # To enable logging set this setting to the file to log to.
211 NOMINATIM_LOG_FILE=