Search…
Images
Powered By GitBook
linuxserver/znc
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.

Supported Architectures

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 and our announcement here.
Simply pulling lscr.io/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
arm32v7-latest

Application Setup

To log in to the application, browse to http://:6501.
    Default User: admin
    Default Password: admin
    change password ASAP.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
znc:
5
image: lscr.io/linuxserver/znc
6
container_name: znc
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- <path to data>:/config
13
ports:
14
- 6501:6501
15
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=znc \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 6501:6501 \
7
-v <path to data>:/config \
8
--restart unless-stopped \
9
lscr.io/linuxserver/znc
Copied!

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.

Ports (-p)

Parameter
Function
6501
Port ZNC listens on.

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
Function
/config
Where local ZNC data is stored.

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

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.
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support 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
      docker inspect -f '{{ index .Config.Labels "build_version" }}' znc
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/znc

Versions

    01.06.20: - Rebasing to alpine 3.12.
    19.12.19: - Rebasing to alpine 3.11.
    02.11.19: - Add znc-palaver module.
    28.06.19: - Rebasing to alpine 3.10.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    22.02.19: - Rebasing to alpine 3.9.
    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.
    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.
    06.02.17: - Rebase alpine linux 3.5.
    19.01.17: - Add playback module.
    07.01.17: - Add ca-certificates package, resolve sasl issues.
    07.12.16: - Use scanelf to determine runtime dependencies. Fix error with continuation.
    14.10.16: - Add version layer information.
    30.09.16: - Fix umask.
    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.
Last modified 23d ago