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