ソースを参照

Add docs for ZNC image

Alexey Sokolov 8 年 前
コミット
3629c9c273
5 ファイル変更35 行追加0 行削除
  1. 1 0
      znc/README-short.txt
  2. 28 0
      znc/content.md
  3. 1 0
      znc/github-repo
  4. 1 0
      znc/license.md
  5. 4 0
      znc/variant-small.md

+ 1 - 0
znc/README-short.txt

@@ -0,0 +1 @@
+ZNC - An advanced IRC bouncer

+ 28 - 0
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.

+ 1 - 0
znc/github-repo

@@ -0,0 +1 @@
+https://github.com/znc/znc-docker

+ 1 - 0
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.

+ 4 - 0
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`.