Mention dash environment configuration difficulties in docs (#240)

* Mention dash environment configuration difficulties in docs --------- Co-authored-by: Jarosław Jedynak <[email protected]>
CERT-Polska · Jan 15, 2024 · 8597ebe · 8597ebe
1 parent 5da29b4
commit 8597ebe
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/service_configuration.rst b/docs/service_configuration.rst
@@ -171,6 +171,12 @@ Karton classes expose dedicated methods for this purpose.
 argparse are then passed to ``config_from_args`` that maps arguments into sections and options of configuration.
 That mechanism allows you to define your own arguments and include these values in the final configuration.
 
+.. warning::
+
+    Watch out for sections with a ``-`` character when configuring karton services using environment variables.
+    Some shells (like /bin/sh) won't work correctly and configuration will not be populated with your settings.
+    See `karton/issues/235 <https://github.com/CERT-Polska/karton/issues/235>`_ for more info.
+
 Customizing ready-made Karton services
 --------------------------------------