kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
rodzic
e75ff5f0a1
commit
1d07c7b6cd
|
@ -1,6 +1,15 @@
|
|||
# linuxserver/znc
|
||||
# [linuxserver/znc](https://github.com/linuxserver/docker-znc)
|
||||
|
||||
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-znc.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-znc.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-znc/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/znc) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/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&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/znc) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](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 Stars](https://img.shields.io/github/stars/linuxserver/docker-znc.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc)
|
||||
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-znc.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc/releases)
|
||||
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-znc/packages)
|
||||
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-znc/container_registry)
|
||||
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/znc)
|
||||
[![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")
|
||||
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/znc)
|
||||
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](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.
|
||||
|
||||
|
@ -13,18 +22,19 @@ Simply pulling `linuxserver/znc` should retrieve the correct image for your arch
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=znc \
|
||||
-e PUID=1000 \
|
||||
|
@ -36,6 +46,7 @@ docker create \
|
|||
linuxserver/znc
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
@ -60,55 +71,59 @@ services:
|
|||
|
||||
## 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 |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `6501` | Port ZNC listens on. |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Where local ZNC data is stored. |
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## 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 Password: admin
|
||||
|
||||
`change password ASAP.`
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27znc%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=znc "view available mods for this container.")
|
||||
|
||||
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27znc%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=znc)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
@ -131,7 +146,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **31.01.19:** - Add pipeline logic and multi arch.
|
||||
* **30.01.19:** - Add push and clientbuffer modules.
|
||||
* **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.
|
||||
* **25.10.17:** - Remove debug switch from run command.
|
||||
* **26.05.17:** - Rebase alpine linux 3.6.
|
||||
|
@ -145,4 +160,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **28.08.16:** - Add badges to README.
|
||||
* **20.08.16:** - Rebase to alpine linux, move to main repository.
|
||||
* **11.12.15:** - Initial Release.
|
||||
|
||||
|
|
Ładowanie…
Reference in New Issue