Reformat md

This commit is contained in:
Alexey Sokolov 2017-02-28 23:31:06 +00:00
parent 495346ce45
commit 67f571b160
2 changed files with 6 additions and 16 deletions

View File

@ -1,18 +1,12 @@
# What is ZNC? # What is ZNC?
ZNC is an IRC network bouncer (BNC). It can detach the client from the 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.
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/) [ZNC Wiki](http://znc.in/)
# How to use this image # How to use this image
ZNC in this image stores its configuration in `/znc-data`. 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`.
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 ```console
$ docker run -it -v znc-cfg:/znc-data znc --makeconf $ 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 $ 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 The port should match the port you used during `--makeconf`. Note that 6667 is often blocked by web browsers, and therefore is not recommended.
often blocked by web browsers, and therefore is not recommended.
If you use any external module, put the .cpp, .py or .pm 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).
`/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. 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.
Together they cause very slow connection. So for now IPv6 is disabled here.

View File

@ -1,4 +1,3 @@
## `%%REPO%%:slim` ## `%%REPO%%:slim`
This image is smaller, but it doesn't support external modules. 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`.
If you need any external C++, Perl or Python module, use `latest` instead of `slim`.