X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/309ac46b989b19b7a613e5031c5b2dde231b7cd6..043d52821cba22ca8b430be7c178275325bb2f93:/docs/library/Configuration.md?ds=inline

diff --git a/docs/library/Configuration.md b/docs/library/Configuration.md
index 19b8feb8..e13470e9 100644
--- a/docs/library/Configuration.md
+++ b/docs/library/Configuration.md
@@ -1,6 +1,26 @@
-# Configuration class
+# Configuration
 
-::: nominatim.config.Configuration
+When using Nominatim through the library, it can be configured in exactly
+the same way as when running as a service. This means that you should have
+created a [project directory](../admin/Import.md#creating-the-project-directory)
+which contains all files belonging to the Nominatim instance. It can also contain
+an `.env` file with configuration options. Setting configuration parameters
+via environment variables works as well.
+
+Configuration options are resolved in the following order:
+
+* from the OS environment (or the dictionary given in `environ`,
+  (see NominatimAPI.md#nominatim.api.core.NominatimAPI.__init__)
+* from the .env file in the project directory of the installation
+* from the default installation in the configuration directory
+
+For more information on configuration via dotenv and a list of possible
+configuration parameters, see the [Configuration page](../customize/Settings.md).
+
+
+## `Configuration` class
+
+::: nominatim_api.Configuration
     options:
         members:
             - get_bool