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

152 wiersze
7.0 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-03 17:45:41 +00:00
# [linuxserver/quassel-web](https://github.com/linuxserver/docker-quassel-web)
2019-04-29 18:13:03 +00:00
2019-10-31 18:44:54 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-quassel-web.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-quassel-web)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-quassel-web.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-quassel-web/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-quassel-web/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-quassel-web/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/quassel-web)
2019-10-03 17:45:41 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/quassel-web.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/quassel-web "Get your own version badge on microbadger.com")
2019-10-31 18:44:54 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-web.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/quassel-web)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-web.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/quassel-web)
2019-10-03 17:45:41 +00:00
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-quassel-web/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-web/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-web/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-web/latest/index.html)
[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
Simply pulling `linuxserver/quassel-web` 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 |
2019-10-03 17:45:41 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
2019-10-03 17:45:41 +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.
### docker
2019-10-03 17:45:41 +00:00
```
2019-04-29 18:13:03 +00:00
docker create \
--name=quassel-web \
-e PUID=1000 \
-e PGID=1000 \
-e QUASSEL_CORE=192.168.1.10 \
-e QUASSEL_PORT=4242 \
2019-05-19 18:57:05 +00:00
-e URL_BASE=/quassel `#optional` \
2019-04-29 18:13:03 +00:00
-p 64080:64080 \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/quassel-web
```
2019-10-03 17:45:41 +00:00
2019-04-29 18:13:03 +00:00
### docker-compose
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:
image: linuxserver/quassel-web
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
```
## Parameters
2019-10-03 17:45:41 +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
2019-10-03 17:45:41 +00:00
### Ports (`-p`)
2019-04-29 18:13:03 +00:00
| Parameter | Function |
2019-10-03 17:45:41 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| `64080` | will map the container's port 64080 to port 64080 on the host |
2019-10-03 17:45:41 +00:00
### Environment Variables (`-e`)
2019-04-29 18:13:03 +00:00
| Env | Function |
2019-10-03 17:45:41 +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` |
2019-10-03 17:45:41 +00:00
### Volume Mappings (`-v`)
2019-04-29 18:13:03 +00:00
| Volume | Function |
2019-10-03 17:45:41 +00:00
| :----: | --- |
2019-04-29 18:13:03 +00:00
| `/config` | this will store config on the docker host |
2019-10-03 17:45:41 +00:00
2020-04-09 17:44:53 +00:00
2019-04-29 18:13:03 +00:00
## User / Group Identifiers
2019-10-03 17:45:41 +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:
2019-10-03 17:45:41 +00:00
```
2019-04-29 18:13:03 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
2019-10-03 17:45:41 +00:00
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:
```
2019-05-19 18:57:05 +00:00
/config/settings-user.js
```
2019-04-29 18:13:03 +00:00
2019-10-03 17:45:41 +00:00
2020-04-09 17:44:53 +00:00
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&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.")
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) can be accessed via the dynamic badge above.
2019-10-03 17:45:41 +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
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/quassel-web`
## Versions
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.