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 # Tokenizer used for normalizing and parsing queries and names.
  16 # The tokenizer is set up during import and cannot be changed afterwards
  17 # without a reimport.
  18 # Currently available tokenizers: icu, legacy
  19 NOMINATIM_TOKENIZER="icu"
  20
  21 # Number of occurrences 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 # Configuration file for the tokenizer.
  44 # The content depends on the tokenizer used. If left empty the default settings
  45 # for the chosen tokenizer will be used. The configuration can only be set
  46 # on import and not be changed afterwards.
  47 NOMINATIM_TOKENIZER_CONFIG=
  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 auxiliary 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=
  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 # EXPERT ONLY. You should usually use the supplied osm2pgsql.
  72 NOMINATIM_OSM2PGSQL_BINARY=
  73
  74 # Directory where to find pre-computed Wikipedia importance files.
  75 # When unset, the data is expected to be located in the project directory.
  76 NOMINATIM_WIKIPEDIA_DATA_PATH=
  77
  78 # Configuration file for rank assignments.
  79 NOMINATIM_ADDRESS_LEVEL_CONFIG=address-levels.json
  80
  81 # Configuration file for OSM data import.
  82 # This may either be the name of one of an internal style or point
  83 # to a file with a custom style.
  84 # Internal styles are: admin, street, address, full, extratags
  85 NOMINATIM_IMPORT_STYLE=extratags
  86
  87 # Location of the flatnode file used by osm2pgsql to store node locations.
  88 # When unset, osm2pgsql stores the location in the PostgreSQL database. This
  89 # is especially useful for imports of larger areas, like continents or the
  90 # full planet. The file needs at least 70GB storage.
  91 NOMINATIM_FLATNODE_FILE=
  92
  93 ### Tablespace settings
  94 #
  95 # The following settings allow to move parts of the database tables into
  96 # different tablespaces. This is especially interesting if you have disks
  97 # with different speeds. When unset, the default tablespace is used.
  98 # Only has an effect during import.
  99
 100 # Tablespace used for tables used when searching.
 101 NOMINATIM_TABLESPACE_SEARCH_DATA=
 102 # Tablespace used for indexes used when searching.
 103 NOMINATIM_TABLESPACE_SEARCH_INDEX=
 104
 105 # Tablespace used for the OSM data cache tables. Used for import and update only.
 106 NOMINATIM_TABLESPACE_OSM_DATA=
 107 # Tablespace used for the OSM data cache indexes. Used for import and update only.
 108 NOMINATIM_TABLESPACE_OSM_INDEX=
 109
 110 # Tablespace used for place import table. Used for import and update only.
 111 NOMINATIM_TABLESPACE_PLACE_DATA=
 112 # Tablespace used for place import indexes. Used for import and update only.
 113 NOMINATIM_TABLESPACE_PLACE_INDEX=
 114
 115 # Tablespace for tables used during address computation. Used for import and update only.
 116 NOMINATIM_TABLESPACE_ADDRESS_DATA=
 117 # Tablespace for indexes used during address computation. Used for import and update only.
 118 NOMINATIM_TABLESPACE_ADDRESS_INDEX=
 119
 120 # Tablespace for tables for auxiliary data, e.g. TIGER data, postcodes.
 121 NOMINATIM_TABLESPACE_AUX_DATA=
 122 # Tablespace for indexes for auxiliary data, e.g. TIGER data, postcodes.
 123 NOMINATIM_TABLESPACE_AUX_INDEX=
 124
 125
 126 ### Replication settings
 127 #
 128 # The following settings control where and how updates for the database are
 129 # retrieved.
 130 #
 131
 132 #
 133 # Base URL of replication service.
 134 # A replication service provides change files of OSM data at regular intervals.
 135 # These are used to keep the database up to date. Per default it points to
 136 # the minutely updates for the main OSM database. There are other services
 137 # geared towards larger update intervals or data extracts.
 138 # Changing this value requires to rerun 'nominatim replication --init'.
 139 NOMINATIM_REPLICATION_URL="https://planet.openstreetmap.org/replication/minute"
 140
 141 # Maximum amount of data to download per batch.
 142 # Size is in MB.
 143 NOMINATIM_REPLICATION_MAX_DIFF=50
 144
 145 # Publication interval of the replication service (in seconds).
 146 # Determines when Nominatim will attempt again to download again a new
 147 # update. The time is computed from the publication date of the last diff
 148 # downloaded. Setting this to a slightly higher value than the actual
 149 # publication interval avoids unnecessary rechecks.
 150 NOMINATIM_REPLICATION_UPDATE_INTERVAL=75
 151
 152 # Wait time to recheck for a pending update (in seconds).
 153 # Time to wait after an expected update was not available on the server.
 154 NOMINATIM_REPLICATION_RECHECK_INTERVAL=60
 155
 156 ### API settings
 157 #
 158 # The following settings configure the API responses. You must rerun
 159 # 'nominatim refresh --website' after changing any of them.
 160
 161 # Send permissive CORS access headers.
 162 # When enabled, send CORS headers to allow access to everybody.
 163 NOMINATIM_CORS_NOACCESSCONTROL=yes
 164
 165 # URL for static icon images.
 166 # Set this to the /mapicon directory of your nominatim-ui to enable returning
 167 # icon URLs with the results.
 168 NOMINATIM_MAPICON_URL=
 169
 170 # Language to assume when no particular language is requested.
 171 # When unset, the local language (i.e. the name tag without suffix) will be used.
 172 NOMINATIM_DEFAULT_LANGUAGE=
 173
 174 # Maximum number of OSM ids accepted by /lookup.
 175 NOMINATIM_LOOKUP_MAX_COUNT=50
 176
 177 # Number of different geometry formats that may be queried in parallel.
 178 # Set to zero to disable polygon output.
 179 NOMINATIM_POLYGON_OUTPUT_MAX_TYPES=1
 180
 181 # Offer backwards compatible PHP URLs.
 182 # When running one of the Python enignes, they will add endpoint aliases
 183 # under <endpoint>.php
 184 NOMINATIM_SERVE_LEGACY_URLS=yes
 185
 186 # Maximum number of connection a single API object can use. (Python API only)
 187 # When running Nominatim as a server, then this is the maximum number
 188 # of connections _per worker_.
 189 NOMINATIM_API_POOL_SIZE=10
 190
 191 # Timeout is seconds after which a single query to the database is cancelled.
 192 # The user receives a 503 response, when a query times out.
 193 # When empty, then timeouts are disabled.
 194 NOMINATIM_QUERY_TIMEOUT=10
 195
 196 # Maximum time a single request is allowed to take. When the timeout is
 197 # exceeded, the available results are returned.
 198 # When empty, then timeouts are disabled.
 199 NOMINATIM_REQUEST_TIMEOUT=60
 200
 201 # Search elements just within countries
 202 # If, despite not finding a point within the static grid of countries, it
 203 # finds a geometry of a region, do not return the geometry. Return "Unable
 204 # to geocode" instead.
 205 NOMINATIM_SEARCH_WITHIN_COUNTRIES=False
 206
 207 ### Log settings
 208 #
 209 # The following options allow to enable logging of API requests.
 210 # You must rerun 'nominatim refresh --website' after changing any of them.
 211 #
 212 # Enable logging of requests into the DB.
 213 # The request will be logged into the new_query_log table.
 214 # You should set up a cron job that regularly clears out this table.
 215 NOMINATIM_LOG_DB=no
 216
 217 # Enable logging of requests into a file.
 218 # To enable logging set this setting to the file to log to.
 219 NOMINATIM_LOG_FILE=
 220
 221 # Echo raw SQL from SQLAlchemy statements.
 222 # EXPERT: Works only in command line/library use.
 223 NOMINATIM_DEBUG_SQL=no