diff --git a/znc/README-short.txt b/znc/README-short.txt new file mode 100644 index 000000000000..e0182075a95f --- /dev/null +++ b/znc/README-short.txt @@ -0,0 +1 @@ +ZNC - An advanced IRC bouncer diff --git a/znc/content.md b/znc/content.md new file mode 100644 index 000000000000..89b79995d462 --- /dev/null +++ b/znc/content.md @@ -0,0 +1,25 @@ +# What is ZNC? + +ZNC is an IRC network bouncer (BNC). It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC. + +[ZNC Wiki](http://znc.in/) + +# How to use this image + +ZNC in this image stores its configuration in `/znc-data`. If you have existing configuration, you can reuse it with `-v $HOME/.znc:/znc-data`. Alternatively, you can create a new config in a volume or in a local dir. The examples below assumes a volume named `znc-cfg`. + +```console +$ docker run -it -v znc-cfg:/znc-data znc --makeconf +``` + +To run ZNC: + +```console +$ docker run -p 6697:6697 -v znc-cfg:/znc-data znc +``` + +The port should match the port you used during `--makeconf`. Note that 6667 is often blocked by web browsers, and therefore is not recommended. + +If you use any external module, put the .cpp, .py or .pm file to `/znc-data/modules` (you may need to create that directory). + +Musl silently doesn't support `AI_ADDRCONFIG` yet, and ZNC doesn't support [Happy Eyeballs](https://en.wikipedia.org/wiki/Happy_Eyeballs) yet. Together they cause very slow connection. So for now IPv6 is disabled here. diff --git a/znc/github-repo b/znc/github-repo new file mode 100644 index 000000000000..bf7d5f30cf70 --- /dev/null +++ b/znc/github-repo @@ -0,0 +1 @@ +https://github.com/znc/znc-docker diff --git a/znc/license.md b/znc/license.md new file mode 100644 index 000000000000..92b9b2fa1a08 --- /dev/null +++ b/znc/license.md @@ -0,0 +1 @@ +View [license](https://github.com/znc/znc/blob/master/LICENSE) [information](https://github.com/znc/znc/blob/master/NOTICE) for the software contained in this image. diff --git a/znc/variant-slim.md b/znc/variant-slim.md new file mode 100644 index 000000000000..3b100bc395f1 --- /dev/null +++ b/znc/variant-slim.md @@ -0,0 +1,3 @@ +## `%%REPO%%:slim` + +This image is smaller, but it doesn't support external modules. If you need any external C++, Perl or Python module, use `latest` instead of `slim`.