thelounge-docker/README.md

Docker container for The Lounge, 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.

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 \
             thelounge/thelounge:latest

Data directory

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

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 -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 \
             thelounge/thelounge:3.0.0-pre.7

Environment variables (advanced usage)

You can control how The Lounge is started through the following environment variables;

• HOST (equivalent to the -c host CLI option)
• PORT (equivalent to the -c port CLI option)
• BIND (equivalent to the -c bind CLI option)