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