From 90ddf506a13216aaf49061df380e5800b7d7c6ab Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 10 Oct 2021 20:56:58 +0200 Subject: [PATCH] Bot Updating Documentation --- images/docker-quassel-web.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/images/docker-quassel-web.md b/images/docker-quassel-web.md index a63be54bb..1f3b63eef 100644 --- a/images/docker-quassel-web.md +++ b/images/docker-quassel-web.md @@ -10,7 +10,7 @@ title: 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) [![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) -[![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") +[![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-web) [![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/) @@ -22,7 +22,7 @@ title: quassel-web 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/). -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. +Simply pulling `lscr.io/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: @@ -42,18 +42,16 @@ The configuration file using this method can be found at: ## Usage -Here are some example snippets to help you get started creating a container from this image. +To help you get started creating a container from this image you can either use docker-compose or the docker cli. -### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) - -Compatible with docker-compose v2 schemas. +### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- version: "2.1" services: quassel-web: - image: ghcr.io/linuxserver/quassel-web + image: lscr.io/linuxserver/quassel-web container_name: quassel-web environment: - PUID=1000 @@ -68,7 +66,7 @@ services: restart: unless-stopped ``` -### docker cli +### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) ```bash docker run -d \ @@ -81,7 +79,7 @@ docker run -d \ -p 64080:64080 \ -v :/config \ --restart unless-stopped \ - ghcr.io/linuxserver/quassel-web + lscr.io/linuxserver/quassel-web ``` ## Parameters @@ -110,6 +108,11 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/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__`. @@ -155,7 +158,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * Container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-web` * Image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/quassel-web` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-web` ## Versions