Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3.78 KB

README.md

File metadata and controls

78 lines (52 loc) · 3.78 KB

The Lounge

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

Website • Docs • Demo

#thelounge IRC channel on freenode" Total pulls on Docker Total stars on Docker

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.

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 \
             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.