linuxserver/thelounge ¶

Thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server.

Supported Architectures¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/thelounge:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Version Tags¶

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable releases.
next	✅	Next Pre-Releases.
nightly	✅	Nightly images from commits in master.

Application Setup¶

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 http://<hostip>:9000
You should now be prompted for a username and password on the web interface.
Once logged in, you can add an IRC network. Some defaults are preset for Freenode

Read-Only Operation¶

This image can be run with a read-only container filesystem. For details please read the docs.

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)¶

---
services:
  thelounge:
    image: lscr.io/linuxserver/thelounge:latest
    container_name: thelounge
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/thelounge/config:/config
    ports:
      - 9000:9000
    restart: unless-stopped

docker cli (click here for more info)¶

docker run -d \
  --name=thelounge \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 9000:9000 \
  -v /path/to/thelounge/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/thelounge:latest

Parameters¶

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (`-p`)¶

Parameter	Function
`9000:9000`	Application WebUI

Environment Variables (`-e`)¶

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.

Volume Mappings (`-v`)¶

Volume	Function
`/config`	Persistent config files

Miscellaneous Options¶

Parameter	Function
`--read-only=true`	Run container with a read-only filesystem. Please read the docs.

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers¶

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info¶

Shell access whilst the container is running:
```
docker exec -it thelounge /bin/bash
```
To monitor the logs of the container in realtime:
```
docker logs -f thelounge
```

Container version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge

Image version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/thelounge:latest

Updating Info¶

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull thelounge
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d thelounge
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/thelounge:latest

Stop the running container:
```
docker stop thelounge
```
Delete the container:
```
docker rm thelounge
```
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
```
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-thelounge.git
cd docker-thelounge
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/thelounge:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

To help with development, we generate this dependency graph.

Init dependency graph

Versions¶

06.06.24: - Rebase to Alpine 3.20.
23.12.23: - Rebase to Alpine 3.19.
25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
18.12.22: - Rebasing master to alpine 3.17.
24.10.22: - Fix sqlite3 build.
12.04.22: - Install from source using yarn.
11.04.22: - Rebasing to alpine 3.15 and switching from python2-dev to python3-dev for building node sqlite on arm.
23.01.21: - Rebasing to alpine 3.13.
02.06.20: - Rebasing to alpine 3.12.
19.12.19: - Rebasing to alpine 3.11.
28.06.19: - Rebasing to alpine 3.10.
15.05.19: - Update Arm variant images to build sqlite3 module.
23.03.19: - Switching to new Base images, shift to arm32v7 tag.
22.02.19: - Rebasing to alpine 3.9.
28.01.19: - Add pipeline logic and multi arch.
25.08.18: - Use global install, simplifies adding users.
20.08.18: - Rebase to alpine 3.8.
06.01.18: - Rebase to alpine 3.7.
26.05.17: - Rebase to alpine 3.6.
06.02.17: - Rebase to alpine 3.5.
14.10.16: - Bump to pickup 2.10 release.
14.10.16: - Add version layer information.
11.09.16: - Add layer badges to README.
31.08.16: - Initial Release.

linuxserver/thelounge¶