diff --git a/README.md b/README.md index 6577edf..746d918 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,18 @@ Run the [ZNC](http://znc.in) IRC Bouncer in a Docker container. +## Prerequisites + +1. Install [Docker](http://docker.io/). +2. Make .znc folder: `mkdir /home/$(whoami)/.znc` + + ## Running To retain your ZNC settings between runs, you will need to bind a directory from the host to `/znc-data` in the container. For example: - docker run -d -v /home/$(whoami)/.znc:/znc-data jimeh/znc + docker run -d -p 6667 -v /home/$(whoami)/.znc:/znc-data jimeh/znc This will download the image if needed, and create a default config file in your data directory unless you already have a config in place. The default @@ -19,7 +25,7 @@ exposed: Or if you want to specify which port to map the default 6667 port to: - docker run -d -p 36667:6667-v /home/$(whoami)/.znc:/znc-data jimeh/znc + docker run -d -p 36667:6667 -v /home/$(whoami)/.znc:/znc-data jimeh/znc Resulting in port 36667 on the host mapping to 6667 within the container. @@ -49,7 +55,7 @@ down ZNC's startup with a few seconds. ## Building It Yourself -1. Install Docker (http://docker.io/). -2. Checkout source: `git clone https://github.com/jimeh/docker-znc.git && cd docker-znc` +0. Follow Prerequisites above. +1. Checkout source: `git clone https://github.com/jimeh/docker-znc.git && cd docker-znc` 3. Build container: `sudo docker build -t $(whoami)/znc .` -4. Run container: `sudo docker run -d -v /home/$(whoami)/.znc:/znc-data $(whoami)/znc` +4. Run container: `sudo docker run -d -p 6667 -v /home/$(whoami)/.znc:/znc-data $(whoami)/znc`