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

Add docs for ZNC image #821

merged 6 commits into from
Feb 28, 2017

Conversation

DarthGandalf
Copy link
Contributor

@tianon
Copy link
Member

tianon commented Feb 28, 2017

Looks like this could use some markdownfmt to appease Travis -- the easiest way to apply it is via our markdownfmt.sh script in the root of this repo, but I'm also happy to apply the reformatting for you, if you'd like. 👍

znc/content.md Outdated
```

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.

znc/content.md Outdated
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?

@DarthGandalf
Copy link
Contributor Author

Done.

@tianon
Copy link
Member

tianon commented Feb 28, 2017

Tested locally since Travis is having webhook delays due to the GitHub/S3 cascade:

$ curl -fsSL 'https://raw.githubusercontent.com/DarthGandalf/docker-docs/67f571b160c7080f02ec5489a16841dabc37e2f4/znc/content.md' | ./markdownfmt.sh -d
$ curl -fsSL 'https://raw.githubusercontent.com/DarthGandalf/docker-docs/67f571b160c7080f02ec5489a16841dabc37e2f4/znc/license.md' | ./markdownfmt.sh -d
$ curl -fsSL 'https://raw.githubusercontent.com/DarthGandalf/docker-docs/67f571b160c7080f02ec5489a16841dabc37e2f4/znc/variant-slim.md' | ./markdownfmt.sh -d
$ 

@tianon tianon merged commit 88d3061 into docker-library:master Feb 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants