mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 14:41:14 +00:00
rodzic 2a97ab4a5c
commit e086bd8267
1 zmienionych plików z 107 dodań i 62 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

169
images/docker-znc.md
Wyświetl plik

@ -1,65 +1,113 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/znc](https://github.com/linuxserver/docker-znc)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://wiki.znc.in/ZNC
[hub]: https://hub.docker.com/r/linuxserver/znc/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-znc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-znc/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [Znc](http://wiki.znc.in/ZNC) 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.
* [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 ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-znc)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-znc/)
[ZNC][appurl] 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. Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
Simply pulling `linuxserver/znc` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![znc](http://wiki.znc.in/resources/assets/wiki.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=znc \ --name=znc \
-v <path to data>:/config \ -e PUID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e PGID=1001 \
-e TZ=<timezone> \ -e TZ=Europe/London \
-p 6501:6501 \ -p 6501:6501 \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/znc linuxserver/znc
``` ```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
znc:
image: linuxserver/znc
container_name: znc
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
ports:
- 6501:6501
mem_limit: 4096m
restart: unless-stopped
```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `6501` | Port ZNC listens on. |
* `-p 6501` - the port(s) ### Environment Variables (`-e`)
* `-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`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | Where local ZNC data is stored. |
### 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" ™. ## User / Group Identifiers
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: When using 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 any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## Application Setup
To log in to the application, browse to https://<hostip>:6501. To log in to the application, browse to https://<hostip>:6501.
@ -67,38 +115,35 @@ To log in to the application, browse to https://<hostip>:6501.
* Default Password: admin * Default Password: admin
`change password ASAP.` `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`
* container version number ## Support Info
`docker inspect -f '{{ index .Config.Labels "build_version" }}' znc` * Shell access whilst the container is running:
* `docker exec -it znc /bin/bash`
* image version number * To monitor the logs of the container in realtime:
* `docker logs -f znc`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/znc` * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' znc`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/znc`
## Versions ## Versions
+ **31.01.19:** Add pipeline logic and multi arch. * **31.01.19:** - Add pipeline logic and multi arch.
+ **30.01.19:** Add push and clientbuffer modules. * **30.01.19:** - Add push and clientbuffer modules.
+ **17.08.18:** Rebase to alpine 3.8, use buildstage. * **17.08.18:** - Rebase to alpine 3.8, use buildstage.
+ **03.01.18:** Deprecate cpu_core routine lack of scaling. * **03.01.18:** - Deprecate cpu_core routine lack of scaling.
+ **07.12.17:** Rebase alpine linux 3.7. * **07.12.17:** - Rebase alpine linux 3.7.
+ **25.10.17:** Remove debug switch from run command. * **25.10.17:** - Remove debug switch from run command.
+ **26.05.17:** Rebase alpine linux 3.6. * **26.05.17:** - Rebase alpine linux 3.6.
+ **06.02.17:** Rebase alpine linux 3.5. * **06.02.17:** - Rebase alpine linux 3.5.
+ **19.01.17:** Add playback module. * **19.01.17:** - Add playback module.
+ **07.01.17:** Add ca-certificates package, resolve sasl issues. * **07.01.17:** - Add ca-certificates package, resolve sasl issues.
+ **07.12.16:** Use scanelf to determine runtime dependencies. * **07.12.16:** - Use scanelf to determine runtime dependencies. Fix error with continuation.
fix error with `\` instead of `&&\`. * **14.10.16:** - Add version layer information.
+ **14.10.16:** Add version layer information. * **30.09.16:** - Fix umask.
+ **30.09.16:** Fix umask. * **11.09.16:** - Add layer badges to README.
+ **11.09.16:** Add layer badges to README. * **28.08.16:** - Add badges to README.
+ **28.08.16:** Add badges to README. * **20.08.16:** - Rebase to alpine linux, move to main repository.
+ **20.08.16:** Rebase to alpine linux, * **11.12.15:** - Initial Release.
move to main repository.
+ **11.12.15:** Initial Release.