From 3629c9c2737ee584b338ce54ec784479aa904696 Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Sat, 4 Feb 2017 17:01:31 +0000 Subject: [PATCH 1/6] Add docs for ZNC image --- znc/README-short.txt | 1 + znc/content.md | 28 ++++++++++++++++++++++++++++ znc/github-repo | 1 + znc/license.md | 1 + znc/variant-small.md | 4 ++++ 5 files changed, 35 insertions(+) create mode 100644 znc/README-short.txt create mode 100644 znc/content.md create mode 100644 znc/github-repo create mode 100644 znc/license.md create mode 100644 znc/variant-small.md 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..b609a4b15ca3 --- /dev/null +++ b/znc/content.md @@ -0,0 +1,28 @@ +# 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. 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-small.md b/znc/variant-small.md new file mode 100644 index 000000000000..0a9eca99df8d --- /dev/null +++ b/znc/variant-small.md @@ -0,0 +1,4 @@ +## `%%REPO%%:small` + +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 `small`. From a2a1f3a6f3c10af06f083a417684da3fa9a3d61b Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Sat, 4 Feb 2017 17:13:12 +0000 Subject: [PATCH 2/6] Mention external modules placement --- znc/content.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/znc/content.md b/znc/content.md index b609a4b15ca3..4fadd9ccc3cb 100644 --- a/znc/content.md +++ b/znc/content.md @@ -26,3 +26,6 @@ $ 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 .pl file to +`/znc-data/modules` (you may need to create that directory). From 25872ee90864e30d1e254ca5a938942712a56a6a Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Sat, 4 Feb 2017 19:29:34 +0000 Subject: [PATCH 3/6] Fix a typo --- znc/content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/znc/content.md b/znc/content.md index 4fadd9ccc3cb..3b24580eb565 100644 --- a/znc/content.md +++ b/znc/content.md @@ -27,5 +27,5 @@ $ 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 .pl file to +If you use any external module, put the .cpp, .py or .pm file to `/znc-data/modules` (you may need to create that directory). From bf09a21d793842b347d0cc7c7762cdddf4aac1d9 Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Sat, 4 Feb 2017 22:03:10 +0000 Subject: [PATCH 4/6] No IPv6 :-( --- znc/content.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/znc/content.md b/znc/content.md index 3b24580eb565..d3523cfb5e06 100644 --- a/znc/content.md +++ b/znc/content.md @@ -29,3 +29,5 @@ 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). + +IPv6 is currently disabled in this image. From 495346ce4511a60e8efd3a625845b2c88601e6df Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Tue, 28 Feb 2017 23:27:13 +0000 Subject: [PATCH 5/6] small -> slim --- znc/content.md | 3 ++- znc/{variant-small.md => variant-slim.md} | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) rename znc/{variant-small.md => variant-slim.md} (75%) diff --git a/znc/content.md b/znc/content.md index d3523cfb5e06..5be6dd36ac3d 100644 --- a/znc/content.md +++ b/znc/content.md @@ -30,4 +30,5 @@ 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). -IPv6 is currently disabled in this image. +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/variant-small.md b/znc/variant-slim.md similarity index 75% rename from znc/variant-small.md rename to znc/variant-slim.md index 0a9eca99df8d..bc9edf2dff34 100644 --- a/znc/variant-small.md +++ b/znc/variant-slim.md @@ -1,4 +1,4 @@ -## `%%REPO%%:small` +## `%%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 `small`. +If you need any external C++, Perl or Python module, use `latest` instead of `slim`. From 67f571b160c7080f02ec5489a16841dabc37e2f4 Mon Sep 17 00:00:00 2001 From: Alexey Sokolov Date: Tue, 28 Feb 2017 23:31:06 +0000 Subject: [PATCH 6/6] Reformat md --- znc/content.md | 19 +++++-------------- znc/variant-slim.md | 3 +-- 2 files changed, 6 insertions(+), 16 deletions(-) diff --git a/znc/content.md b/znc/content.md index 5be6dd36ac3d..89b79995d462 100644 --- a/znc/content.md +++ b/znc/content.md @@ -1,18 +1,12 @@ # 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 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`. +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 @@ -24,11 +18,8 @@ To run ZNC: $ 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. +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). +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. +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/variant-slim.md b/znc/variant-slim.md index bc9edf2dff34..3b100bc395f1 100644 --- a/znc/variant-slim.md +++ b/znc/variant-slim.md @@ -1,4 +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`. +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`.