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