[docs] add note about login automation

1 files changed, 21 insertions, 0 deletions

diff --git a/docs/dev/automating_login.rst b/docs/dev/automating_login.rst
new file mode 100644
index 00000000..7017dd8e
--- /dev/null
+++ b/docs/dev/automating_login.rst
@@ -0,0 +1,21 @@
+.. _automating_login:
+
+Automating login
+================
+
+There's an annoying bug with python keyring module, that makes the 'remember
+login' checkbox non functional.
+
+That, and the need to script end-to-end tests with the client inside a docker
+environment, made us put a mechanism to pass credentials via environment
+variables.
+
+To automate login, set BITMASK_CREDENTIALS env var::
+
+  BITMASK_CREDENTIALS=/tmp/secrets.conf bitmask --debug
+
+where the pointed file looks like this::
+
+  [Credentials]
+  username = user@provider
+  password = mypass