readme-vars.yml

---

# project information
project_name: quassel-web
project_url: "https://github.com/magne4000/quassel-webserver"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/quassel-web-banner.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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/)"
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_deprecation_status: true
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "this will store config on the docker host"}
param_usage_include_env: false
opt_param_usage_include_env: true
opt_param_env_vars:
  - {env_var: "QUASSEL_CORE", env_value: "192.168.1.10", desc: "specify the URL or IP address of your Quassel Core instance"}
  - {env_var: "QUASSEL_PORT", env_value: "4242", desc: "specify the port of your Quassel Core instance"}
  - {env_var: "QUASSEL_HTTPS", env_value: "", desc: "Set to `true` to have Quassel web serve over https on port 64443 instead of http on port 64080."}
  - {env_var: "URL_BASE", env_value: "/quassel", desc: "Specify a url-base in reverse proxy setups ie. `/quassel`"}
param_usage_include_ports: false
opt_param_usage_include_ports: true
opt_param_ports:
  - {external_port: "64080", internal_port: "64080", port_desc: "Quassel-web http webui"}
  - {external_port: "64443", internal_port: "64443", port_desc: "Quassel-web https webui"}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  By default this container webui will be available on `https://$SERVER_IP:64443`. To setup this container you can either use the environment 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:

  ```text
  /config/settings-user.js
  ```
# init diagram
init_diagram: |
  "quassel-web:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-os-end -> init-config
    init-config -> init-config-end
    init-quassel-web-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    init-config-end -> init-deprecate
    base -> init-envfile
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    base -> init-os-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-config -> init-quassel-web-config
    init-custom-files -> init-services
    init-deprecate -> init-services
    init-mods-end -> init-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-quassel-web
    svc-quassel-web -> legacy-services
  }
  Base Images: {
    "baseimage-alpine:3.20"
  }
  "quassel-web:latest" <- Base Images
# changelog
changelogs:
  - {date: "26.12.24:", desc: "Deprecate."}
  - {date: "25.05.24:", desc: "Rebase to Alpine 3.20."}
  - {date: "10.11.23:", desc: "Rebase to Alpine 3.18. Rename settings-user.js to .cjs to match upstream."}
  - {date: "06.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
  - {date: "13.02.23:", desc: "Rebasing to Alpine 3.17, migrate to s6v3."}
  - {date: "12.02.22:", desc: "Rebasing to alpine 3.15."}
  - {date: "01.06.20:", desc: "Rebasing to alpine 3.12."}
  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
  - {date: "18.05.19:", desc: "Reconfigure environmental variable setup."}
  - {date: "28.04.19:", desc: "Initial Release."}