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