TheLounge#

TheLounge is a web based IRC client that syncs nicely across devices, and stays online when you aren't.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling thelounge#

Command:#

vlab set thelounge.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
enable: True

Finalising changes:#

run: vlab update_one service=thelounge

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

To turn TheLounge from a public instance to a private (highly recommended) run the following commands on your server. Run sed -i 's/public: true/public: false/' /home/root/vivumlab/thelounge/config.js, then restart the container with docker restart vivumlab_thelounge_1, then create a user with docker exec -it vivumlab_thelounge_1 thelounge add <username> and follow the prompts.

Now you should be able to login with the username and password you created at the URLs below, and have your session automatically sync between multiple devices.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=thelounge to complete the changes

ACCESS#

thelounge (HTTPS) link: https://thelounge.vivumlab.xyz/ thelounge (HTTP) link: http://thelounge.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set thelounge.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
https_only: True
Finalising changes:#

run: vlab update_one service=thelounge

AUTH#

Default: False
Options: True/False

Command:#

vlab set thelounge.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
auth: True
Finalising changes:#

run: vlab update_one service=thelounge

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set thelounge.domain thelounge.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
domain: thelounge.com
Finalising changes:#

run: vlab update_one service=thelounge

SUBDOMAIN#

Default: thelounge
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set thelounge.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
subdomain: media
Finalising changes:#

run: vlab update_one service=thelounge

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set thelounge.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

thelounge
version: 2.7
Finalising changes:#

run: vlab update_one service=thelounge

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.