From ef7eabbcc0abceabb99720375dac2d4e0075c2ef Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Wed, 7 May 2014 16:04:34 +0000 Subject: Document proxy.conf in README --- README | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README b/README index ea3059f..08aada0 100644 --- a/README +++ b/README @@ -94,3 +94,24 @@ local `.lorry` files. The syntax of `.lorry` files is specified by the Lorry program; see its documentation for details. + + +HTTP proxy configuration +------------------------ + +Lorry Controller will look for a file called `proxy.conf` in the same +directory as the `lorry-controller.conf` configuration file. +It is in JSON format, with the following key/value pairs: + +* `hostname` -- the hostname of the HTTP proxy +* `username` -- username for authenticating to the proxy +* `password` -- a **cleartext** password for authenticating to the + proxy +* `port` -- port number for connecting to the proxy + +Lorry Controller will use this information for both HTTP and HTTPS +proxying. + +Do note that the **password is stored in cleartext** and that access +to the configuration file (and the git repository where it is stored) +must be controller appropriately. -- cgit v1.2.1