Search results

Edit on GitHub

Install and upgrade

Debian and Ubuntu based distributions

First, make sure Node.js v4 or more recent is installed with node --version. If not, follow the instructions given on the official documentation.

Then download thelounge.deb located at the bottom of the latest release.

Finally, open a terminal and install the downloaded package using:

sudo dpkg --install thelounge.deb

This also sets up a systemd service, enabled during the install, that you can control with systemctl status|start|restart|stop|....

The Lounge is now up and running in private mode at http://localhost:9000.

Its configuration file is located at /etc/thelounge/config.js. To configure The Lounge, go to the configuration section.

To upgrade The Lounge, simply follow these steps again after downloading a new thelounge.deb file, and restart the service.

You might want to serve The Lounge behind a reverse proxy such as Nginx. To know more about the benefits and steps, follow the guide on reverse proxies .

Arch Linux

The Lounge is available in the AUR.

Please follow the Arch Linux documentation to install this package from the AUR. For example, to install it using an AUR helper:

pacaur -aS thelounge
yaourt -aS thelounge

Then enable and start the thelounge.service unit using:

systemctl enable --now thelounge.service

The Lounge is now up and running in private mode at http://localhost:9000.

The package provides both a system and a user service to allow you to run The Lounge as your liking. Simply build and install the AUR package, and start the service:

  • System: systemctl start thelounge.service. The configuration is stored in /etc/thelounge/config.jsand runs as thelounge user.
  • User: systemctl --user start thelounge.service. The configuration is stored in your home directory in ~/.lounge/config.js.

To configure The Lounge, go to the configuration section.

You might want to serve The Lounge behind a reverse proxy such as Nginx. To know more about the benefits and steps, follow the guide on reverse proxies.

From npm releases

Installing the npm package directly allows you to use stable releases on systems where we do not provide native packages.

First, make sure Node.js v4 or more recent is installed with node --version, as well as npm. If not, follow the instructions given on the official documentation by choosing your distribution in the list.

Then install The Lounge using:

[sudo] npm --global install thelounge

Start the server manually using:

thelounge start

The Lounge is now up and running in private mode at http://localhost:9000.

Read more about how to use The Lounge from the command line in the CLI usage section.

Its configuration file is located at ~/.thelounge/config.js. To configure The Lounge, go to the configuration section.

To upgrade The Lounge, simply re-run the install command above, and restart it.

You might want to serve The Lounge behind a reverse proxy such as Nginx. To know more about the benefits and steps, follow the guide on reverse proxies .

Docker

Official Docker images of The Lounge are made available for every new release on DockerHub.

To run a container using Docker Compose, use this example docker-compose.yml file and run:

docker-compose up --detach

Otherwise, run:

docker run --detach \
	--name thelounge \
	--publish 9000:9000 \
	--volume ~/.thelounge:/home/thelounge/data \
	--restart always \
	thelounge/thelounge:latest

For more details about using The Lounge with Docker, refer to the official repository.

Running from source

Running The Lounge from source ensures you are running the most recent codebase.

First, make sure Node.js v4 or more recent is installed with node --version, as well as. If not, follow the instructions given on the official documentation by choosing your distribution in the list.

The following commands install the development version of The Lounge:

git clone https://github.com/thelounge/lounge
cd lounge
npm install
NODE_ENV=production npm run build
npm link

Start the server manually using:

thelounge start

The Lounge is now up and running in private mode at http://localhost:9000.

Read more about how to use The Lounge from the command line in the CLI usage section.

Its configuration file is located at ~/.thelounge/config.js. To configure The Lounge, go to the configuration section.

To upgrade The Lounge, simply git pull the repository, re-run the install and build commands above, and restart it.

You might want to serve The Lounge behind a reverse proxy such as Nginx. To know more about the benefits and steps, follow the guide on reverse proxies .

Unofficial install methods

Over time, people have come up with recipes to install The Lounge on different setups and platforms, with different tooling, etc. These are not officially supported (even when hosted on this website), so use them at your own risk:

Services packaging The Lounge

These services offer The Lounge as part of their app stores. We do not have any control or responsibility over them, but they usually require little configuration to get up and running:

Bytesized Hosting logo Cloudron logo Franz logo Rambox logo

Please contact these service providers directly if you have any questions or encounter any issues on these platforms.