Merge remote-tracking branch 'upstream/master'

[nominatim.git] / settings / env.defaults

diff --git a/settings/env.defaults b/settings/env.defaults
index 5fbeb0a27393575b4bfbd9dc15a8aa6e8941086d..84cd24f16c5a162b3974e5f72d00705ee3c17efc 100644 (file)
--- a/settings/env.defaults
+++ b/settings/env.defaults
@@ -21,10 +21,10 @@ NOMINATIM_DATABASE_MODULE_PATH=
 # Tokenizer used for normalizing and parsing queries and names.
 # The tokenizer is set up during import and cannot be changed afterwards
 # without a reimport.
-# Currently available tokenizers: legacy
-NOMINATIM_TOKENIZER="legacy"
+# Currently available tokenizers: icu, legacy
+NOMINATIM_TOKENIZER="icu"
 
-# Number of occurances of a word before it is considered frequent.
+# Number of occurrences of a word before it is considered frequent.
 # Similar to the concept of stop words. Frequent partial words get ignored
 # or handled differently during search.
 # Changing this value requires a reimport.
@@ -46,12 +46,18 @@ NOMINATIM_LANGUAGES=
 # Changing this value requires a reimport.
 NOMINATIM_TERM_NORMALIZATION=":: NFD (); [[:Nonspacing Mark:] [:Cf:]] >;  :: lower (); [[:Punctuation:][:Space:]]+ > ' '; :: NFC ();"
 
+# Configuration file for the tokenizer.
+# The content depends on the tokenizer used. If left empty the default settings
+# for the chosen tokenizer will be used. The configuration can only be set
+# on import and not be changed afterwards.
+NOMINATIM_TOKENIZER_CONFIG=
+
 # Search in the Tiger house number data for the US.
 # Note: The tables must already exist or queries will throw errors.
 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_US_TIGER_DATA=no
 
-# Search in the auxilary housenumber table.
+# Search in the auxiliary housenumber table.
 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_AUX_LOCATION_DATA=no
 
@@ -59,7 +65,7 @@ NOMINATIM_USE_AUX_LOCATION_DATA=no
 # The following settings allow to set a proxy to use when remotely downloading
 # data. Host and port are required. Login and password are optional.
 NOMINATIM_HTTP_PROXY=no
-NOMINATIM_HTTP_PROXY_HOST=proxy.mydomain.com
+NOMINATIM_HTTP_PROXY_HOST=
 NOMINATIM_HTTP_PROXY_PORT=3128
 NOMINATIM_HTTP_PROXY_LOGIN=
 NOMINATIM_HTTP_PROXY_PASSWORD=
@@ -68,8 +74,6 @@ NOMINATIM_HTTP_PROXY_PASSWORD=
 # HTTPS_PROXY="http://user:pass@10.10.1.10:1080"
 
 # Location of the osm2pgsql binary.
-# When empty, osm2pgsql is expected to reside in the osm2pgsql directory in
-# the project directory.
 # EXPERT ONLY. You should usually use the supplied osm2pgsql.
 NOMINATIM_OSM2PGSQL_BINARY=
 
@@ -83,14 +87,12 @@ NOMINATIM_TIGER_DATA_PATH=
 NOMINATIM_WIKIPEDIA_DATA_PATH=
 
 # Configuration file for special phrase import.
-# When unset, the internal default settings from 'settings/phrase-settings.json'
-# are used.
+# OBSOLETE: use `nominatim special-phrases --config <file>` or simply put
+#           a custom phrase-settings.json into your project directory.
 NOMINATIM_PHRASE_CONFIG=
 
 # Configuration file for rank assignments.
-# When unset, the internal default settings from 'settings/address-levels.json'
-# are used.
-NOMINATIM_ADDRESS_LEVEL_CONFIG=
+NOMINATIM_ADDRESS_LEVEL_CONFIG=address-levels.json
 
 # Configuration file for OSM data import.
 # This may either be the name of one of an internal style or point
@@ -186,7 +188,7 @@ NOMINATIM_MAPICON_URL=
 NOMINATIM_DEFAULT_LANGUAGE=
 
 # Enable a special batch query mode.
-# This features is currently undocumented and potentially broken.
+# This feature is currently undocumented and potentially broken.
 NOMINATIM_SEARCH_BATCH_MODE=no
 
 # Threshold for searches by name only.
@@ -202,6 +204,11 @@ NOMINATIM_LOOKUP_MAX_COUNT=50
 # Set to zero to disable polygon output.
 NOMINATIM_POLYGON_OUTPUT_MAX_TYPES=1
 
+# Offer backwards compatible PHP URLs.
+# When running one of the Python enignes, they will add endpoint aliases
+# under <endpoint>.php
+NOMINATIM_SERVE_LEGACY_URLS=yes
+
 ### Log settings
 #
 # The following options allow to enable logging of API requests.