autoland: add a README.md for project developers (bug 1335535) r?imadueme,glob draft
authorMāris Fogels <mars@mozilla.com>
Tue, 31 Jan 2017 16:58:18 -0500
changeset 75 eb4f7ff16c5aa6d94735685e40c72aff141d0620
parent 74 f5ef3553144ca597b88bb275924618032a1449b9
push id47
push usermfogels@mozilla.com
push dateWed, 01 Feb 2017 21:20:20 +0000
reviewersimadueme, glob
bugs1335535
autoland: add a README.md for project developers (bug 1335535) r?imadueme,glob MozReview-Commit-ID: 6SlFVWlPxyU
autoland/README.md
new file mode 100644
--- /dev/null
+++ b/autoland/README.md
@@ -0,0 +1,45 @@
+# Mozilla Autoland
+
+A web service and user interface for automatically landing changes to Mozilla Mercurial repositories.
+
+
+## Building Autoland
+
+##### Prerequisites
+
+ * `docker` (on OS X you will want `docker-machine`, too)
+ * `docker-compose`
+
+
+##### Running the development server
+
+To build and start the development services' containers: 
+
+```
+$ docker-compose up 
+```
+
+On Linux, to test that Autoland web interface is being served:
+
+```
+$ curl localhost:8888
+<html>
+<head>
+  <title>Loading...</title>
+...
+```
+
+On OS X with `docker-machine` you will want to run:
+
+```
+$ curl $(docker-machine ip default):8888
+...
+```
+
+
+To make a request directly to the Autoland web service API, you will want to
+use the URL `http://[MY_DOCKER_HOST_IP]:8888/api/`.  For example:
+
+```
+$ curl localhost:8888/api/v1/repos/conduit/series/bz://1234/a
+```