xadammr / docker-znc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

linuxserver.io

Blog Discord Discourse Fleet GitHub Open Collective

The LinuxServer.io team brings you another container release featuring :-

  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:

  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • Fleet - an online web interface which displays all of our maintained images.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io MicroBadger Layers Docker Pulls Docker Stars Build Status

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

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

Usage

Here are some example snippets to help you get started creating a container.

docker

docker create \
  --name=znc \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 6501:6501 \
  -v <path to data>:/config \
  --restart unless-stopped \
  linuxserver/znc

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  znc:
    image: linuxserver/znc
    container_name: znc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - <path to data>:/config
    ports:
      - 6501:6501
    restart: unless-stopped

Parameters

Container 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.

Parameter Function
-p 6501 Port ZNC listens on.
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Europe/London Specify a timezone to use EG Europe/London.
-v /config Where local ZNC data is stored.

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__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

 

Application Setup

To log in to the application, browse to http://:6501.

  • Default User: admin
  • Default Password: admin change password ASAP.

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" }}' linuxserver/znc

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 (ie. nextcloud, plex), 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 Run/Create

  • Update the image: docker pull linuxserver/znc
  • Stop the running container: docker stop znc
  • Delete the container: docker rm znc
  • Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • Start the new container: docker start znc
  • You can also remove the old dangling images: docker image prune

Via Docker Compose

  • Update all images: docker-compose pull
    • or update a single image: docker-compose pull znc
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d znc
  • You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (especially useful if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one run:
    docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once znc
    

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

  • You can also remove the old dangling images: docker image prune

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

  • 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.

About

License:GNU General Public License v3.0


Languages

Language:Dockerfile 100.0%