X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8c7140d92b7a679ae5ef5bb3655c69bd39b7dfeb..7d418da564484c3f2fffcd4801188d6ffc4f436a:/docs/customize/Settings.md?ds=inline diff --git a/docs/customize/Settings.md b/docs/customize/Settings.md index 8245e309..b00d04cf 100644 --- a/docs/customize/Settings.md +++ b/docs/customize/Settings.md @@ -57,34 +57,13 @@ parameter that is understood by libpq. See the [Postgres documentation](https:// | **After Changes:** | cannot be changed after import | Defines the name of the database user that will run search queries. Usually -this is the user under which the webserver is executed. When running Nominatim -via php-fpm, you can also define a separate query user. The Postgres user +this is the user under which the webserver is executed. The Postgres user needs to be set up before starting the import. Nominatim grants minimal rights to this user to all tables that are needed for running geocoding queries. -#### NOMINATIM_DATABASE_MODULE_PATH - -| Summary | | -| -------------- | --------------------------------------------------- | -| **Description:** | Directory where to find the PostgreSQL server module | -| **Format:** | path | -| **Default:** | _empty_ (use `/module`) | -| **After Changes:** | run `nominatim refresh --functions` | -| **Comment:** | Legacy tokenizer only | - -Defines the directory in which the PostgreSQL server module `nominatim.so` -is stored. The directory and module must be accessible by the PostgreSQL -server. - -For information on how to use this setting when working with external databases, -see [Advanced Installations](../admin/Advanced-Installations.md). - -The option is only used by the Legacy tokenizer and ignored otherwise. - - #### NOMINATIM_TOKENIZER | Summary | | @@ -115,20 +94,6 @@ on the file format. If a relative path is given, then the file is searched first relative to the project directory and then in the global settings directory. -#### NOMINATIM_MAX_WORD_FREQUENCY - -| Summary | | -| -------------- | --------------------------------------------------- | -| **Description:** | Number of occurrences before a word is considered frequent | -| **Format:** | int | -| **Default:** | 50000 | -| **After Changes:** | cannot be changed after import | -| **Comment:** | Legacy tokenizer only | - -The word frequency count is used by the Legacy tokenizer to automatically -identify _stop words_. Any partial term that occurs more often then what -is defined in this setting, is effectively ignored during search. - #### NOMINATIM_LIMIT_REINDEXING @@ -163,25 +128,6 @@ codes, to restrict import to a subset of languages. Currently only affects the initial import of country names and special phrases. -#### NOMINATIM_TERM_NORMALIZATION - -| Summary | | -| -------------- | --------------------------------------------------- | -| **Description:** | Rules for normalizing terms for comparisons | -| **Format:** | string: semicolon-separated list of ICU rules | -| **Default:** | :: NFD (); [[:Nonspacing Mark:] [:Cf:]] >; :: lower (); [[:Punctuation:][:Space:]]+ > ' '; :: NFC (); | -| **Comment:** | Legacy tokenizer only | - -[Special phrases](Special-Phrases.md) have stricter matching requirements than -normal search terms. They must appear exactly in the query after this term -normalization has been applied. - -Only has an effect on the Legacy tokenizer. For the ICU tokenizer the rules -defined in the -[normalization section](Tokenizers.md#normalization-and-transliteration) -will be used. - - #### NOMINATIM_USE_US_TIGER_DATA | Summary | | @@ -544,38 +490,6 @@ the local languages (in OSM: the name tag without any language suffix) is used. -#### NOMINATIM_SEARCH_BATCH_MODE - -| Summary | | -| -------------- | --------------------------------------------------- | -| **Description:** | Enable a special batch query mode | -| **Format:** | boolean | -| **Default:** | no | -| **After Changes:** | run `nominatim refresh --website` | -| **Comment:** | PHP frontend only | - - -This feature is currently undocumented and potentially broken. - - -#### NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD - -| Summary | | -| -------------- | --------------------------------------------------- | -| **Description:** | Threshold for switching the search index lookup strategy | -| **Format:** | integer | -| **Default:** | 500 | -| **After Changes:** | run `nominatim refresh --website` | -| **Comment:** | PHP frontend only | - -This setting defines the threshold over which a name is no longer considered -as rare. When searching for places with rare names, only the name is used -for place lookups. Otherwise the name and any address information is used. - -This setting only has an effect after `nominatim refresh --word-counts` has -been called to compute the word frequencies. - - #### NOMINATIM_LOOKUP_MAX_COUNT | Summary | | @@ -616,7 +530,6 @@ Setting this parameter to 0 disables polygon output completely. | **Format:** | boolean | | **Default:** | no | | **After Changes:** | run `nominatim refresh --website` | -| **Comment:** | PHP frontend only | Enable to search elements just within countries. @@ -728,7 +641,8 @@ The entries in the log file have the following format: "" Request time is the time when the request was started. The execution time is -given in seconds and corresponds to the time the query took executing in PHP. +given in seconds and includes the entire time the query was queued and executed +in the frontend. type contains the name of the endpoint used. Can be used as the same time as NOMINATIM_LOG_DB.