summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <lars.wirzenius@codethink.co.uk>2014-03-31 13:49:47 +0000
committerLars Wirzenius <lars.wirzenius@codethink.co.uk>2014-03-31 13:49:47 +0000
commit6e2d8167093500b7aa8bad9ddd1dc09aaf56d1b6 (patch)
tree31e75176996c3622ed139edec0d7e54b98a1e46d
parent37b8f268e52751d34878b1e2d36e2d3d428123c2 (diff)
downloadlorry-controller-6e2d8167093500b7aa8bad9ddd1dc09aaf56d1b6.tar.gz
Document the auth field in lorry-controller.conf
-rw-r--r--README3
1 files changed, 3 insertions, 0 deletions
diff --git a/README b/README
index b7bc6e0..ea3059f 100644
--- a/README
+++ b/README
@@ -30,6 +30,9 @@ shared between Trove and Lorry specs:
* `protocol`: specifies how Lorry Controller (and Lorry) should talk
to remove Troves. Allowed values are `ssh`, `https`, `http`. This
field is mandatory.
+* `auth`: Specifies how to authenticate to the remote Trove over
+ https. The is an optional field. If present, it should be a
+ dictionary with the fields `username` and `password`.
* Additionally, the following seem to be supported by an old version
of Lorry Controller, but are ignored by the new Lorry Controller:
`uuid`, `serial`, `create`, `destroy`, `stagger`, `tarball`.