refer to new nominatim tool in configuration comments

[nominatim.git] / settings / env.defaults

diff --git a/settings/env.defaults b/settings/env.defaults
index 0a7b60d1408923ae7fe92745f1c4d2635b7ca8e5..53efb3f79f016ac835bad7944249b3383c80eeaa 100644 (file)
--- a/settings/env.defaults
+++ b/settings/env.defaults
@@ -5,7 +5,7 @@
 # Database connection string.
 # Add host, port, user etc through additional semicolon-separated attributes.
 # e.g. ;host=...;port=...;user=...;password=...
-# Changing this variable requires to run 'setup.php --setup-website'.
+# Changing this variable requires to run 'nominatim refresh --website'.
 NOMINATIM_DATABASE_DSN="pgsql:dbname=nominatim"
 
 # Database web user.
@@ -15,7 +15,7 @@ NOMINATIM_DATABASE_WEBUSER="www-data"
 # Directory where to find the PostgreSQL server module.
 # When empty the module is expected to be located in the 'module' subdirectory
 # in the project directory.
-# Changing this value requires to run ./utils/setup --create-functions.
+# Changing this value requires to run 'nominatim refresh --functions'.
 NOMINATIM_DATABASE_MODULE_PATH=
 
 # Number of occurances of a word before it is considered frequent.
@@ -57,6 +57,9 @@ NOMINATIM_HTTP_PROXY_HOST=proxy.mydomain.com
 NOMINATIM_HTTP_PROXY_PORT=3128
 NOMINATIM_HTTP_PROXY_LOGIN=
 NOMINATIM_HTTP_PROXY_PASSWORD=
+# Also set these standard environment variables.
+# HTTP_PROXY="http://user:pass@10.10.1.10:1080"
+# HTTPS_PROXY="http://user:pass@10.10.1.10:1080"
 
 # Location of the osm2pgsql binary.
 # When empty, osm2pgsql is expected to reside in the osm2pgsql directory in
@@ -64,18 +67,13 @@ NOMINATIM_HTTP_PROXY_PASSWORD=
 # EXPERT ONLY. You should usually use the supplied osm2pgsql.
 NOMINATIM_OSM2PGSQL_BINARY=
 
-# Location of pyosmium-get-changes.
-# Only needed when running updates.
-NOMINATIM_PYOSMIUM_BINARY=
-
 # Directory where to find US Tiger data files to import.
-# Used with setup.php --import-tiger-data. When unset, the data is expected
-# to be located under 'data/tiger' in the source tree.
+# OBSOLETE: use `nominatim add-data --tiger-data <dir>` to explicitly state
+#           the directory on import
 NOMINATIM_TIGER_DATA_PATH=
 
 # Directory where to find pre-computed Wikipedia importance files.
-# When unset, the data is expected to be located in the 'data' directory
-# in the source tree.
+# When unset, the data is expected to be located in the project directory.
 NOMINATIM_WIKIPEDIA_DATA_PATH=
 
 # Configuration file for special phrase import.
@@ -92,7 +90,7 @@ NOMINATIM_ADDRESS_LEVEL_CONFIG=
 # This may either be the name of one of an internal style or point
 # to a file with a custom style.
 # Internal styles are: admin, street, address, full, extratags
-NOMNIATIM_IMPORT_STYLE=extratags
+NOMINATIM_IMPORT_STYLE=extratags
 
 # Location of the flatnode file used by osm2pgsql to store node locations.
 # When unset, osm2pgsql stores the location in the PostgreSQL database. This
@@ -145,7 +143,7 @@ NOMINATIM_TABLESPACE_AUX_INDEX=
 # These are used to keep the database up to date. Per default it points to
 # the minutely updates for the main OSM database. There are other services
 # geared towards larger update intervals or data extracts.
-# Changing this value requires to rerun 'update/php --init-updates'.
+# Changing this value requires to rerun 'nominatim replication --init'.
 NOMINATIM_REPLICATION_URL="https://planet.openstreetmap.org/replication/minute"
 
 # Maximum amount of data to download per batch.
@@ -166,7 +164,7 @@ NOMINATIM_REPLICATION_RECHECK_INTERVAL=60
 ### API settings
 #
 # The following settings configure the API responses. You must rerun
-# setup.php --setup-website after changing any of them.
+# 'nominatim refresh --website' after changing any of them.
 
 # Send permissive CORS access headers.
 # When enabled, send CORS headers to allow access to everybody.
@@ -201,7 +199,7 @@ NOMINATIM_POLYGON_OUTPUT_MAX_TYPES=1
 ### Log settings
 #
 # The following options allow to enable logging of API requests.
-# You must rerun setup.php --setup-website after changing any of them.
+# You must rerun 'nominatim refresh --website' after changing any of them.
 #
 # Enable logging of requests into the DB.
 # The request will be logged into the new_query_log table.