docker-documentation/docs/images/docker-quassel-core.md

378 wiersze
16 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-14 09:38:31 +00:00
---
title: quassel-core
---
2023-10-09 09:20:59 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-quassel-core/blob/master/.github/CONTRIBUTING.md -->
2020-06-29 14:15:54 +00:00
# [linuxserver/quassel-core](https://github.com/linuxserver/docker-quassel-core)
2019-02-11 15:16:42 +00:00
2021-12-19 09:42:06 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fquassel-core?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fquassel-core)
2020-06-29 14:15:54 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-quassel-core.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-quassel-core)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-quassel-core.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-quassel-core/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-quassel-core/packages)
2020-12-16 21:16:34 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-quassel-core/container_registry)
2021-10-03 09:41:45 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/quassel-core)
2020-06-29 14:15:54 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-core.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/quassel-core)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-core.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/quassel-core)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-quassel-core%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-core/job/master/)
2020-11-02 19:55:22 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fquassel-core%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/quassel-core/latest/index.html)
2019-02-11 15:16:42 +00:00
2020-06-29 14:15:54 +00:00
[Quassel-core](http://quassel-irc.org/) 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.
2019-02-11 15:16:42 +00:00
2023-10-09 09:20:59 +00:00
[![quassel-core](http://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/256/Apps-quassel-icon.png)](http://quassel-irc.org/)
2019-02-12 15:25:12 +00:00
## Supported Architectures
2022-05-01 09:39:12 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-12 15:25:12 +00:00
2022-05-01 09:39:12 +00:00
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.
2019-02-12 15:25:12 +00:00
The architectures supported by this image are:
2022-05-01 09:39:12 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-07-03 09:23:02 +00:00
| armhf | ❌ | |
2019-02-11 15:16:42 +00:00
2021-04-18 09:43:26 +00:00
## Application Setup
Quassel wiki: [quassel](http://bugs.quassel-irc.org/projects/quassel-irc/wiki)
A great place to host a quassel instance is a VPS, such as [DigitalOcean](https://www.digitalocean.com/?refcode=501c48b34b8c). 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](http://www.linuxserver.io/index.php/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` RUN_OPTS environment setting.
| Env | Usage |
| :----: | --- |
| DB_BACKEND | `SQLite` or `PostgreSQL` |
| DB_PGSQL_USERNAME | PostgreSQL User |
| DB_PGSQL_PASSWORD | PostgreSQL Password |
| DB_PGSQL_HOSTNAME | PostgreSQL Host |
| DB_PGSQL_PORT | PostgreSQL Port |
| AUTH_AUTHENTICATOR | `Database` or `LDAP` |
| AUTH_LDAP_HOSTNAME | LDAP Host |
| AUTH_LDAP_PORT | LDAP Port |
| AUTH_LDAP_BIND_DN | LDAP Bind Domain |
| AUTH_LDAP_BIND_PASSWORD | LDAP Password |
| AUTH_LDAP_FILTER | LDAP Authentication Filters |
| AUTH_LDAP_UID_ATTRIBUTE | LDAP UID |
Additionally you have RUN_OPTS that can be used to customize pathing and behvior.
| Option | Example |
| :----: | --- |
| --strict-ident | strictly bool `--strict-ident` |
| --ident-daemon | strictly 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-ssl | strictly 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
```
2020-06-29 14:15:54 +00:00
2019-02-11 15:16:42 +00:00
## Usage
2021-07-04 09:36:56 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-12 15:25:12 +00:00
2021-07-04 09:36:56 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-12 15:25:12 +00:00
```yaml
---
2020-04-13 14:15:49 +00:00
version: "2.1"
2019-02-12 15:25:12 +00:00
services:
quassel-core:
2022-05-01 09:39:12 +00:00
image: lscr.io/linuxserver/quassel-core:latest
2019-02-12 15:25:12 +00:00
container_name: quassel-core
environment:
2019-03-04 15:15:50 +00:00
- PUID=1000
- PGID=1000
2023-02-12 09:31:11 +00:00
- TZ=Etc/UTC
2019-03-24 22:13:29 +00:00
- RUN_OPTS=--config-from-environment #optional
2019-02-12 15:25:12 +00:00
volumes:
2023-02-14 09:31:09 +00:00
- /path/to/data:/config
2019-02-12 15:25:12 +00:00
ports:
- 4242:4242
2019-03-24 22:13:29 +00:00
- 113:10113 #optional
2019-02-12 15:25:12 +00:00
restart: unless-stopped
2019-02-11 15:16:42 +00:00
```
2021-07-04 09:36:56 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-05 14:42:49 +00:00
2021-04-18 09:43:26 +00:00
```bash
2020-10-05 14:42:49 +00:00
docker run -d \
--name=quassel-core \
-e PUID=1000 \
-e PGID=1000 \
2023-02-12 09:31:11 +00:00
-e TZ=Etc/UTC \
2020-10-05 14:42:49 +00:00
-e RUN_OPTS=--config-from-environment `#optional` \
-p 4242:4242 \
-p 113:10113 `#optional` \
2023-02-14 09:31:09 +00:00
-v /path/to/data:/config \
2020-10-05 14:42:49 +00:00
--restart unless-stopped \
2022-05-01 09:39:12 +00:00
lscr.io/linuxserver/quassel-core:latest
2020-10-05 14:42:49 +00:00
```
2019-02-11 15:16:42 +00:00
## Parameters
2023-10-09 09:20:59 +00:00
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.
2019-02-11 15:16:42 +00:00
2020-06-29 14:15:54 +00:00
### Ports (`-p`)
2019-02-11 15:16:42 +00:00
2019-02-12 15:25:12 +00:00
| Parameter | Function |
2020-06-29 14:15:54 +00:00
| :----: | --- |
2019-02-12 15:25:12 +00:00
| `4242` | The port quassel-core listens for connections on. |
2019-03-24 22:13:29 +00:00
| `10113` | Optional Ident Port |
2019-02-11 15:16:42 +00:00
2020-06-29 14:15:54 +00:00
### Environment Variables (`-e`)
2019-02-11 15:16:42 +00:00
2019-02-12 15:25:12 +00:00
| Env | Function |
2020-06-29 14:15:54 +00:00
| :----: | --- |
2019-03-04 15:15:50 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-12 09:31:11 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2019-03-24 22:13:29 +00:00
| `RUN_OPTS=--config-from-environment` | Custom CLI options for Quassel |
2019-02-11 15:16:42 +00:00
2020-06-29 14:15:54 +00:00
### Volume Mappings (`-v`)
2019-02-12 15:25:12 +00:00
| Volume | Function |
2020-06-29 14:15:54 +00:00
| :----: | --- |
2019-02-12 15:25:12 +00:00
| `/config` | Database and quassel-core configuration storage. |
2021-10-03 09:41:45 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-06-29 14:15:54 +00:00
## Environment variables from files (Docker secrets)
2020-06-01 14:15:55 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-18 09:43:26 +00:00
```bash
2023-10-09 09:20:59 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-06-01 14:15:55 +00:00
```
2023-10-09 09:20:59 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-06-01 14:15:55 +00:00
## Umask for running applications
2020-06-29 14:15:54 +00:00
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-12 15:25:12 +00:00
## User / Group Identifiers
2020-06-29 14:15:54 +00:00
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`.
2019-02-12 15:25:12 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-09 09:20:59 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-11 15:16:42 +00:00
2021-04-18 09:43:26 +00:00
```bash
2023-10-09 09:20:59 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-11 15:16:42 +00:00
```
2020-04-13 14:15:49 +00:00
## Docker Mods
2021-04-18 09:43:26 +00:00
2020-10-05 14:42:49 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=quassel-core&query=%24.mods%5B%27quassel-core%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=quassel-core "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-13 14:15:49 +00:00
2020-10-05 14:42:49 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/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.
2020-04-13 14:15:49 +00:00
2019-02-12 15:25:12 +00:00
## Support Info
2019-02-11 15:16:42 +00:00
2019-09-02 15:30:05 +00:00
* Shell access whilst the container is running:
2023-10-09 09:20:59 +00:00
```bash
docker exec -it quassel-core /bin/bash
```
2019-09-02 15:30:05 +00:00
* To monitor the logs of the container in realtime:
2023-10-09 09:20:59 +00:00
```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 (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#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
```
### Via Watchtower auto-updater (only use 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:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once quassel-core
```
* You can also remove the old dangling images: `docker image prune`
!!! warning
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](https://docs.linuxserver.io/general/docker-compose).
### 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:
```bash
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 x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-11 15:16:42 +00:00
## Versions
2023-07-03 09:23:02 +00:00
* **03.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
2023-02-14 09:31:09 +00:00
* **13.02.23:** - Rebase to Alpine 3.17, migrate to s6v3.
2022-01-03 16:57:58 +00:00
* **03.01.22:** - Rebase to alpine 3.15. Add new build deps and apply other fixes for 0.14.
2021-08-15 09:34:01 +00:00
* **07.08.21:** - Fixing incorrect database password variable operator.
2019-12-21 23:19:25 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-06-30 19:16:07 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 22:13:29 +00:00
* **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.
2019-02-12 15:25:12 +00:00
* **26.01.19:** - Add pipeline logic and multi arch.
* **08.01.19:** - Rebase to Ubuntu Bionic and upgrade to Quassel`0.13.0` See [here.](https://quassel-irc.org/node/134).
* **30.07.18:** - Rebase to alpine:3.8 and use buildstage.
2020-06-29 14:15:54 +00:00
* **03.01.18:** - Deprecate cpu_core routine lack of scaling.
2019-02-12 15:25:12 +00:00
* **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.
2020-06-29 14:15:54 +00:00
* **23.09.16:** - Use QT5 dependencies (thanks bauerj).
2019-02-12 15:25:12 +00:00
* **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.
2020-06-29 14:15:54 +00:00
* **06.07.15:** - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.