irker/Dockerfile.template: Change branch from 'ssl-tls' to 'next'
[dockerfile.git] / README.md
index 77f65169f020b708783c858b5480a4b97aaadbd1..fb83730560bf08ac3bd5fd484bc835628c75cd8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,9 +3,10 @@
 Dockerfiles are sorted into directories with names matching the
 suggested repository.  To avoid duplicating ephemeral data (namespace,
 timestamp tag, …), they appear in the `Dockerfile.template` as markers
-(`NAMESPACE`, `TAG`, …).  The `build.sh` script replaces the markers
-with values while generating a `Dockerfile` from each
-`Dockerfile.template`, and then builds each tag with:
+(`${NAMESPACE}`, `${TAG}`, …).  The `build.sh` script replaces the
+markers with values while generating a `Dockerfile` from each
+`Dockerfile.template` (using [envsubst][]), and then builds each tag
+with:
 
     $ docker build -t $NAMESPACE/$REPO:$TAG $REPO
 
@@ -17,16 +18,28 @@ The dependency graph is:
 
     wking/gentoo  (amd64 stage3)
     `-- gentoo-portage  (adds portage directory)
-        `-- gentoo-en-us  (adds locale)
-            `-- gentoo-syslog  (adds syslog-ng and associates)
-                |-- buildbot  (adds a Buildbot master and slave)
-                |-- nginx  (adds Nginx)
-                |   `-- kibana  (adds Kibana)
-                |-- postgresql  (adds PostgreSQL)
-                |-- redis  (adds Redis)
-                |-- stunnel  (adds stunnel)
-                `-- gentoo-java  (adds IcedTea)
-                    `-- elasticsearch  (adds Elasticsearch)
+        `-- gentoo-utc  (adds a system timezone)
+            `-- gentoo-en-us  (adds locale)
+                `-- gentoo-syslog  (adds syslog-ng and associates)
+                    |-- buildbot  (adds a Buildbot master and slave)
+                    |-- docker-registry  (adds a Docker registry server)
+                    |-- gentoo-layman  (adds layman for Gentoo overlays)
+                    |   `-- package-cache  (adds a package-cache proxy)
+                    |-- gentoo-node  (adds Node and npm)
+                    |   `-- hubot  (adds hubot with an IRC adapter)
+                    |-- irker  (adds irker, and spawns irkerd by default)
+                    |-- memcached  (adds Memcached)
+                    |-- nginx  (adds Nginx)
+                    |   |-- nginx-proxy  (SSL/TLS proxying via SNI)
+                    |   |-- kibana  (adds Kibana)
+                    |   `-- kibana-azure  (adds Azure's Kibana)
+                    |-- ngircd  (adds ngIRCd)
+                    |-- postgresql  (adds PostgreSQL)
+                    |-- redis  (adds Redis)
+                    |-- salt-minion  (adds a Salt Stack minion)
+                    |-- stunnel  (adds stunnel)
+                    `-- gentoo-java  (adds IcedTea)
+                        `-- elasticsearch  (adds Elasticsearch)
 
 Run:
 
@@ -41,11 +54,11 @@ as you see fit.
     $ NAMESPACE=jdoe DATE=20131210 ./build.sh
 
 I'd like to avoid bloating the images with the Portage tree, but
-without ugly hacks [that is not currently possible][3156] is mounted
-from the host.
+without ugly hacks [that is not currently possible][3156].
 
 [Docker]: http://www.docker.io/
 [Dockerfiles]: http://www.docker.io/learn/dockerfile/
 [Gentoo]: http://www.gentoo.org/
+[envsubst]: http://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html
 [parameter-expansion]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_02
 [3156]: https://github.com/dotcloud/docker/issues/3156