ngircd: Add an ngIRCd image
[dockerfile.git] / README.md
1 [Dockerfiles][] for assorted [Gentoo][]-based [Docker][] images.
2
3 Dockerfiles are sorted into directories with names matching the
4 suggested repository.  To avoid duplicating ephemeral data (namespace,
5 timestamp tag, …), they appear in the `Dockerfile.template` as markers
6 (`${NAMESPACE}`, `${TAG}`, …).  The `build.sh` script replaces the
7 markers with values while generating a `Dockerfile` from each
8 `Dockerfile.template` (using [envsubst][]), and then builds each tag
9 with:
10
11     $ docker build -t $NAMESPACE/$REPO:$TAG $REPO
12
13 for example:
14
15     $ docker build -t wking/gentoo-en-us:20131205 gentoo-en-us
16
17 The dependency graph is:
18
19     wking/gentoo  (amd64 stage3)
20     `-- gentoo-portage  (adds portage directory)
21         `-- gentoo-en-us  (adds locale)
22             `-- gentoo-syslog  (adds syslog-ng and associates)
23                 |-- buildbot  (adds a Buildbot master and slave)
24                 |-- docker-registry  (adds a Docker registry server)
25                 |-- gentoo-layman  (adds layman for Gentoo overlays)
26                 |   `-- package-cache  (adds a package-cache proxy)
27                 |-- memcached  (adds Memcached)
28                 |-- nginx  (adds Nginx)
29                 |   |-- nginx-proxy  (SSL/TLS proxying via SNI)
30                 |   |-- kibana  (adds Kibana)
31                 |   `-- kibana-azure  (adds Azure's Kibana)
32                 |-- ngircd  (adds ngIRCd)
33                 |-- postgresql  (adds PostgreSQL)
34                 |-- redis  (adds Redis)
35                 |-- salt-minion  (adds a Salt Stack minion)
36                 |-- stunnel  (adds stunnel)
37                 `-- gentoo-java  (adds IcedTea)
38                     `-- elasticsearch  (adds Elasticsearch)
39
40 Run:
41
42     $ ./build.sh
43
44 to seed from the Gentoo mirrors and build all images.  There are a
45 number of variables in the `build.sh` script that configure the build
46 (`AUTHOR`, `NAMESPACE`, …).  We use [POSIX parameter
47 expansion][parameter-expansion] to make it easy to override variables
48 as you see fit.
49
50     $ NAMESPACE=jdoe DATE=20131210 ./build.sh
51
52 I'd like to avoid bloating the images with the Portage tree, but
53 without ugly hacks [that is not currently possible][3156].
54
55 [Docker]: http://www.docker.io/
56 [Dockerfiles]: http://www.docker.io/learn/dockerfile/
57 [Gentoo]: http://www.gentoo.org/
58 [envsubst]: http://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html
59 [parameter-expansion]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_02
60 [3156]: https://github.com/dotcloud/docker/issues/3156