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 NOMINATIM_DATABASE_DSN="pgsql:dbname=nominatim"
   9
  10 # Database web user.
  11 # Nominatim sets up read-only access for this user during installation.
  12 NOMINATIM_DATABASE_WEBUSER="www-data"
  13
  14 # Tokenizer used for normalizing and parsing queries and names.
  15 # The tokenizer is set up during import and cannot be changed afterwards
  16 # without a reimport.
  17 # Currently available tokenizers: icu, legacy
  18 NOMINATIM_TOKENIZER="icu"
  19
  20 # If true, admin level changes on places with many contained children are blocked.
  21 NOMINATIM_LIMIT_REINDEXING=yes
  22
  23 # Restrict search languages.
  24 # Normally Nominatim will include all language variants of name:XX
  25 # in the search index. Set this to a comma separated list of language
  26 # codes, to restrict import to a subset of languages.
  27 # Currently only affects the initial import of country names and special phrases.
  28 NOMINATIM_LANGUAGES=
  29
  30 # Configuration file for the tokenizer.
  31 # The content depends on the tokenizer used. If left empty the default settings
  32 # for the chosen tokenizer will be used. The configuration can only be set
  33 # on import and not be changed afterwards.
  34 NOMINATIM_TOKENIZER_CONFIG=
  35
  36 # Search in the Tiger house number data for the US.
  37 # Note: The tables must already exist or queries will throw errors.
  38 # Changing this value requires to run ./utils/setup --create-functions.
  39 NOMINATIM_USE_US_TIGER_DATA=no
  40
  41 # Search in the auxiliary housenumber table.
  42 # Changing this value requires to run ./utils/setup --create-functions.
  43 NOMINATIM_USE_AUX_LOCATION_DATA=no
  44
  45 # Proxy settings
  46 # The following settings allow to set a proxy to use when remotely downloading
  47 # data. Host and port are required. Login and password are optional.
  48 NOMINATIM_HTTP_PROXY=no
  49 NOMINATIM_HTTP_PROXY_HOST=
  50 NOMINATIM_HTTP_PROXY_PORT=3128
  51 NOMINATIM_HTTP_PROXY_LOGIN=
  52 NOMINATIM_HTTP_PROXY_PASSWORD=
  53 # Also set these standard environment variables.
  54 # HTTP_PROXY="http://user:pass@10.10.1.10:1080"
  55 # HTTPS_PROXY="http://user:pass@10.10.1.10:1080"
  56
  57 # Location of the osm2pgsql binary.
  58 # EXPERT ONLY. You should usually use the supplied osm2pgsql.
  59 NOMINATIM_OSM2PGSQL_BINARY=
  60
  61 # Directory where to find pre-computed Wikipedia importance files.
  62 # When unset, the data is expected to be located in the project directory.
  63 NOMINATIM_WIKIPEDIA_DATA_PATH=
  64
  65 # Configuration file for rank assignments.
  66 NOMINATIM_ADDRESS_LEVEL_CONFIG=address-levels.json
  67
  68 # Configuration file for OSM data import.
  69 # This may either be the name of one of an internal style or point
  70 # to a file with a custom style.
  71 # Internal styles are: admin, street, address, full, extratags
  72 NOMINATIM_IMPORT_STYLE=extratags
  73
  74 # Location of the flatnode file used by osm2pgsql to store node locations.
  75 # When unset, osm2pgsql stores the location in the PostgreSQL database. This
  76 # is especially useful for imports of larger areas, like continents or the
  77 # full planet. The file needs at least 70GB storage.
  78 NOMINATIM_FLATNODE_FILE=
  79
  80 ### Tablespace settings
  81 #
  82 # The following settings allow to move parts of the database tables into
  83 # different tablespaces. This is especially interesting if you have disks
  84 # with different speeds. When unset, the default tablespace is used.
  85 # Only has an effect during import.
  86
  87 # Tablespace used for tables used when searching.
  88 NOMINATIM_TABLESPACE_SEARCH_DATA=
  89 # Tablespace used for indexes used when searching.
  90 NOMINATIM_TABLESPACE_SEARCH_INDEX=
  91
  92 # Tablespace used for the OSM data cache tables. Used for import and update only.
  93 NOMINATIM_TABLESPACE_OSM_DATA=
  94 # Tablespace used for the OSM data cache indexes. Used for import and update only.
  95 NOMINATIM_TABLESPACE_OSM_INDEX=
  96
  97 # Tablespace used for place import table. Used for import and update only.
  98 NOMINATIM_TABLESPACE_PLACE_DATA=
  99 # Tablespace used for place import indexes. Used for import and update only.
 100 NOMINATIM_TABLESPACE_PLACE_INDEX=
 101
 102 # Tablespace for tables used during address computation. Used for import and update only.
 103 NOMINATIM_TABLESPACE_ADDRESS_DATA=
 104 # Tablespace for indexes used during address computation. Used for import and update only.
 105 NOMINATIM_TABLESPACE_ADDRESS_INDEX=
 106
 107 # Tablespace for tables for auxiliary data, e.g. TIGER data, postcodes.
 108 NOMINATIM_TABLESPACE_AUX_DATA=
 109 # Tablespace for indexes for auxiliary data, e.g. TIGER data, postcodes.
 110 NOMINATIM_TABLESPACE_AUX_INDEX=
 111
 112
 113 ### Replication settings
 114 #
 115 # The following settings control where and how updates for the database are
 116 # retrieved.
 117 #
 118
 119 #
 120 # Base URL of replication service.
 121 # A replication service provides change files of OSM data at regular intervals.
 122 # These are used to keep the database up to date. Per default it points to
 123 # the minutely updates for the main OSM database. There are other services
 124 # geared towards larger update intervals or data extracts.
 125 # Changing this value requires to rerun 'nominatim replication --init'.
 126 NOMINATIM_REPLICATION_URL="https://planet.openstreetmap.org/replication/minute"
 127
 128 # Maximum amount of data to download per batch.
 129 # Size is in MB.
 130 NOMINATIM_REPLICATION_MAX_DIFF=50
 131
 132 # Publication interval of the replication service (in seconds).
 133 # Determines when Nominatim will attempt again to download again a new
 134 # update. The time is computed from the publication date of the last diff
 135 # downloaded. Setting this to a slightly higher value than the actual
 136 # publication interval avoids unnecessary rechecks.
 137 NOMINATIM_REPLICATION_UPDATE_INTERVAL=75
 138
 139 # Wait time to recheck for a pending update (in seconds).
 140 # Time to wait after an expected update was not available on the server.
 141 NOMINATIM_REPLICATION_RECHECK_INTERVAL=60
 142
 143 ### API settings
 144 #
 145 # The following settings configure the API responses.
 146
 147 # Send permissive CORS access headers.
 148 # When enabled, send CORS headers to allow access to everybody.
 149 NOMINATIM_CORS_NOACCESSCONTROL=yes
 150
 151 # URL for static icon images.
 152 # Set this to the /mapicon directory of your nominatim-ui to enable returning
 153 # icon URLs with the results.
 154 NOMINATIM_MAPICON_URL=
 155
 156 # Language to assume when no particular language is requested.
 157 # When unset, the local language (i.e. the name tag without suffix) will be used.
 158 NOMINATIM_DEFAULT_LANGUAGE=
 159
 160 # Maximum number of OSM ids accepted by /lookup.
 161 NOMINATIM_LOOKUP_MAX_COUNT=50
 162
 163 # Number of different geometry formats that may be queried in parallel.
 164 # Set to zero to disable polygon output.
 165 NOMINATIM_POLYGON_OUTPUT_MAX_TYPES=1
 166
 167 # Offer backwards compatible PHP URLs.
 168 # When running one of the Python enignes, they will add endpoint aliases
 169 # under <endpoint>.php
 170 NOMINATIM_SERVE_LEGACY_URLS=yes
 171
 172 # Maximum number of DB connections a single API object can use.
 173 # When running Nominatim as a server, then this is the maximum number
 174 # of connections _per worker_.
 175 NOMINATIM_API_POOL_SIZE=5
 176
 177 # Timeout is seconds after which a single query to the database is cancelled.
 178 # The caller receives a TimeoutError (or HTTP 503), when a query times out.
 179 # When empty, then timeouts are disabled.
 180 NOMINATIM_QUERY_TIMEOUT=10
 181
 182 # Maximum time a single request is allowed to take. If the timeout is exceeded
 183 # before the request is able to obtain a database connection from the
 184 # connection pool, a TimeoutError (or HTTP 503) is thrown. If the timeout
 185 # is exceeded while the search is ongoing, all results already found will
 186 # be returned.
 187 # When empty, then timeouts are disabled.
 188 NOMINATIM_REQUEST_TIMEOUT=60
 189
 190 # Search elements just within countries
 191 # If, despite not finding a point within the static grid of countries, it
 192 # finds a geometry of a region, do not return the geometry. Return "Unable
 193 # to geocode" instead.
 194 NOMINATIM_SEARCH_WITHIN_COUNTRIES=False
 195
 196 # Specifies the order in which different name tags are used.
 197 # The values in this list determine the preferred order of name variants,
 198 # including language-specific names.
 199 # Comma-separated list, where :XX stands for language-specific tags
 200 # (e.g. name:en) and no :XX stands for general tags (e.g. name).
 201 NOMINATIM_OUTPUT_NAMES=name:XX,name,brand,official_name:XX,short_name:XX,official_name,short_name,ref
 202
 203 ### Log settings
 204 #
 205 # The following options allow to enable logging of API requests.
 206 #
 207 # Enable logging of requests into a file.
 208 # To enable logging set this setting to the file to log to.
 209 NOMINATIM_LOG_FILE=
 210
 211 # Set the output format of the query log.
 212 # This is a string following the Python String Format syntax,
 213 # see https://docs.python.org/3/library/string.html#formatstrings.
 214 # For possible replacement values, see the full documentation at
 215 # https://nominatim.org/release-docs/latest/customize/Settings/
 216 NOMINATIM_LOG_FORMAT='[{start}] {total_time:.4f} {results_total} {endpoint} "{query_string}"'
 217
 218 # Echo raw SQL from SQLAlchemy statements.
 219 # EXPERT: Works only in command line/library use.
 220 NOMINATIM_DEBUG_SQL=no