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. This means that you should have
   5 created a [project directory](../admin/Import.md#creating-the-project-directory)
   6 which contains all files belonging to the Nominatim instance. It can also contain
   7 an `.env` file with configuration options. Setting configuration parameters
   8 via environment variables works as well.
   9
  10 Configuration options are resolved in the following order:
  11
  12 * from the OS environment (or the dictionary given in `environ`,
  13   (see NominatimAPI.md#nominatim.api.core.NominatimAPI.__init__)
  14 * from the .env file in the project directory of the installation
  15 * from the default installation in the configuration directory
  16
  17 For more information on configuration via dotenv and a list of possible
  18 configuration parameters, see the [Configuration page](../customize/Settings.md).
  19
  20
  21 ## `Configuration` class
  22
  23 ::: nominatim.config.Configuration
  24     options:
  25         members:
  26             - get_bool
  27             - get_int
  28             - get_str_list
  29             - get_path
  30         heading_level: 6
  31         show_signature_annotations: True