mirror of
https://github.com/linuxserver/docker-znc.git
synced 2026-02-20 01:42:38 +08:00
77 lines
3.2 KiB
Markdown
77 lines
3.2 KiB
Markdown
[linuxserverurl]: https://linuxserver.io
|
|
[forumurl]: https://forum.linuxserver.io
|
|
[ircurl]: https://www.linuxserver.io/index.php/irc/
|
|
[podcasturl]: https://www.linuxserver.io/index.php/category/podcast/
|
|
|
|
[][linuxserverurl]
|
|
|
|
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
|
* [forum.linuxserver.io][forumurl]
|
|
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
|
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
|
|
|
# linuxserver/znc
|
|
[](http://microbadger.com/images/linuxserver/znc "Get your own image badge on microbadger.com")[][hub][][hub][](http://jenkins.linuxserver.io:8080/job/Dockers/job/LinuxServer.io/job/linuxserver-znc/)
|
|
[hub]: https://hub.docker.com/r/linuxserver/znc/
|
|
|
|
[ZNC][zncurl] is an IRC network bouncer or 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.
|
|
|
|
[][zncurl]
|
|
[zncurl]: http://wiki.znc.in/ZNC
|
|
|
|
## Usage
|
|
|
|
```
|
|
docker create \
|
|
--name=znc \
|
|
-v <path to data>:/config \
|
|
-e PGID=<gid> -e PUID=<uid> \
|
|
-e TZ=<timezone> \
|
|
-p 6501:6501 \
|
|
linuxserver/znc
|
|
```
|
|
|
|
**Parameters**
|
|
|
|
* `-p 6501` - the port(s)
|
|
* `-v /config` -
|
|
* `-e PGID` for GroupID - see below for explanation
|
|
* `-e PUID` for UserID - see below for explanation
|
|
* `-e TZ` for timezone EG. Europe/London
|
|
|
|
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it znc /bin/bash`.
|
|
|
|
|
|
### User / Group Identifiers
|
|
|
|
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
|
|
|
|
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
|
|
|
|
```
|
|
$ id <dockeruser>
|
|
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
|
```
|
|
|
|
## Setting up the application
|
|
|
|
To log in to the application, browse to https://<hostip>:6501.
|
|
|
|
* Default User: admin
|
|
* Default Password: admin
|
|
`change password ASAP.`
|
|
|
|
## Info
|
|
|
|
* Shell access whilst the container is running: `docker exec -it znc /bin/bash`
|
|
* To monitor the logs of the container in realtime: `docker logs -f znc`
|
|
|
|
|
|
## Versions
|
|
|
|
+ **11.09.16:** Add layer badges to README.
|
|
+ **28.08.16:** Add badges to README.
|
|
+ **20.08.16:** Rebase to alpine linux,
|
|
move to main repository.
|
|
+ **11.12.15:** Initial Release.
|