Update ZNC documentation in content.md for docker compose #2441
Conversation
Added an example Docker Compose for normal operation as well as first run configuration. Added a Troubleshoot Section to include potential permission issues. Additional changes - Corrected headings levels.
There was a problem hiding this comment.
cc @DarthGandalf (znc image maintainer) for review as well 🙇
| ## Install using [`docker-compose`](https://github.com/docker/compose) | ||
|
|
||
| Example `docker-compose.yml` for `znc`: | ||
|
|
||
| ```yaml | ||
| znc: | ||
| image: znc:latest | ||
| container_name: znc | ||
| volumes: | ||
| - /your/local/znc-data:/znc-data | ||
| ports: | ||
| - 12345:12345 | ||
| restart: unless-stopped | ||
| ``` | ||
|
|
||
| Then run with `docker-compose up -d`, and when initialized go to `http://dockerhost:12345` |
There was a problem hiding this comment.
This one should probably follow our standard stack.yml pattern elsewhere in the documentation (and should likely use a local Docker volume instead of a bind-mount).
|
|
||
| ```yaml | ||
| znc: | ||
| image: znc:latest |
There was a problem hiding this comment.
Since this one won't be able to follow that pattern, it can take advantage of our templating (so that it's correct on the per-architecture image pages too):
| image: znc:latest | |
| image: %%IMAGE%% |
|
|
||
| ```yaml | ||
| znc: | ||
| image: znc:latest |
There was a problem hiding this comment.
| image: znc:latest | |
| image: %%IMAGE%% |
(same as above)
| @@ -6,7 +6,7 @@ ZNC is an IRC network bouncer (BNC). It can detach the client from the actual IR | |||
|
|
|||
| [ZNC Wiki](http://znc.in/) | |||
|
|
|||
| # How to use this image | |||
| ## How to use this image | |||
There was a problem hiding this comment.
What was wrong with header?
There was a problem hiding this comment.
just being pedantic. Only single top line heading
|
|
||
| ### Running ZNC for first time (No config) | ||
|
|
||
| If this is your first time running ZNC (and have no configuration file), use the following `docker-compose.yml`: |
There was a problem hiding this comment.
For this one-off run, I don't see how docker-compose is any better than the docker run command from above.
There was a problem hiding this comment.
Thats true. Maybe should just update it to explain the process first? i.e. explain that its required before you setup the docker-compose or something?
Added an example Docker Compose for normal operation as well as first run configuration.
Added a Troubleshoot Section to include potential permission issues.
Additional changes