summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBen Hutchings <ben.hutchings@codethink.co.uk>2020-05-06 20:03:30 +0100
committerBen Hutchings <ben.hutchings@codethink.co.uk>2020-06-01 15:26:47 +0100
commit55d65f101337a2d92c1954dbfcb8c55d7142de54 (patch)
tree3daefd2158b05e93f4c170e8db6ec6897c84ac2c /README
parent68d39e2804e04430ed9224da9e5f3a4334ce37ed (diff)
downloadlorry-controller-55d65f101337a2d92c1954dbfcb8c55d7142de54.tar.gz
README: Rewrite text that implies LC must be part of Trove
* Remove early reference to Trove and Baserock integration in the Overview section. * Rearrange description of the WEBAPP admin interface to describe the full admin interface before the Trove status page. Related to #3.
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 10 insertions, 11 deletions
diff --git a/README b/README
index 8455e35..f14e822 100644
--- a/README
+++ b/README
@@ -5,9 +5,7 @@ Overview
--------
Lorry Controller, or LC for short, manages the importing of source
-code from external sources into git repositories on a Trove. A Trove
-is a component in the Baserock system for hosting source code, and LC
-runs inside a Trove.
+code from external sources into git repositories on a Trove.
LC uses the Lorry tool to do the actual import. Lorry can read code
from several different version control systems, and convert them to
@@ -191,15 +189,16 @@ must be controlled appropriately.
WEBAPP 'Admin' Interface
------------------------
-A web interface for managing lorry controller is accessible from
-http://trove/1.0/status-html. A more detailed 'admin' interface runs locally
-on port 12765.
+An 'admin' interface runs locally on port 12765.
-For the moment you can access this interface using an ssh tunnel if you have
-root access to the trove, for example:
+For the moment you can access this interface using an ssh tunnel, for
+example:
-ssh -L 12765:localhost:12765 root@trove
+ssh -L 12765:localhost:12765 root@lorryhost
-will bind 12765 on your localhost to 12765 on the trove, with this running
-you can access the trove 'admin' interface at
+will bind 12765 on your localhost to 12765 on lorryhost, with this running
+you can access the 'admin' interface at
http://localhost:12765/1.0/status-html
+
+When used within Trove, a web interface for managing lorry controller
+is accessible from http://trove/1.0/status-html.