Bump versin to 1.6.1-2

Incorporates (more or less) some of the changes from #8.

Dockerfile

@@ -1,18 +1,33 @@
-# version 1.4-1
+# version 1.6.1-2
-# docker-version 0.11.1
+# docker-version 1.11.1
-FROM        ubuntu:12.04
+FROM ubuntu:15.04
-MAINTAINER  Jim Myhrberg "contact@jimeh.me"
+MAINTAINER Jim Myhrberg "contact@jimeh.me"
 
-# We use a bootstrap script to avoid having temporary cache files and build
+ENV ZNC_VERSION 1.6.1
-# dependencies being committed and included into the docker image.
-ADD         bootstrap.sh /tmp/
-RUN         chmod +x /tmp/bootstrap.sh && /tmp/bootstrap.sh
 
-RUN         useradd znc
+RUN apt-get update \
-ADD         start-znc /usr/local/bin/
+    && apt-get install -y sudo wget build-essential libssl-dev libperl-dev \
-ADD         znc.conf.default /src/
+               pkg-config swig3.0 libicu-dev ca-certificates \
-RUN         chmod 644 /src/znc.conf.default
+    && mkdir -p /src \
+    && cd /src \
+    && wget "http://znc.in/releases/archive/znc-${ZNC_VERSION}.tar.gz" \
+    && tar -zxf "znc-${ZNC_VERSION}.tar.gz" \
+    && cd "znc-${ZNC_VERSION}" \
+    && ./configure --disable-ipv6 \
+    && make \
+    && make install \
+    && apt-get remove -y wget \
+    && apt-get autoremove -y \
+    && apt-get clean \
+    && rm -rf /src* /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-EXPOSE      6667
+RUN useradd znc
-ENTRYPOINT  ["/usr/local/bin/start-znc"]
+ADD docker-entrypoint.sh /entrypoint.sh
-CMD         [""]
+ADD znc.conf.default /znc.conf.default
+RUN chmod 644 /znc.conf.default
+
+VOLUME /znc-data
+
+EXPOSE 6667
+ENTRYPOINT ["/entrypoint.sh"]
+CMD [""]

README.md

@@ -1,19 +1,21 @@
 # ZNC for Docker
 
