The Lounge¶

Description / name	Input element
Your domain name

Overview¶

The Lounge is a self-hosted web IRC client for the modern world.

Manual

Releases

Community

Deployment¶

sb install sandbox-thelounge

Usage¶

Visit https://thelounge.iYOUR_DOMAIN_NAMEi.

Basics¶

When the application first runs, it will populate its /config
Stop the container
Now from the host, edit /config/config.js, wherever you've mapped it
In most cases you want the value public: false to allow named users only
Setting the two prefetch values to true improves usability, but uses more storage
Once you have the configuration you want, save it and start the container again

For each user, run the command

  docker exec -it thelounge s6-setuidgid abc thelounge add <user>

You will be prompted to enter a password that will not be echoed.
Saving logs to disk is the default, this consumes more space but allows scrollback.
To log in to the application, browse to https://thelounge.iYOUR_DOMAIN_NAMEi
You should now be prompted for a username and password on the webinterface.
Once logged in, you can add an IRC network. Some defaults are preset for Freenode.

ZNC¶

To connect to znc, you need to have a znc server running. A guide to using The Lounge with ZNC can be found here

In this image we have a ZNC network defined.

To add this network to The Lounge, give it a Name, it does not have to match the ZNC network settings.
For the Server, use znc and set the port to 6502
For the Password, enter your ZNC user password
Uncheck `Use secure connection (TLS)
In the User Preferences section enter your Nick - I would recommend the same Nick as that set in ZNC.
For the user name enter the <ZNC username>/<ZNC_Network_Name>.
For Real Name, enter your desired <real_name> it does not need to match ZNC
Save the network, and it should connect to ZNC.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
thelounge_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like thelounge_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like thelounge_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

thelounge_name

# Type: string
thelounge_name: thelounge

thelounge_role_web_subdomain

# Type: string
thelounge_role_web_subdomain: "{{ thelounge_name }}"

thelounge_role_web_domain

# Type: string
thelounge_role_web_domain: "{{ user.domain }}"

thelounge_role_web_port

# Type: string
thelounge_role_web_port: "9000"

thelounge_role_web_url

# Type: string
thelounge_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='thelounge') + '.' + lookup('role_var', '_web_domain', role='thelounge')
                         if (lookup('role_var', '_web_subdomain', role='thelounge') | length > 0)
                         else lookup('role_var', '_web_domain', role='thelounge')) }}"

thelounge_role_dns_record

# Type: string
thelounge_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='thelounge') }}"

thelounge_role_dns_zone

# Type: string
thelounge_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='thelounge') }}"

thelounge_role_dns_proxy

# Type: bool (true/false)
thelounge_role_dns_proxy: "{{ dns_proxied }}"

thelounge_role_traefik_sso_middleware

# Type: string
thelounge_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

thelounge_role_traefik_middleware_default

# Type: string
thelounge_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

thelounge_role_traefik_middleware_custom

# Type: string
thelounge_role_traefik_middleware_custom: ""

thelounge_role_traefik_certresolver

# Type: string
thelounge_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

thelounge_role_traefik_enabled

# Type: bool (true/false)
thelounge_role_traefik_enabled: true

thelounge_role_traefik_api_enabled

# Type: bool (true/false)
thelounge_role_traefik_api_enabled: true

thelounge_role_traefik_api_endpoint

# Type: string
thelounge_role_traefik_api_endpoint: "PathPrefix(`/uploads`)"

Container

thelounge_role_docker_container

# Type: string
thelounge_role_docker_container: "{{ thelounge_name }}"

Image

thelounge_role_docker_image_pull

# Type: bool (true/false)
thelounge_role_docker_image_pull: true

thelounge_role_docker_image_repo

# Type: string
thelounge_role_docker_image_repo: "lscr.io/linuxserver/thelounge"

thelounge_role_docker_image_tag

# Type: string
thelounge_role_docker_image_tag: "latest"

thelounge_role_docker_image

# Type: string
thelounge_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='thelounge') }}:{{ lookup('role_var', '_docker_image_tag', role='thelounge') }}"

Envs

thelounge_role_docker_envs_default

# Type: dict
thelounge_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"

thelounge_role_docker_envs_custom

# Type: dict
thelounge_role_docker_envs_custom: {}

Volumes

thelounge_role_docker_volumes_default

# Type: list
thelounge_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='thelounge') }}:/config"

thelounge_role_docker_volumes_custom

# Type: list
thelounge_role_docker_volumes_custom: []

Hostname

thelounge_role_docker_hostname

# Type: string
thelounge_role_docker_hostname: "{{ thelounge_name }}"

Networks

thelounge_role_docker_networks_alias

# Type: string
thelounge_role_docker_networks_alias: "{{ thelounge_name }}"

thelounge_role_docker_networks_default

# Type: list
thelounge_role_docker_networks_default: []

thelounge_role_docker_networks_custom

# Type: list
thelounge_role_docker_networks_custom: []

Restart Policy

thelounge_role_docker_restart_policy

# Type: string
thelounge_role_docker_restart_policy: unless-stopped

State

thelounge_role_docker_state

# Type: string
thelounge_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

thelounge_role_docker_blkio_weight

# Type: int
thelounge_role_docker_blkio_weight:

thelounge_role_docker_cpu_period

# Type: int
thelounge_role_docker_cpu_period:

thelounge_role_docker_cpu_quota

# Type: int
thelounge_role_docker_cpu_quota:

thelounge_role_docker_cpu_shares

# Type: int
thelounge_role_docker_cpu_shares:

thelounge_role_docker_cpus

# Type: string
thelounge_role_docker_cpus:

thelounge_role_docker_cpuset_cpus

# Type: string
thelounge_role_docker_cpuset_cpus:

thelounge_role_docker_cpuset_mems

# Type: string
thelounge_role_docker_cpuset_mems:

thelounge_role_docker_kernel_memory

# Type: string
thelounge_role_docker_kernel_memory:

thelounge_role_docker_memory

# Type: string
thelounge_role_docker_memory:

thelounge_role_docker_memory_reservation

# Type: string
thelounge_role_docker_memory_reservation:

thelounge_role_docker_memory_swap

# Type: string
thelounge_role_docker_memory_swap:

thelounge_role_docker_memory_swappiness

# Type: int
thelounge_role_docker_memory_swappiness:

thelounge_role_docker_shm_size

# Type: string
thelounge_role_docker_shm_size:

Security & Devices

thelounge_role_docker_cap_drop

# Type: list
thelounge_role_docker_cap_drop:

thelounge_role_docker_cgroupns_mode

# Type: string
thelounge_role_docker_cgroupns_mode:

thelounge_role_docker_device_cgroup_rules

# Type: list
thelounge_role_docker_device_cgroup_rules:

thelounge_role_docker_device_read_bps

# Type: list
thelounge_role_docker_device_read_bps:

thelounge_role_docker_device_read_iops

# Type: list
thelounge_role_docker_device_read_iops:

thelounge_role_docker_device_requests

# Type: list
thelounge_role_docker_device_requests:

thelounge_role_docker_device_write_bps

# Type: list
thelounge_role_docker_device_write_bps:

thelounge_role_docker_device_write_iops

# Type: list
thelounge_role_docker_device_write_iops:

thelounge_role_docker_devices

# Type: list
thelounge_role_docker_devices:

thelounge_role_docker_devices_default

# Type: string
thelounge_role_docker_devices_default:

thelounge_role_docker_groups

# Type: list
thelounge_role_docker_groups:

thelounge_role_docker_privileged

# Type: bool (true/false)
thelounge_role_docker_privileged:

thelounge_role_docker_security_opts

# Type: list
thelounge_role_docker_security_opts:

thelounge_role_docker_user

# Type: string
thelounge_role_docker_user:

thelounge_role_docker_userns_mode

# Type: string
thelounge_role_docker_userns_mode:

Networking

thelounge_role_docker_dns_opts

# Type: list
thelounge_role_docker_dns_opts:

thelounge_role_docker_dns_search_domains

# Type: list
thelounge_role_docker_dns_search_domains:

thelounge_role_docker_dns_servers

# Type: list
thelounge_role_docker_dns_servers:

thelounge_role_docker_domainname

# Type: string
thelounge_role_docker_domainname:

thelounge_role_docker_exposed_ports

# Type: list
thelounge_role_docker_exposed_ports:

thelounge_role_docker_hosts

# Type: dict
thelounge_role_docker_hosts:

thelounge_role_docker_hosts_use_common

# Type: bool (true/false)
thelounge_role_docker_hosts_use_common:

thelounge_role_docker_ipc_mode

# Type: string
thelounge_role_docker_ipc_mode:

thelounge_role_docker_links

# Type: list
thelounge_role_docker_links:

thelounge_role_docker_network_mode

# Type: string
thelounge_role_docker_network_mode:

thelounge_role_docker_pid_mode

# Type: string
thelounge_role_docker_pid_mode:

thelounge_role_docker_ports

# Type: list
thelounge_role_docker_ports:

thelounge_role_docker_uts

# Type: string
thelounge_role_docker_uts:

Storage

thelounge_role_docker_keep_volumes

# Type: bool (true/false)
thelounge_role_docker_keep_volumes:

thelounge_role_docker_mounts

# Type: list
thelounge_role_docker_mounts:

thelounge_role_docker_storage_opts

# Type: dict
thelounge_role_docker_storage_opts:

thelounge_role_docker_tmpfs

# Type: list
thelounge_role_docker_tmpfs:

thelounge_role_docker_volume_driver

# Type: string
thelounge_role_docker_volume_driver:

thelounge_role_docker_volumes_from

# Type: list
thelounge_role_docker_volumes_from:

thelounge_role_docker_volumes_global

# Type: bool (true/false)
thelounge_role_docker_volumes_global:

thelounge_role_docker_working_dir

# Type: string
thelounge_role_docker_working_dir:

Monitoring & Lifecycle

thelounge_role_docker_auto_remove

# Type: bool (true/false)
thelounge_role_docker_auto_remove:

thelounge_role_docker_cleanup

# Type: bool (true/false)
thelounge_role_docker_cleanup:

thelounge_role_docker_force_kill

# Type: string
thelounge_role_docker_force_kill:

thelounge_role_docker_healthcheck

# Type: dict
thelounge_role_docker_healthcheck:

thelounge_role_docker_healthy_wait_timeout

# Type: int
thelounge_role_docker_healthy_wait_timeout:

thelounge_role_docker_init

# Type: bool (true/false)
thelounge_role_docker_init:

thelounge_role_docker_kill_signal

# Type: string
thelounge_role_docker_kill_signal:

thelounge_role_docker_log_driver

# Type: string
thelounge_role_docker_log_driver:

thelounge_role_docker_log_options

# Type: dict
thelounge_role_docker_log_options:

thelounge_role_docker_oom_killer

# Type: bool (true/false)
thelounge_role_docker_oom_killer:

thelounge_role_docker_oom_score_adj

# Type: int
thelounge_role_docker_oom_score_adj:

thelounge_role_docker_output_logs

# Type: bool (true/false)
thelounge_role_docker_output_logs:

thelounge_role_docker_paused

# Type: bool (true/false)
thelounge_role_docker_paused:

thelounge_role_docker_recreate

# Type: bool (true/false)
thelounge_role_docker_recreate:

thelounge_role_docker_restart_retries

# Type: int
thelounge_role_docker_restart_retries:

thelounge_role_docker_stop_timeout

# Type: int
thelounge_role_docker_stop_timeout:

Other Options

thelounge_role_docker_capabilities

# Type: list
thelounge_role_docker_capabilities:

thelounge_role_docker_cgroup_parent

# Type: string
thelounge_role_docker_cgroup_parent:

thelounge_role_docker_commands

# Type: list
thelounge_role_docker_commands:

thelounge_role_docker_create_timeout

# Type: int
thelounge_role_docker_create_timeout:

thelounge_role_docker_entrypoint

# Type: string
thelounge_role_docker_entrypoint:

thelounge_role_docker_env_file

# Type: string
thelounge_role_docker_env_file:

thelounge_role_docker_labels

# Type: dict
thelounge_role_docker_labels:

thelounge_role_docker_labels_use_common

# Type: bool (true/false)
thelounge_role_docker_labels_use_common:

thelounge_role_docker_read_only

# Type: bool (true/false)
thelounge_role_docker_read_only:

thelounge_role_docker_runtime

# Type: string
thelounge_role_docker_runtime:

thelounge_role_docker_sysctls

# Type: list
thelounge_role_docker_sysctls:

thelounge_role_docker_ulimits

# Type: list
thelounge_role_docker_ulimits:

thelounge_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
thelounge_role_autoheal_enabled: true

thelounge_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
thelounge_role_depends_on: ""

thelounge_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
thelounge_role_depends_on_delay: "0"

thelounge_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
thelounge_role_depends_on_healthchecks:

thelounge_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
thelounge_role_diun_enabled: true

thelounge_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
thelounge_role_dns_enabled: true

thelounge_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
thelounge_role_docker_controller: true

thelounge_role_docker_image_repo

# Type: string
thelounge_role_docker_image_repo:

thelounge_role_docker_image_tag

# Type: string
thelounge_role_docker_image_tag:

thelounge_role_docker_volumes_download

# Type: bool (true/false)
thelounge_role_docker_volumes_download:

thelounge_role_paths_location

# Type: string
thelounge_role_paths_location:

thelounge_role_themepark_addons

# Type: string
thelounge_role_themepark_addons:

thelounge_role_themepark_app

# Type: string
thelounge_role_themepark_app:

thelounge_role_themepark_theme

# Type: string
thelounge_role_themepark_theme:

thelounge_role_traefik_api_endpoint

# Type: dict/omit
thelounge_role_traefik_api_endpoint:

thelounge_role_traefik_api_middleware

# Type: string
thelounge_role_traefik_api_middleware:

thelounge_role_traefik_api_middleware_http

# Type: string
thelounge_role_traefik_api_middleware_http:

thelounge_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
thelounge_role_traefik_autodetect_enabled: false

thelounge_role_traefik_certresolver

# Type: string
thelounge_role_traefik_certresolver:

thelounge_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
thelounge_role_traefik_crowdsec_enabled: false

thelounge_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
thelounge_role_traefik_error_pages_enabled: false

thelounge_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
thelounge_role_traefik_gzip_enabled: false

thelounge_role_traefik_middleware_http

# Type: string
thelounge_role_traefik_middleware_http:

thelounge_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
thelounge_role_traefik_middleware_http_api_insecure:

thelounge_role_traefik_middleware_http_insecure

# Type: bool (true/false)
thelounge_role_traefik_middleware_http_insecure:

thelounge_role_traefik_priority

# Type: string
thelounge_role_traefik_priority:

thelounge_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
thelounge_role_traefik_robot_enabled: true

thelounge_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
thelounge_role_traefik_tailscale_enabled: false

thelounge_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
thelounge_role_traefik_wildcard_enabled: true

thelounge_role_web_domain

# Type: string
thelounge_role_web_domain:

thelounge_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
thelounge_role_web_fqdn_override:

Example Override

thelounge_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "thelounge2.{{ user.domain }}"
  - "thelounge.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

thelounge_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
thelounge_role_web_host_override:

Example Override

thelounge_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'thelounge2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

thelounge_role_web_http_port

# Type: string (quoted number)
thelounge_role_web_http_port:

thelounge_role_web_http_scheme

# Type: string ("http"/"https")
thelounge_role_web_http_scheme:

thelounge_role_web_http_serverstransport

# Type: dict/omit
thelounge_role_web_http_serverstransport:

thelounge_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
thelounge_role_web_scheme:

thelounge_role_web_serverstransport

# Type: dict/omit
thelounge_role_web_serverstransport:

thelounge_role_web_subdomain

# Type: string
thelounge_role_web_subdomain: