befh/thelounge repository overview

The LinuxServer.io⁠ team brings you another container release featuring easy user mapping and community support. Find us for support at:

• forum.linuxserver.io⁠
• IRC⁠ on freenode at #linuxserver.io
• Podcast⁠ covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

⁠linuxserver/thelounge

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

What features does it have?

• Multiple user support
• Stays connected even when you close the browser
• Connect from multiple devices at once
• Responsive layout — works well on your smartphone
• .. and more!

⁠Usage

docker create \
  --name=thelounge \
  -v <path to data>:/config \
  -e PGID=<gid> -e PUID=<uid>  \
  -e TZ=<timezone> \
  -p 9000:9000 \
  linuxserver/thelounge

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

• -p 9000 - the port(s)
• -v /config - the configuration folder
• -e PGID for GroupID - see below for explanation
• -e PUID for UserID - see below for explanation
• -e TZ for timezone information, eg Europe/London

It is based on alpine linux with s6 overlay, for shell access whilst the container is running do docker exec -it thelounge /bin/bash.

⁠User / Group Identifiers

Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

⁠Setting up the application

To log in to the application, browse to https://:9000.

To setup user account(s)

• Edit /config/config.json changing the value public: true, to public: false,^†⁠ restart the container and enter the following from the command line of the host.

• docker exec -it thelounge node lounge add <user>

• Enter a password when prompted, refresh your browser.

• You should now be prompted for a password on the webinterface.

†⁠: You can run docker exec -it thelounge node lounge config to edit in vi or docker exec -it thelounge sed -i '' 's/\(public: \)true/\1false/g' /config/config.js to change it automatically.

⁠Changing settings

To further change settings, run docker exec -it thelounge node lounge <command> where the command is one of the following:

    config            Edit configuration file located at /config/config.js.
    list              List all users
    add <name>        Add a new user
    remove <name>     Remove an existing user
    reset <name>      Reset user password
    edit <name>       Edit user file located at /config/users/<name>.json.

Commands which edit configuration files use the vi text editor.

⁠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" }}' linuxserver/thelounge

⁠Versions

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