Skip to content

Commit 88d3061

Browse files
authored
Merge pull request #821 from DarthGandalf/znc
Add docs for ZNC image
2 parents 5a10c5e + 67f571b commit 88d3061

File tree

5 files changed

+31
-0
lines changed

5 files changed

+31
-0
lines changed

znc/README-short.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ZNC - An advanced IRC bouncer

znc/content.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# What is ZNC?
2+
3+
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.
4+
5+
[ZNC Wiki](http://znc.in/)
6+
7+
# How to use this image
8+
9+
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`.
10+
11+
```console
12+
$ docker run -it -v znc-cfg:/znc-data znc --makeconf
13+
```
14+
15+
To run ZNC:
16+
17+
```console
18+
$ docker run -p 6697:6697 -v znc-cfg:/znc-data znc
19+
```
20+
21+
The port should match the port you used during `--makeconf`. Note that 6667 is often blocked by web browsers, and therefore is not recommended.
22+
23+
If you use any external module, put the .cpp, .py or .pm file to `/znc-data/modules` (you may need to create that directory).
24+
25+
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.

znc/github-repo

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/znc/znc-docker

znc/license.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

znc/variant-slim.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## `%%REPO%%:slim`
2+
3+
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`.

0 commit comments

Comments
 (0)