-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3629c9c
Add docs for ZNC image
DarthGandalf a2a1f3a
Mention external modules placement
DarthGandalf 25872ee
Fix a typo
DarthGandalf bf09a21
No IPv6 :-(
DarthGandalf 495346c
small -> slim
DarthGandalf 67f571b
Reformat md
DarthGandalf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
ZNC - An advanced IRC bouncer |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
https://github.com/znc/znc-docker |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
http://superuser.com/questions/188006/how-to-fix-err-unsafe-port-error-on-chrome-when-browsing-to-unsafe-ports
https://jazzy.id.au/2012/08/23/why_does_chrome_consider_some_ports_unsafe.html
There was a problem hiding this comment.
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! 👍
There was a problem hiding this comment.
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.