diff options
author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2014-05-07 16:04:34 +0000 |
---|---|---|
committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2014-05-07 16:04:34 +0000 |
commit | ef7eabbcc0abceabb99720375dac2d4e0075c2ef (patch) | |
tree | a7073de2651f2e892a9b522305f5dfa1e77f127e | |
parent | 5e2584a7936af5413588232be1f0df7b4cef18c1 (diff) | |
download | lorry-controller-ef7eabbcc0abceabb99720375dac2d4e0075c2ef.tar.gz |
Document proxy.conf in README
-rw-r--r-- | README | 21 |
1 files changed, 21 insertions, 0 deletions
@@ -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. |