-Run the [ZNC](http://znc.in) IRC Bouncer in a Docker container.
+Run the [ZNC][] IRC Bouncer in a Docker container.
 
+[ZNC]: http://znc.in
 
 ## Prerequisites
 
-1. Install [Docker](http://docker.io/).
+1. Install [Docker][].
-2. Make .znc folder: `mkdir $HOME/.znc`
 
+[Docker]: http://docker.com/
 
 ## Running
 
-To retain your ZNC settings between runs, you will need to bind a directory
+ZNC needs to store settings somewhere, so simplest way to run it is to mount a
-from the host to `/znc-data` in the container. For example:
+directory from the host machine to `/znc-data` in the container:
 
+    mkdir -p $HOME/.znc
     docker run -d -p 6667 -v $HOME/.znc:/znc-data jimeh/znc
 
 This will download the image if needed, and create a default config file in
@@ -29,18 +31,20 @@ Or if you want to specify which port to map the default 6667 port to:
 
 Resulting in port 36667 on the host mapping to 6667 within the container.
 
-
+## Configuring ZNC
-## Configuring
 
 If you've let the container create a default config for you, the default
-username/password combination is admin/admin. You can access the web-interface
+username/password combination is `admin`/`admin`. You can access the
-to create your own user by pointing your web-browser at the opened port.
+web-interface to create your own user by pointing your web-browser at the opened
+port.
+
+For example, if you passed in `-p 36667:6667` like above when running the
+container, the web-interface would be available on: `http://hostname:36667/`
 
 I'd recommend you create your own user by cloning the admin user, then ensure
 your new cloned user is set to be an admin user. Once you login with your new
 user go ahead and delete the default admin user.
 
-
 ## External Modules
 
 If you need to use external modules, simply place the original `*.cpp` source
@@ -52,19 +56,40 @@ This ensures that you can easily add new external modules to your znc
 configuration without having to worry about building them. And it only slows
 down ZNC's startup with a few seconds.
 
+## DATADIR
 
-## Notes on DATADIR
+ZNC stores all it's settings in a Docker volume mounted to `/znc-data` inside
+the container.
 
-ZNC needs a data/config directory to run. Within the container it uses
+### Mount a Host Directory
-`/znc-data`, so to retain this data when shutting down a container, you should
-mount a directory from the host. Hence `-v $HOME/.znc:/znc-data` is part of
-the instructions above.
 
-As ZNC needs to run as it's own user within the container, the directory will
+The simplest approach is typically to mount a directory off of your host machine
-have it's ownership changed to UID 1000 (user) and GID 1000 (group). Meaning
+into the container. This is done with `-v $HOME/.znc:/znc-data` like in the
-after the first run, you might need root access to manually modify the data
+example above.
-directory.
 
+One issue with this though is that ZNC needs to run as it's own user within the
+container, the directory will have it's ownership changed to UID 1000 (user) and
+GID 1000 (group). Meaning after the first run, you might need root access to
+manually modify the data directory.
+
+### Use a Volume Container
+
+First we need to create a volume container:
+
+    docker run -v /znc-data --name znc-data busybox echo "data for znc"
+
+And then run the znc container using the `--volumes-from` option instead of
+`-v`:
+
+    docker run -d -p 6667 --name znc --volumes-from znc-data jimeh/znc
+
+You'll want to periodically back up your znc data to the host:
+
+    docker run --volumes-from znc-data -v $(pwd):/backup ubuntu tar cvf /backup/backup.tar /znc-data
+
+And restore them later:
+
+    docker run --volumes-from znc-data -v $(pwd):/backup busybox tar xvf /backup/backup.tar
 
 ## Passing Custom Arguments to ZNC
 
@@ -81,6 +106,21 @@ Make note of the use of `-i` and `-t` instead of `-d`. This attaches us to the
 container, so we can interact with ZNC's makepass process. With `-d` it would
 simply run in the background.
 
+## A note about ZNC 1.6
+
+Starting with version 1.6, ZNC now requires ssl/tls certificate verification!
+This means that it will *not* connect to your IRC server(s) if they don't
+present a valid certificate. This is meant to help keep you safer from MitM
+attacks.
+
+This image installs the debian/ubuntu `ca-certificates`
+[package](http://packages.ubuntu.com/vivid/ca-certificates) so that servers with
+valid certificates will automatically be connected to ensuring no additional
+user intervention needed. If one of your servers doesn't have a valid
+fingerprint, you will need to connect to your bouncer and respond to `*status`.
+
+See [this](https://mikaela.info/english/2015/02/24/znc160-ssl.html) article for
+more information.
 
 ## Building It Yourself
 

bootstrap.sh

@@ -1,34 +0,0 @@
-#! /usr/bin/env bash
-set -e
-
-
-# Config
-ZNC_VERSION="1.4"
-
-
-# Ensure package list is up to date.
-apt-get update
-
-# Install runtime dependencies.
-apt-get install -y sudo
-
-# Install build dependencies.
-apt-get install -y wget build-essential libssl-dev libperl-dev pkg-config
-
-
-# Prepare building
-mkdir -p /src
-
-
-# Download, compile and install ZNC.
-cd /src
-wget "http://znc.in/releases/archive/znc-${ZNC_VERSION}.tar.gz"
-tar -zxf "znc-${ZNC_VERSION}.tar.gz"
-cd "znc-${ZNC_VERSION}"
-./configure && make && make install
-
-
-# Clean up
-apt-get remove -y wget
-apt-get autoremove -y
-apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

docker-entrypoint.sh

@@ -13,6 +13,7 @@ if [ -d "${DATADIR}/modules" ]; then
 
   # Build modules.
   for module in $modules; do
+    echo "Building module $module..."
     cd "$(dirname "$module")"
     znc-buildmod "$module"
   done
@@ -23,13 +24,16 @@ fi
 
 # Create default config if it doesn't exist
 if [ ! -f "${DATADIR}/configs/znc.conf" ]; then
+  echo "Creating a default configuration..."
   mkdir -p "${DATADIR}/configs"
-  cp /src/znc.conf.default "${DATADIR}/configs/znc.conf"
+  cp /znc.conf.default "${DATADIR}/configs/znc.conf"
 fi
 
 # Make sure $DATADIR is owned by znc user. This effects ownership of the
 # mounted directory on the host machine too.
+echo "Setting necessary permissions..."
 chown -R znc:znc "$DATADIR"
 
 # Start ZNC.
+echo "Starting ZNC..."
 exec sudo -u znc znc --foreground --datadir="$DATADIR" $@

znc.conf.default

@@ -8,27 +8,27 @@
 // But if you feel risky, you might want to read help on /znc saveconfig and /znc rehash.
 // Also check http://en.znc.in/wiki/Configuration
 
-Version = 1.4
+Version = 1.6.1
 <Listener l>
-	Port = 6667
+        Port = 6667
-	IPv4 = true
+        IPv4 = true
-	IPv6 = true
+        IPv6 = true
-	SSL = false
+        SSL = false
 </Listener>
 LoadModule = webadmin
 
 <User admin>
-	Pass       = sha256#1b9a69be60544ae4a83147ebb04c4c1edc24dba4c62f8f25ef5603b06c264476#5zD6V:PYLf*jZcL8VbZY#
+        Pass       = sha256#00793765305dfc3e7bba28267fe9d9e2c721ebef4e20f3a89720265a89ee6a4f#N!lgZM8S.HZ4zH?)vFoW#
-	Admin      = true
+        Admin      = true
-	Nick       = admin
+        Nick       = admin
-	AltNick    = admin_
+        AltNick    = admin_
-	Ident      = admin
+        Ident      = admin
-	RealName   = Got ZNC?
+        RealName   = Got ZNC?
-	Buffer     = 50
+        Buffer     = 50
-	AutoClearChanBuffer = true
+        AutoClearChanBuffer = true
-	ChanModes  = +stn
+        ChanModes  = +stn
 
-	LoadModule = chansaver
+        LoadModule = chansaver
-	LoadModule = controlpanel
+        LoadModule = controlpanel
-	LoadModule = perform
+        LoadModule = perform
 </User>