9.6 KiB
title |
---|
quassel-web |
linuxserver/quassel-web
Quassel-web is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available here.
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-web: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 | ✅ | arm32v7-<version tag> |
Application Setup
By default this container webui will be available on https://$SERVER_IP:64443
. To setup this container you can either use the envrionment variables we recommend or manually setup the configuration file by leaving out the QUASSEL_CORE
environment variable among others.
The configuration file using this method can be found at:
/config/settings-user.js
Strict reverse proxies
This image uses a self-signed certificate by default. This naturally means the scheme is https
.
If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)
---
version: "2.1"
services:
quassel-web:
image: lscr.io/linuxserver/quassel-web:latest
container_name: quassel-web
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- QUASSEL_CORE=192.168.1.10
- QUASSEL_PORT=4242
- URL_BASE=/quassel #optional
volumes:
- /path/to/data:/config
ports:
- 64443:64443
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=quassel-web \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e QUASSEL_CORE=192.168.1.10 \
-e QUASSEL_PORT=4242 \
-e URL_BASE=/quassel `#optional` \
-p 64443:64443 \
-v /path/to/data:/config \
--restart unless-stopped \
lscr.io/linuxserver/quassel-web:latest
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 |
---|---|
64443 |
Quassel-web https webui |
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. |
QUASSEL_CORE=192.168.1.10 |
specify the URL or IP address of your Quassel Core instance |
QUASSEL_PORT=4242 |
specify the port of your Quassel Core instance |
URL_BASE=/quassel |
Specify a url-base in reverse proxy setups ie. /quassel |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
this will store config on the docker host |
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__PASSWORD=/run/secrets/mysecretpassword
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:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
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 quassel-web /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f quassel-web
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-web
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-web:latest
Versions
- 13.02.23: - Rebasing to Alpine 3.17, migrate to s6v3.
- 12.02.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 18.05.19: - Reconfigure environmental variable setup.
- 28.04.19: - Initial Release.