docker-documentation/images/docker-quassel-web.md

167 wiersze
8.7 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-18 11:56:09 +00:00
---
title: quassel-web
---
2021-04-22 11:56:05 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-quassel-web/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 17:44:46 +00:00
# [linuxserver/quassel-web](https://github.com/linuxserver/docker-quassel-web)
2019-04-29 18:13:03 +00:00
2020-07-02 17:44:46 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-quassel-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-quassel-web)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-quassel-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-quassel-web/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-web/packages)
2020-12-16 21:17:12 +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-web/container_registry)
2020-07-02 17:44:46 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/quassel-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/quassel-web "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/quassel-web)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-web.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/quassel-web)
[![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-web%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-web/job/master/)
2020-11-02 16:25:35 +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-web%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/quassel-web/latest/index.html)
2020-07-02 17:44:46 +00:00
2021-04-22 11:56:05 +00:00
[Quassel-web](https://github.com/magne4000/quassel-webserver) is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available [here.](https://hub.docker.com/r/linuxserver/quassel-core/)
2019-04-29 18:13:03 +00:00
## Supported Architectures
2019-09-05 17:45:43 +00:00
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](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-04-29 18:13:03 +00:00
2020-11-02 16:25:35 +00:00
Simply pulling `ghcr.io/linuxserver/quassel-web` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-04-29 18:13:03 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-02 17:44:46 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
2021-04-22 11:56:05 +00:00
## Application Setup
By default this container webui will be available on `http://$SERVER_IP:64080`. 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
```
2020-07-02 17:44:46 +00:00
2019-04-29 18:13:03 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
2020-10-08 17:44:59 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-04-29 18:13:03 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-09 17:44:53 +00:00
version: "2.1"
2019-04-29 18:13:03 +00:00
services:
quassel-web:
2020-11-02 16:25:35 +00:00
image: ghcr.io/linuxserver/quassel-web
2019-04-29 18:13:03 +00:00
container_name: quassel-web
environment:
- PUID=1000
- PGID=1000
- QUASSEL_CORE=192.168.1.10
- QUASSEL_PORT=4242
2019-05-19 18:57:05 +00:00
- URL_BASE=/quassel #optional
2019-04-29 18:13:03 +00:00
volumes:
- <path to data>:/config
ports:
- 64080:64080
restart: unless-stopped
```
2020-10-08 17:44:59 +00:00
### docker cli
2021-04-22 11:56:05 +00:00
```bash
2020-10-08 17:44:59 +00:00
docker run -d \
--name=quassel-web \
-e PUID=1000 \
-e PGID=1000 \
-e QUASSEL_CORE=192.168.1.10 \
-e QUASSEL_PORT=4242 \
-e URL_BASE=/quassel `#optional` \
-p 64080:64080 \
-v <path to data>:/config \
--restart unless-stopped \
2020-11-02 16:25:35 +00:00
ghcr.io/linuxserver/quassel-web
2020-10-08 17:44:59 +00:00
```
2019-04-29 18:13:03 +00:00
## Parameters
2020-07-02 17:44:46 +00:00
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.
2019-04-29 18:13:03 +00:00
2020-07-02 17:44:46 +00:00
### Ports (`-p`)
2019-04-29 18:13:03 +00:00
| Parameter | Function |
2020-07-02 17:44:46 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| `64080` | will map the container's port 64080 to port 64080 on the host |
2020-07-02 17:44:46 +00:00
### Environment Variables (`-e`)
2019-04-29 18:13:03 +00:00
| Env | Function |
2020-07-02 17:44:46 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `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` |
2020-07-02 17:44:46 +00:00
### Volume Mappings (`-v`)
2019-04-29 18:13:03 +00:00
| Volume | Function |
2020-07-02 17:44:46 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| `/config` | this will store config on the docker host |
2020-07-02 17:44:46 +00:00
## Environment variables from files (Docker secrets)
2020-06-04 17:44:52 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-22 11:56:05 +00:00
```bash
2020-06-04 17:44:52 +00:00
-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
2020-07-02 17:44:46 +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-04-29 18:13:03 +00:00
## User / Group Identifiers
2020-07-02 17:44:46 +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-04-29 18:13:03 +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.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2021-04-22 11:56:05 +00:00
```bash
2019-04-29 18:13:03 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
2020-04-09 17:44:53 +00:00
## Docker Mods
2021-04-22 11:56:05 +00:00
2020-10-08 17:44:59 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=quassel-web&query=%24.mods%5B%27quassel-web%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=quassel-web "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-09 17:44:53 +00:00
2020-10-08 17:44:59 +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-09 17:44:53 +00:00
2019-04-29 18:13:03 +00:00
## Support Info
2019-09-05 17:45:43 +00:00
* Shell access whilst the container is running:
2019-04-29 18:13:03 +00:00
* `docker exec -it quassel-web /bin/bash`
2019-09-05 17:45:43 +00:00
* To monitor the logs of the container in realtime:
2019-04-29 18:13:03 +00:00
* `docker logs -f quassel-web`
2019-09-05 17:45:43 +00:00
* Container version number
2019-04-29 18:13:03 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-web`
* Image version number
2020-11-02 16:25:35 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/quassel-web`
2019-04-29 18:13:03 +00:00
## Versions
2020-07-17 17:19:53 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2019-12-21 23:19:21 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-06-30 19:21:27 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-19 18:57:05 +00:00
* **18.05.19:** - Reconfigure environmental variable setup.
2019-04-29 18:13:03 +00:00
* **28.04.19:** - Initial Release.