Portainer Templates logo

Portainer Templates

quassel-core quassel-core

Container

Messenger

Quassel IRC is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core -- much like the popular combination of screen and a text-based IRC client such as WeeChat, but graphical. Blowfish support and optional web-ui included.

Image details

Pulls: 6.7M
Architecture: amd64, arm64
Image size: 65 MB
Latest: 0.14.0
User: linuxserver
Created: May 26, 2015
Updated: 1 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/quassel-core:latest
Ports
4242/tcp
Volumes
/config
Env vars
PGID=1000PUID=1000TZ=America/Chicago

Template by dnburgess

Standalone Install

Select an install method, to see config/commands for deploying quassel-core

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select quassel-core, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

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

DEPRECATION NOTICE

This image is deprecated. We will not offer support for this image and it will not be updated.

linuxserver/quassel-core

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
Quassel-core is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core.
This container handles the IRC connection (quasselcore) and requires a desktop client (quasselclient) to be used and configured. It is designed to be always on and will keep your identity present in IRC even when your clients cannot be online. Backlog (history) is downloaded by your client upon reconnection allowing infinite scrollback through time.
quassel-core

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/quassel-core: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:
ArchitectureAvailableTag
x86-64amd64-\
arm64arm64v8-\
armhf

Application Setup

Quassel wiki: quassel
A great place to host a quassel instance is a VPS, such as DigitalOcean. For $5 a month you can have a 24/7 IRC connection and be up and running in under 55 seconds (or so they claim).
Once you have the container running, fire up a quassel desktop client and connect to your new core instance using your droplets public IP address and the port you specified in your docker run command default: 4242. Create an admin user, select SQLite as your storage backend (Quassel limitation). Setup your real name and nick, then press Save & Connect.
You're now connected to IRC. Let's add you to our IRC #linuxserver.io room on Freenode. Click 'File' > 'Networks' > 'Configure Networks' > 'Add' (under Networks section, not Servers) > 'Use preset' > Select 'Freenode' and then configure your identity using the tabs in the 'Network details' section. Once connected to Freenode, click #join and enter #linuxserver.io. That's it, you're done.

Stateless usage

To use Quassel in stateless mode, where it needs to be configured through environment arguments, run it with the --config-from-environment RUNOPTS environment setting.
EnvUsage
DBBACKENDSQLite or PostgreSQL
DBPGSQLUSERNAMEPostgreSQL User
DBPGSQLPASSWORDPostgreSQL Password
DBPGSQLHOSTNAMEPostgreSQL Host
DBPGSQLPORTPostgreSQL Port
AUTHAUTHENTICATORDatabase or LDAP
AUTHLDAPHOSTNAMELDAP Host
AUTHLDAPPORTLDAP Port
AUTHLDAPBINDDNLDAP Bind Domain
AUTHLDAPBINDPASSWORDLDAP Password
AUTHLDAPFILTERLDAP Authentication Filters
AUTHLDAPUIDATTRIBUTELDAP UID

Additionally you have RUN
OPTS that can be used to customize pathing and behavior.
OptionExample
--strict-identstrictly bool --strict-ident
--ident-daemonstrictly bool --ident-daemon
--ident-port--ident-port "10113"
--ident-listen--ident-listen "::,0.0.0.0"
--ssl-cert--ssl-cert /config/keys/cert.crt
--ssl-key--ssl-key /config/keys/cert.key
--require-sslstrictly bool --require-ssl

Minimal example with SQLite:
docker create \
  --name=quassel-core \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e RUN_OPTS='--config-from-environment' \
  -e DB_BACKEND=SQLite \
  -e AUTH_AUTHENTICATOR=Database \
  -p 4242:4242 \
  -v <path to data>:/config \
  --restart unless-stopped \
  linuxserver/quassel-core

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

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

---
services:
  quassel-core:
    image: lscr.io/linuxserver/quassel-core:latest
    container_name: quassel-core
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - RUN_OPTS=--config-from-environment #optional
    volumes:
      - /path/to/quassel-core/data:/config
    ports:
      - 4242:4242
      - 113:10113 #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=quassel-core \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e RUN_OPTS=--config-from-environment `#optional` \
  -p 4242:4242 \
  -p 113:10113 `#optional` \
  -v /path/to/quassel-core/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/quassel-core: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.
ParameterFunction
-p 4242:4242The port quassel-core listens for connections on.
-p 10113Optional Ident Port
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-e RUNOPTS=--config-from-environmentCustom CLI options for Quassel
-v /configDatabase and quassel-core configuration storage.

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

Docker Mods Docker Universal 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:
```bash
docker exec -it quassel-core /bin/bash
```
  • To monitor the logs of the container in realtime:
```bash
docker logs -f quassel-core
```
  • Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-core
```
  • Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-core: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:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull quassel-core
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d quassel-core
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/quassel-core:latest
```
  • Stop the running container:
```bash
docker stop quassel-core
```
  • Delete the container:
```bash
docker rm quassel-core
```
  • 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:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend 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-quassel-core.git
cd docker-quassel-core
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/quassel-core:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

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

Versions

  • 26.12.24: - Deprecate.
  • 26.08.23: - Rebase to Alpine 3.20.
  • 10.11.23: - Rebase to Alpine 3.18.
  • 03.07.23: - Deprecate armhf. As announced here
  • 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
  • 03.01.22: - Rebase to alpine 3.15. Add new build deps and apply other fixes for 0.14.
  • 07.08.21: - Fixing incorrect database password variable operator.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 20.03.19: - Make stateless operation an option, with input from one of the quassel team.
  • 26.01.19: - Add pipeline logic and multi arch.
  • 08.01.19: - Rebase to Ubuntu Bionic and upgrade to Quassel0.13.0 See here..
  • 30.07.18: - Rebase to alpine:3.8 and use buildstage.
  • 03.01.18: - Deprecate cpucore routine lack of scaling.
  • 09.12.17: - Rebase to alpine:3.7.
  • 26.11.17: - Use cpu core counting routine to speed up build time.
  • 12.07.17: - Add inspect commands to README, move to jenkins build and push.
  • 27.05.17: - Rebase to alpine:3.6.
  • 13.05.17: - Switch to git source.
  • 28.12.16: - Rebase to alpine:3.5.
  • 23.11.16: - Rebase to alpine:edge.
  • 23.09.16: - Use QT5 dependencies (thanks bauerj).
  • 10.09.16: - Add layer badges to README.
  • 28.08.16: - Add badges to README.
  • 10.08.16: - Rebase to xenial.
  • 14.10.15: - Removed the webui, turned out to be to unstable for most usecases.
  • 01.09.15: - Fixed mistake in README.
  • 30.07.15: - Switched to internal baseimage, and fixed a bug with updating the webinterface.
  • 06.07.15: - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.

Serve quassel-core on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying quassel-core.example.com to http://quassel-core:4242

Add this to your Caddyfile

quassel-core.example.com {
	reverse_proxy http://quassel-core:4242
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 4242/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Image won't pull

Test the pull directly on the host: docker pull linuxserver/quassel-core:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

quassel-core runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything quassel-core needs bundled into one download. This template pulls linuxserver/quassel-core:latest, which Docker fetches once (about 65 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. quassel-core's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.14.0. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 4242, published on a random host port

Volumes

A volume is where quassel-core keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. quassel-core takes 3 of them, all with defaults you can leave alone or tweak:

  • PGID, defaults to 1000
  • PUID, defaults to 1000
  • TZ, defaults to America/Chicago

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so quassel-core sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set quassel-core up. Add the template list to Portainer once, then deploying quassel-core is a click rather than a wall of config.