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/9/head
LinuxServer-CI 2019-10-02 04:17:02 -04:00
rodzic 82cea28b84
commit 9e7e32cece
1 zmienionych plików z 28 dodań i 17 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

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

@ -1,6 +1,12 @@
# linuxserver/znc # [linuxserver/znc](https://github.com/linuxserver/docker-znc)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-znc.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-znc/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/znc.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/znc) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/znc.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/znc) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/znc) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/znc) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-znc/job/master/badge/icon?style=flat-square)](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) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-znc.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-znc/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/znc.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/znc.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/znc)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/znc)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-znc/job/master/badge/icon?style=flat-square)](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)
[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. [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.
@ -13,18 +19,19 @@ Simply pulling `linuxserver/znc` should retrieve the correct image for your arch
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=znc \ --name=znc \
-e PUID=1000 \ -e PUID=1000 \
@ -36,6 +43,7 @@ docker create \
linuxserver/znc linuxserver/znc
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -60,49 +68,53 @@ services:
## Parameters ## Parameters
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. 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.
### Ports \(`-p`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `6501` | Port ZNC listens on. | | `6501` | Port ZNC listens on. |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Where local ZNC data is stored. | | `/config` | Where local ZNC data is stored. |
## User / Group Identifiers ## User / Group Identifiers
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`. 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. 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=1000` and `PGID=1000`, to find yours use `id user` as below: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
To log in to the application, browse to http://:6501. To log in to the application, browse to http://<hostip>:6501.
* Default User: admin * Default User: admin
* Default Password: admin * Default Password: admin
`change password ASAP.`
`change password ASAP.`
## Support Info ## Support Info
@ -123,7 +135,7 @@ To log in to the application, browse to http://:6501.
* **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.
@ -137,4 +149,3 @@ To log in to the application, browse to http://:6501.
* **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, move to main repository.
* **11.12.15:** - Initial Release. * **11.12.15:** - Initial Release.