README.md

Docker image for The Lounge, a modern web IRC client designed for self-hosting

Website • Docs • Demo

---

Overview

• Modern features brought to IRC. Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
• Always connected. Remains connected to IRC servers while you are offline.
• Cross platform. It doesn't matter what OS you use, it just works wherever Node.js runs.
• Responsive interface. The client works smoothly on every desktop, smartphone and tablet.
• Synchronized experience. Always resume where you left off no matter what device.

To learn more about configuration, usage and features of The Lounge, take a look at the website.

Registries

Images are available in the following registries:

• ghcr.io: ghcr.io/thelounge/thelounge
• DockerHub: thelounge/thelounge

Running a container

One can get started quickly by using the example docker-compose.yml file. What is docker-compose?

$ docker-compose up --detach

or starting a container manually:

$ docker run --detach \
             --name thelounge \
             --publish 9000:9000 \
             --volume ~/.thelounge:/var/opt/thelounge \
             --restart always \
             ghcr.io/thelounge/thelounge:latest

Executing commands in the container

Due to the way root permissions are dropped in the container, it's highly recommended to pass the --user node argument to any commands you execute in the container via Docker to ensure that file permissions retain the correct owner, like so:

$ docker exec --user node -it [container_name] thelounge add MyUser

Configuring identd

Since root permissions are dropped in the container the default port 113 can not be used as it is within the priviliged port range. Instead, use a higher port in your The Lounge identd configuration and map it back to 113 on your host system, for example like so:

$ docker run --detach \
             --name thelounge \
             --publish 113:9001 \
             --publish 9000:9000 \
             --volume ~/.thelounge:/var/opt/thelounge \
             --restart always \
             ghcr.io/thelounge/thelounge:latest

Refer to the identd / oidentd docs for more detailed information.

Data directory

The Lounge reads and stores all of its configuration, logs and other data at /var/opt/thelounge.

By default, The Lounge will run using the node (1000:1000) system user in the container, leading to mounted data directories on the host system being owned by said user. This is customizable by changing the container user (see Container user (advanced usage)).

You will probably want to persist the data at this location by using one of the means to do so.

Adding users

Users can be added as follows:

$ docker exec --user node -it [container_name] thelounge add [username]

Note: without persisting data, added users will be lost when the container is removed.

Changing the port that The Lounge will be available on

To change the port which The Lounge will be available on, one will have to change the host port in the port mapping. To make The Lounge available on e.g. port 5000:

$ docker run --detach \
             --name thelounge \
             --publish 5000:9000 \ # Change host port to listen on port 5000
             --volume ~/.thelounge:/var/opt/thelounge \
             --restart always \
             ghcr.io/thelounge/thelounge:latest

Container user (advanced usage)

By default, The Lounge will run using the node (1000:1000) user. This is customizable by running the container as a different, non-root, user. Beware that this may cause permission issues when a container process tries reading from the data disk unless you have manually set the permissions correctly.

Also keep in mind that whenever executing one-off commands in the container you need to explicitly set the correct user.