Add: instructions for running ick in README

1 files changed, 36 insertions, 0 deletions

diff --git a/README b/README
index 163a2b0..68511f9 100644
--- a/README
+++ b/README
@@ -19,6 +19,42 @@ HTTP API. To run them, run `./check`. You may add any command line
 parameters than `yarn` accepts.
 
 
+Running
+-----------------------------------------------------------------------------
+
+To run the controller, you should use uWSGI with Python support. On
+Debian, install `uwgi-plugin-python` and run:
+
+    uwsgi --plugin python27 --http-socket 127.0.0.1:12765 \
+    --wsgi-file ctrlruwsgi \
+    --processes 1 --threads 1 --pyargv "--projects=projects.yaml"
+
+You need to create `projects.yaml` yourself. It might look like this:
+
+    projects:
+      foo:
+        shell_steps:
+          - for x in $(seq 100); do echo hello, world, $x; sleep 1; done
+
+After this, `http://localhost:12765` is the controller's base URL, and
+you can do things like:
+
+* `GET http://localhost:12765/projects` — list all projects known to
+  controller
+* `GET http://localhost:12765/projects/foo/+trigger` — trigger build
+  of project `foo` (substitute name of one of your own projects)
+* `GET http://localhost:12765/projects/foo/logs/current` — get build
+  log (output) of the currently executing build step of project `foo`
+* `GET http://localhost:12765/projects/foo/logs/previous` — get build
+  log (output) of the latest finished build step of project `foo`
+
+To actually run builds, you need to run `worker-manager`:
+
+    ./worker-manager --controller http://localhost:12765
+
+The substitute the correct URL for the controller.
+
+
 Legalese
 -----------------------------------------------------------------------------