Skip to content

Add docs for ZNC image #821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 28, 2017
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions znc/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ZNC - An advanced IRC bouncer
33 changes: 33 additions & 0 deletions znc/content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean here by "blocked by web browsers" -- maybe ISPs or firewalls?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, that's adorable -- I had no idea. Apologies! 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we had users complaining all the time that they can't connect, until ZNC itself started warning users during --makeconf that 6667 is not the best choice if they want to use a browser.


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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it'd be worthwhile to expound a little bit about why here, similar to the notes in the Dockerfile comments?

1 change: 1 addition & 0 deletions znc/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/znc/znc-docker
1 change: 1 addition & 0 deletions znc/license.md
Original file line number Diff line number Diff line change
@@ -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 changes: 4 additions & 0 deletions znc/variant-small.md
Original file line number Diff line number Diff line change
@@ -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`.