docs/customize/Settings.md

   1 This section provides a reference of all configuration parameters that can
   2 be used with Nominatim.
   3
   4 # Configuring Nominatim
   5
   6 Nominatim uses [dotenv](https://github.com/theskumar/python-dotenv) to manage
   7 its configuration settings. There are two means to set configuration
   8 variables: through an `.env` configuration file or through an environment
   9 variable.
  10
  11 The `.env` configuration file needs to be placed into the
  12 [project directory](../admin/Import.md#creating-the-project-directory). It
  13 must contain configuration parameters in `<parameter>=<value>` format.
  14 Please refer to the dotenv documentation for details.
  15
  16 The configuration options may also be set in the form of shell environment
  17 variables. This is particularly useful, when you want to temporarily change
  18 a configuration option. For example, to force the replication serve to
  19 download the next change, you can temporarily disable the update interval:
  20
  21     NOMINATIM_REPLICATION_UPDATE_INTERVAL=0 nominatim replication --once
  22
  23 If a configuration option is defined through .env file and environment
  24 variable, then the latter takes precedence.
  25
  26 ## Configuration Parameter Reference
  27
  28 ### Import and Database Settings
  29
  30 #### NOMINATIM_DATABASE_DSN
  31
  32 | Summary            |                                                     |
  33 | --------------     | --------------------------------------------------- |
  34 | **Description:**   | Database connection string |
  35 | **Format:**        | string: `pgsql:<param1>=<value1>;<param2>=<value2>;...` |
  36 | **Default:**       | pgsql:dbname=nominatim |
  37 | **After Changes:** | run `nominatim refresh --website` |
  38
  39 Sets the connection parameters for the Nominatim database. At a minimum
  40 the name of the database (`dbname`) is required. You can set any additional
  41 parameter that is understood by libpq. See the [Postgres documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS) for a full list.
  42
  43 !!! note
  44     It is usually recommended not to set the password directly in this
  45     configuration parameter. Use a
  46     [password file](https://www.postgresql.org/docs/current/libpq-pgpass.html)
  47     instead.
  48
  49
  50 #### NOMINATIM_DATABASE_WEBUSER
  51
  52 | Summary            |                                                     |
  53 | --------------     | --------------------------------------------------- |
  54 | **Description:**   | Database query user |
  55 | **Format:**        | string  |
  56 | **Default:**       | www-data |
  57 | **After Changes:** | cannot be changed after import |
  58
  59 Defines the name of the database user that will run search queries. Usually
  60 this is the user under which the webserver is executed. When running Nominatim
  61 via php-fpm, you can also define a separate query user. The Postgres user
  62 needs to be set up before starting the import.
  63
  64 Nominatim grants minimal rights to this user to all tables that are needed
  65 for running geocoding queries.
  66
  67
  68 #### NOMINATIM_DATABASE_MODULE_PATH
  69
  70 | Summary            |                                                     |
  71 | --------------     | --------------------------------------------------- |
  72 | **Description:**   | Directory where to find the PostgreSQL server module |
  73 | **Format:**        | path |
  74 | **Default:**       | _empty_ (use `<project_directory>/module`) |
  75 | **After Changes:** | run `nominatim refresh --functions` |
  76 | **Comment:**       | Legacy tokenizer only |
  77
  78 Defines the directory in which the PostgreSQL server module `nominatim.so`
  79 is stored. The directory and module must be accessible by the PostgreSQL
  80 server.
  81
  82 For information on how to use this setting when working with external databases,
  83 see [Advanced Installations](../admin/Advanced-Installations.md).
  84
  85 The option is only used by the Legacy tokenizer and ignored otherwise.
  86
  87
  88 #### NOMINATIM_TOKENIZER
  89
  90 | Summary            |                                                     |
  91 | --------------     | --------------------------------------------------- |
  92 | **Description:**   | Tokenizer used for normalizing and parsing queries and names |
  93 | **Format:**        | string |
  94 | **Default:**       | legacy |
  95 | **After Changes:** | cannot be changed after import |
  96
  97 Sets the tokenizer type to use for the import. For more information on
  98 available tokenizers and how they are configured, see
  99 [Tokenizers](../customize/Tokenizers.md).
 100
 101
 102 #### NOMINATIM_TOKENIZER_CONFIG
 103
 104 | Summary            |                                                     |
 105 | --------------     | --------------------------------------------------- |
 106 | **Description:**   | Configuration file for the tokenizer |
 107 | **Format:**        | path |
 108 | **Default:**       | _empty_ (default file depends on tokenizer) |
 109 | **After Changes:** | see documentation for each tokenizer |
 110
 111 Points to the file with additional configuration for the tokenizer.
 112 See the [Tokenizer](../customize/Tokenizers.md) descriptions for details
 113 on the file format.
 114
 115 #### NOMINATIM_MAX_WORD_FREQUENCY
 116
 117 | Summary            |                                                     |
 118 | --------------     | --------------------------------------------------- |
 119 | **Description:**   | Number of occurrences before a word is considered frequent |
 120 | **Format:**        | int |
 121 | **Default:**       | 50000 |
 122 | **After Changes:** | cannot be changed after import |
 123 | **Comment:**       | Legacy tokenizer only |
 124
 125 The word frequency count is used by the Legacy tokenizer to automatically
 126 identify _stop words_. Any partial term that occurs more often then what
 127 is defined in this setting, is effectively ignored during search.
 128
 129
 130 #### NOMINATIM_LIMIT_REINDEXING
 131
 132 | Summary            |                                                     |
 133 | --------------     | --------------------------------------------------- |
 134 | **Description:**   | Avoid invalidating large areas |
 135 | **Format:**        | bool |
 136 | **Default:**       | yes |
 137
 138 Nominatim computes the address of each place at indexing time. This has the
 139 advantage to make search faster but also means that more objects needs to
 140 be invalidated when the data changes. For example, changing the name of
 141 the state of Florida would require recomputing every single address point
 142 in the state to make the new name searchable in conjunction with addresses.
 143
 144 Setting this option to 'yes' means that Nominatim skips reindexing of contained
 145 objects when the area becomes too large.
 146
 147
 148 #### NOMINATIM_LANGUAGES
 149
 150 | Summary            |                                                     |
 151 | --------------     | --------------------------------------------------- |
 152 | **Description:**   | Restrict search languages |
 153 | **Format:**        | comma,separated list of language codes |
 154 | **Default:**       | _empty_ |
 155
 156 Normally Nominatim will include all language variants of name:XX
 157 in the search index. Set this to a comma separated list of language
 158 codes, to restrict import to a subset of languages.
 159
 160 Currently only affects the initial import of country names and special phrases.
 161
 162
 163 #### NOMINATIM_TERM_NORMALIZATION
 164
 165 | Summary            |                                                     |
 166 | --------------     | --------------------------------------------------- |
 167 | **Description:**   | Rules for normalizing terms for comparisons |
 168 | **Format:**        | string: semicolon-separated list of ICU rules |
 169 | **Default:**       | :: NFD (); [[:Nonspacing Mark:] [:Cf:]] >;  :: lower (); [[:Punctuation:][:Space:]]+ > ' '; :: NFC (); |
 170 | **Comment:**       | Legacy tokenizer only |
 171
 172 [Special phrases](Special-Phrases.md) have stricter matching requirements than
 173 normal search terms. They must appear exactly in the query after this term
 174 normalization has been applied.
 175
 176 Only has an effect on the Legacy tokenizer. For the ICU tokenizer the rules
 177 defined in the
 178 [normalization section](Tokenizers.md#normalization-and-transliteration)
 179 will be used.
 180
 181
 182 #### NOMINATIM_USE_US_TIGER_DATA
 183
 184 | Summary            |                                                     |
 185 | --------------     | --------------------------------------------------- |
 186 | **Description:**   | Enable searching for Tiger house number data |
 187 | **Format:**        | boolean |
 188 | **Default:**       | no |
 189 | **After Changes:** | run `nominatim --refresh --functions` |
 190
 191 When this setting is enabled, search and reverse queries also take data
 192 from [Tiger house number data](Tiger.md) into account.
 193
 194
 195 #### NOMINATIM_USE_AUX_LOCATION_DATA
 196
 197 | Summary            |                                                     |
 198 | --------------     | --------------------------------------------------- |
 199 | **Description:**   | Enable searching in external house number tables |
 200 | **Format:**        | boolean |
 201 | **Default:**       | no |
 202 | **After Changes:** | run `nominatim --refresh --functions` |
 203 | **Comment:**       | Do not use. |
 204
 205 When this setting is enabled, search queries also take data from external
 206 house number tables into account.
 207
 208 *Warning:* This feature is currently unmaintained and should not be used.
 209
 210
 211 #### NOMINATIM_HTTP_PROXY
 212
 213 | Summary            |                                                     |
 214 | --------------     | --------------------------------------------------- |
 215 | **Description:**   | Use HTTP proxy when downloading data |
 216 | **Format:**        | boolean |
 217 | **Default:**       | no |
 218
 219 When this setting is enabled and at least
 220 [NOMINATIM_HTTP_PROXY_HOST](#nominatim_http_proxy_host) and
 221 [NOMINATIM_HTTP_PROXY_PORT](#nominatim_http_proxy_port) are set, the
 222 configured proxy will be used, when downloading external data like
 223 replication diffs.
 224
 225
 226 #### NOMINATIM_HTTP_PROXY_HOST
 227
 228 | Summary            |                                                     |
 229 | --------------     | --------------------------------------------------- |
 230 | **Description:**   | Host name of the proxy to use |
 231 | **Format:**        | string |
 232 | **Default:**       | _empty_ |
 233
 234 When [NOMINATIM_HTTP_PROXY](#nominatim_http_proxy) is enabled, this setting
 235 configures the proxy host name.
 236
 237
 238 #### NOMINATIM_HTTP_PROXY_PORT
 239
 240 | Summary            |                                                     |
 241 | --------------     | --------------------------------------------------- |
 242 | **Description:**   | Port number of the proxy to use |
 243 | **Format:**        | integer |
 244 | **Default:**       | 3128 |
 245
 246 When [NOMINATIM_HTTP_PROXY](#nominatim_http_proxy) is enabled, this setting
 247 configures the port number to use with the proxy.
 248
 249
 250 #### NOMINATIM_HTTP_PROXY_LOGIN
 251
 252 | Summary            |                                                     |
 253 | --------------     | --------------------------------------------------- |
 254 | **Description:**   | Username for proxies that require login |
 255 | **Format:**        | string |
 256 | **Default:**       | _empty_ |
 257
 258 When [NOMINATIM_HTTP_PROXY](#nominatim_http_proxy) is enabled, use this
 259 setting to define the username for proxies that require a login.
 260
 261
 262 #### NOMINATIM_HTTP_PROXY_PASSWORD
 263
 264 | Summary            |                                                     |
 265 | --------------     | --------------------------------------------------- |
 266 | **Description:**   | Password for proxies that require login |
 267 | **Format:**        | string |
 268 | **Default:**       | _empty_ |
 269
 270 When [NOMINATIM_HTTP_PROXY](#nominatim_http_proxy) is enabled, use this
 271 setting to define the password for proxies that require a login.
 272
 273
 274 #### NOMINATIM_OSM2PGSQL_BINARY
 275
 276 | Summary            |                                                     |
 277 | --------------     | --------------------------------------------------- |
 278 | **Description:**   | Location of the osm2pgsql binary |
 279 | **Format:**        | path |
 280 | **Default:**       | _empty_ (use binary shipped with Nominatim) |
 281 | **Comment:**       | EXPERT ONLY |
 282
 283 Nominatim uses [osm2pgsql](https://osm2pgsql.org) to load the OSM data
 284 initially into the database. Nominatim comes bundled with a version of
 285 osm2pgsql that is guaranteed to be compatible. Use this setting to use
 286 a different binary instead. You should do this only, when you know exactly
 287 what you are doing. If the osm2pgsql version is not compatible, then the
 288 result is undefined.
 289
 290
 291 #### NOMINATIM_WIKIPEDIA_DATA_PATH
 292
 293 | Summary            |                                                     |
 294 | --------------     | --------------------------------------------------- |
 295 | **Description:**   | Directory with the wikipedia importance data |
 296 | **Format:**        | path |
 297 | **Default:**       | _empty_ (project directory) |
 298
 299 Set a custom location for the
 300 [wikipedia ranking file](../admin/Import.md#wikipediawikidata-rankings). When
 301 unset, Nominatim expects the data to be saved in the project directory.
 302
 303 #### NOMINATIM_PHRASE_CONFIG
 304
 305 | Summary            |                                                     |
 306 | --------------     | --------------------------------------------------- |
 307 | **Description:**   | Configuration file for special phrase imports |
 308 | **Format:**        | path |
 309 | **Default:**       | _empty_ (use default settings) |
 310
 311 The _phrase_config_ file configures black and white lists of tag types,
 312 so that some of them can be ignored, when loading special phrases from
 313 the OSM wiki. The default settings can be found in the configuration
 314 directory as `phrase-settings.json`.
 315
 316 #### NOMINATIM_ADDRESS_LEVEL_CONFIG
 317
 318 | Summary            |                                                     |
 319 | --------------     | --------------------------------------------------- |
 320 | **Description:**   | Configuration file for rank assignments |
 321 | **Format:**        | path |
 322 | **Default:**       | _empty_ (use default settings) |
 323
 324 The _address level config_ configures rank assignments for places. See
 325 [Place Ranking](Ranking.md) for a detailed explanation what rank assignments
 326 are and what the configuration file must look like. The default configuration
 327 can be found in the configuration directory as `address-levels.json`.
 328
 329 #### NOMINATIM_IMPORT_STYLE
 330
 331 | Summary            |                                                     |
 332 | --------------     | --------------------------------------------------- |
 333 | **Description:**   | Configuration to use for the initial OSM data import |
 334 | **Format:**        | string or path |
 335 | **Default:**       | extratags |
 336
 337 The _style configuration_ describes which OSM objects and tags are taken
 338 into consideration for the search database. This setting may either
 339 be a string pointing to one of the internal styles or it may be a path
 340 pointing to a custom style.
 341
 342 See [Import Styles](Import-Styles.md)
 343 for more information on the available internal styles and the format of the
 344 configuration file.
 345
 346 #### NOMINATIM_FLATNODE_FILE
 347
 348 | Summary            |                                                     |
 349 | --------------     | --------------------------------------------------- |
 350 | **Description:**   | Location of osm2pgsql flatnode file |
 351 | **Format:**        | path |
 352 | **Default:**       | _empty_ (do not use a flatnote file) |
 353 | **After Changes:** | Only change when moving the file physically. |
 354
 355 The `osm2pgsql flatnode file` is file that efficiently stores geographic
 356 location for OSM nodes. For larger imports it can significantly speed up
 357 the import. When this option is unset, then osm2pgsql uses a PsotgreSQL table
 358 to store the locations.
 359
 360 !!! warning
 361
 362     The flatnode file is not only used during the initial import but also
 363     when adding new data with `nominatim add-data` or `nominatim replication`.
 364     Make sure you keep the flatnode file around and this setting unmodified,
 365     if you plan to add more data or run regular updates.
 366
 367
 368 #### NOMINATIM_TABLESPACE_*
 369
 370 | Summary            |                                                     |
 371 | --------------     | --------------------------------------------------- |
 372 | **Description:**   | Group of settings for distributing the database over tablespaces |
 373 | **Format:**        | string |
 374 | **Default:**       | _empty_ (do not use a table space) |
 375 | **After Changes:** | no effect after initial import |
 376
 377 Nominatim allows to distribute the search database over up to 10 different
 378 [PostgreSQL tablespaces](https://www.postgresql.org/docs/current/manage-ag-tablespaces.html).
 379 If you use this option, make sure that the tablespaces exist before starting
 380 the import.
 381
 382 The available tablespace groups are:
 383
 384 NOMINATIM_TABLESPACE_SEARCH_DATA
 385 :    Data used by the geocoding frontend.
 386
 387 NOMINATIM_TABLESPACE_SEARCH_INDEX
 388 :    Indexes used by the geocoding frontend.
 389
 390 NOMINATIM_TABLESPACE_OSM_DATA
 391 :    Raw OSM data cache used for import and updates.
 392
 393 NOMINATIM_TABLESPACE_OSM_DATA
 394 :    Indexes on the raw OSM data cache.
 395
 396 NOMINATIM_TABLESPACE_PLACE_DATA
 397 :    Data table with the pre-filtered but still unprocessed OSM data.
 398      Used only during imports and updates.
 399
 400 NOMINATIM_TABLESPACE_PLACE_INDEX
 401 :    Indexes on raw data table. Used only during imports and updates.
 402
 403 NOMINATIM_TABLESPACE_ADDRESS_DATA
 404 :    Data tables used for computing search terms and addresses of places
 405      during import and updates.
 406
 407 NOMINATIM_TABLESPACE_ADDRESS_INDEX
 408 :    Indexes on the data tables for search term and address computation.
 409      Used only for import and updates.
 410
 411 NOMINATIM_TABLESPACE_AUX_DATA
 412 :    Auxiliary data tables for non-OSM data, e.g. for Tiger house number data.
 413
 414 NOMINATIM_TABLESPACE_AUX_INDEX
 415 :    Indexes on auxiliary data tables.
 416
 417
 418 ### Replication Update Settings
 419
 420 #### NOMINATIM_REPLICATION_URL
 421
 422 | Summary            |                                                     |
 423 | --------------     | --------------------------------------------------- |
 424 | **Description:**   | Base URL of the replication service |
 425 | **Format:**        | url |
 426 | **Default:**       | https://planet.openstreetmap.org/replication/minute |
 427 | **After Changes:** | run `nominatim replication --init` |
 428
 429 Replication services deliver updates to OSM data. Use this setting to choose
 430 which replication service to use. See [Updates](../admin/Update.md) for more
 431 information on how to set up regular updates.
 432
 433 #### NOMINATIM_REPLICATION_MAX_DIFF
 434
 435 | Summary            |                                                     |
 436 | --------------     | --------------------------------------------------- |
 437 | **Description:**   | Maximum amount of data to download per update cycle (in MB) |
 438 | **Format:**        | integer |
 439 | **Default:**       | 50 |
 440 | **After Changes:** | restart the replication process |
 441
 442 At each update cycle Nominatim downloads diffs until either no more diffs
 443 are available on the server (i.e. the database is up-to-date) or the limit
 444 given in this setting is exceeded. Nominatim guarantees to downloads at least
 445 one diff, if one is available, no matter how small the setting.
 446
 447 The default for this setting is fairly conservative because Nominatim keeps
 448 all data downloaded in one cycle in RAM. Using large values in a production
 449 server may interfere badly with the search frontend because it evicts data
 450 from RAM that is needed for speedy answers to incoming requests. It is usually
 451 a better idea to keep this setting lower and run multiple update cycles
 452 to catch up with updates.
 453
 454 When catching up in non-production mode, for example after the initial import,
 455 the setting can easily be changed temporarily on the command line:
 456
 457     NOMINATIM_REPLICATION_MAX_DIFF=3000 nominatim replication
 458
 459
 460 #### NOMINATIM_REPLICATION_UPDATE_INTERVAL
 461
 462 | Summary            |                                                     |
 463 | --------------     | --------------------------------------------------- |
 464 | **Description:**   | Publication interval of the replication service (in seconds) |
 465 | **Format:**        | integer |
 466 | **Default:**       | 75 |
 467 | **After Changes:** | restart the replication process |
 468
 469 This setting determines when Nominatim will attempt to download again a new
 470 update. The time is computed from the publication date of the last diff
 471 downloaded. Setting this to a slightly higher value than the actual
 472 publication interval avoids unnecessary rechecks.
 473
 474
 475 #### NOMINATIM_REPLICATION_RECHECK_INTERVAL
 476
 477 | Summary            |                                                     |
 478 | --------------     | --------------------------------------------------- |
 479 | **Description:**   | Wait time to recheck for a pending update (in seconds)  |
 480 | **Format:**        | integer |
 481 | **Default:**       | 60 |
 482 | **After Changes:** | restart the replication process |
 483
 484 When replication updates are run in continuous mode (using `nominatim replication`),
 485 this setting determines how long Nominatim waits until it looks for updates
 486 again when updates were not available on the server.
 487
 488 Note that this is different from
 489 [NOMINATIM_REPLICATION_UPDATE_INTERVAL](#nominatim_replication_update_interval).
 490 Nominatim will never attempt to query for new updates for UPDATE_INTERVAL
 491 seconds after the current database date. Only after the update interval has
 492 passed it asks for new data. If then no new data is found, it waits for
 493 RECHECK_INTERVAL seconds before it attempts again.
 494
 495 ### API Settings
 496
 497 #### NOMINATIM_CORS_NOACCESSCONTROL
 498
 499 | Summary            |                                                     |
 500 | --------------     | --------------------------------------------------- |
 501 | **Description:**   | Send permissive CORS access headers |
 502 | **Format:**        | boolean |
 503 | **Default:**       | yes |
 504 | **After Changes:** | run `nominatim refresh --website` |
 505
 506 When this setting is enabled, API HTTP responses include the HTTP
 507 [CORS](https://en.wikipedia.org/wiki/CORS) headers
 508 `access-control-allow-origin: *` and `access-control-allow-methods: OPTIONS,GET`.
 509
 510 #### NOMINATIM_MAPICON_URL
 511
 512 | Summary            |                                                     |
 513 | --------------     | --------------------------------------------------- |
 514 | **Description:**   | URL prefix for static icon images |
 515 | **Format:**        | url |
 516 | **Default:**       | _empty_ |
 517 | **After Changes:** | run `nominatim refresh --website` |
 518
 519 When a mapicon URL is configured, then Nominatim includes an additional `icon`
 520 field in the responses, pointing to an appropriate icon for the place type.
 521
 522 Map icons used to be included in Nominatim itself but now have moved to the
 523 [nominatim-ui](https://github.com/osm-search/nominatim-ui/) project. If you
 524 want the URL to be included in API responses, make the `/mapicon`
 525 directory of the project available under a public URL and point this setting
 526 to the directory.
 527
 528
 529 #### NOMINATIM_DEFAULT_LANGUAGE
 530
 531 | Summary            |                                                     |
 532 | --------------     | --------------------------------------------------- |
 533 | **Description:**   | Language of responses when no language is requested |
 534 | **Format:**        | language code |
 535 | **Default:**       | _empty_ (use the local language of the feature) |
 536 | **After Changes:** | run `nominatim refresh --website` |
 537
 538 Nominatim localizes the place names in responses when the corresponding
 539 translation is available. Users can request a custom language setting through
 540 the HTTP accept-languages header or through the explicit parameter
 541 [accept-languages](../api/Search.md#language-of-results). If neither is
 542 given, it falls back to this setting. If the setting is also empty, then
 543 the local languages (in OSM: the name tag without any language suffix) is
 544 used.
 545
 546
 547 #### NOMINATIM_SEARCH_BATCH_MODE
 548
 549 | Summary            |                                                     |
 550 | --------------     | --------------------------------------------------- |
 551 | **Description:**   | Enable a special batch query mode |
 552 | **Format:**        | boolean |
 553 | **Default:**       | no |
 554 | **After Changes:** | run `nominatim refresh --website` |
 555
 556 This feature is currently undocumented and potentially broken.
 557
 558
 559 #### NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD
 560
 561 | Summary            |                                                     |
 562 | --------------     | --------------------------------------------------- |
 563 | **Description:**   | Threshold for switching the search index lookup strategy |
 564 | **Format:**        | integer |
 565 | **Default:**       | 500 |
 566 | **After Changes:** | run `nominatim refresh --website` |
 567
 568 This setting defines the threshold over which a name is no longer considered
 569 as rare. When searching for places with rare names, only the name is used
 570 for place lookups. Otherwise the name and any address information is used.
 571
 572 This setting only has an effect after `nominatim refresh --word-counts` has
 573 been called to compute the word frequencies.
 574
 575
 576 #### NOMINATIM_LOOKUP_MAX_COUNT
 577
 578 | Summary            |                                                     |
 579 | --------------     | --------------------------------------------------- |
 580 | **Description:**   | Maximum number of OSM ids accepted by /lookup |
 581 | **Format:**        | integer |
 582 | **Default:**       | 50 |
 583 | **After Changes:** | run `nominatim refresh --website` |
 584
 585 The /lookup point accepts list of ids to look up address details for. This
 586 setting restricts the number of places a user may look up with a single
 587 request.
 588
 589
 590 #### NOMINATIM_POLYGON_OUTPUT_MAX_TYPES
 591
 592 | Summary            |                                                     |
 593 | --------------     | --------------------------------------------------- |
 594 | **Description:**   | Number of different geometry formats that may be returned |
 595 | **Format:**        | integer |
 596 | **Default:**       | 1 |
 597 | **After Changes:** | run `nominatim refresh --website` |
 598
 599 Nominatim supports returning full geometries of places. The geometries may
 600 be requested in different formats with one of the
 601 [`polygon_*` parameters](../api/Search.md#polygon-output). Use this
 602 setting to restrict the number of geometry types that may be requested
 603 with a single query.
 604
 605 Setting this parameter to 0 disables polygon output completely.
 606
 607 ### Logging Settings
 608
 609 #### NOMINATIM_LOG_DB
 610
 611 | Summary            |                                                     |
 612 | --------------     | --------------------------------------------------- |
 613 | **Description:**   | Log requests into the database |
 614 | **Format:**        | boolean |
 615 | **Default:**       | no |
 616 | **After Changes:** | run `nominatim refresh --website` |
 617
 618 Enable logging requests into a database table with this setting. The logs
 619 can be found in the table `new_query_log`.
 620
 621 When using this logging method, it is advisable to set up a job that
 622 regularly clears out old logging information. Nominatim will not do that
 623 on its own.
 624
 625 Can be used as the same time as NOMINATIM_LOG_FILE.
 626
 627 #### NOMINATIM_LOG_FILE
 628
 629 | Summary            |                                                     |
 630 | --------------     | --------------------------------------------------- |
 631 | **Description:**   | Log requests into a file |
 632 | **Format:**        | path |
 633 | **Default:**       | _empty_ (logging disabled) |
 634 | **After Changes:** | run `nominatim refresh --website` |
 635
 636 Enable logging of requests into a file with this setting by setting the log
 637 file where to log to. The entries in the log file have the following format:
 638
 639     <request time> <execution time in s> <number of results> <type> "<query string>"
 640
 641 Request time is the time when the request was started. The execution time is
 642 given in ms and corresponds to the time the query took executing in PHP.
 643 type contains the name of the endpoint used.
 644
 645 Can be used as the same time as NOMINATIM_LOG_DB.