docker-documentation/docs/images/docker-znc.md

title
znc

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

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:latest 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	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup

To log in to the application, browse to http://<hostip>: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.

docker-compose (recommended, click here for more info)

---
services:
  znc:
    image: lscr.io/linuxserver/znc:latest
    container_name: znc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/znc/config:/config
    ports:
      - 6501:6501
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=znc \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 6501:6501 \
  -v /path/to/znc/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/znc:latest

Parameters

Containers 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=Etc/UTC	specify a timezone to use, see this list.

Volume Mappings (-v)

Volume	Function
/config	Persistent config files

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:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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:latest
  

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update images:

  • All images:

    docker-compose pull
    

  • Single image:

    docker-compose pull znc
    

• Update containers:

  • All containers:

    docker-compose up -d
    

  • Single container:

    docker-compose up -d znc
    

• You can also remove the old dangling images:

  docker image prune
  

Via Docker Run

• Update the image:

  docker pull lscr.io/linuxserver/znc:latest
  

• Stop the running container:

  docker stop znc
  

• Delete the container:

  docker rm znc
  

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune
  

Image Update Notifications - Diun (Docker Image Update Notifier)

!!! tip

We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-znc.git
cd docker-znc
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/znc:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 22.02.24: - Update build system for v1.9.0 (use cmake).
• 23.12.23: - Rebase to Alpine 3.19.
• 12.07.23: - Rebasing to Alpine 3.18.
• 07.07.23: - Deprecate armhf. As announced here
• 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
• 19.01.22: - Rebasing to alpine 3.15.
• 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.