Skip to content

Commit

Permalink
doc: describe how to set credentials environment variables according …
Browse files Browse the repository at this point in the history
…to the provider's plugin
  • Loading branch information
anesson-cs committed Feb 13, 2023
1 parent 6176b8e commit 2be2e47
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/getting_started_guide/configure.rst
Expand Up @@ -114,6 +114,16 @@ The same configuration could be achieved by setting environment variables:
Each configuration parameter can be set with an environment variable.

.. note::

Setting credentials must be done according to the `provider's plugin <https://eodag.readthedocs.io/en/stable/plugins.html#plugins-available>`_ (auth | api):

* Authentication plugin: ``EODAG__<PROVIDER>__AUTH__CREDENTIALS__<KEY>``

* API plugin: ``EODAG__<PROVIDER>__API__CREDENTIALS__<KEY>``

``<KEY>`` should be replaced with the adapted credentials key (``USERNAME``, ``PASSWORD``, ``APIKEY``, ...) according to the provider configuration template in `the YAML configuration file <https://eodag.readthedocs.io/en/stable/getting_started_guide/configure.html#yaml-configuration-file>`_.

CLI configuration
^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 2be2e47

Please sign in to comment.