docs/library/Configuration.md

   1 # Configuration
   2
   3 When using Nominatim through the library, it can be configured in exactly
   4 the same way as when running as a service. You may instantiate the library
   5 against the [project directory](../admin/Import.md#creating-the-project-directory)
   6 of your Nominatim installation. It contains all files belonging to the
   7 Nominatim instance. This may include an `.env` file with configuration options.
   8 Setting configuration parameters via environment variables works as well.
   9 Alternatively to using the operating system's environment, a set of
  10 configuration parameters may also be passed to the Nomiantim API object.
  11
  12 Configuration options are resolved in the following order:
  13
  14 * from the OS environment (or the dictionary given in `environ`,
  15   (see NominatimAPI.md#nominatim.api.core.NominatimAPI.__init__)
  16 * from the .env file in the project directory of the installation
  17 * from the default installation in the configuration directory
  18
  19 For more information on configuration via dotenv and a list of possible
  20 configuration parameters, see the [Configuration page](../customize/Settings.md).
  21
  22
  23 ## `Configuration` class
  24
  25 ::: nominatim_api.Configuration
  26     options:
  27         members:
  28             - get_bool
  29             - get_int
  30             - get_str_list
  31             - get_path
  32         heading_level: 6
  33         show_signature_annotations: True