Search results

Edit on GitHub

Usage

Once The Lounge is installed, a program called thelounge is now available.

Command line help

To get general information about the program and an overview of the available commands, use the --help (or -h) option:

thelounge --help

To get specific help for a given command, run:

thelounge <command> --help

For example, to know how to use thelounge start and the options available, run:

thelounge start --help

If you need to check which version of The Lounge is installed, use:

thelounge version

Starting the server

To start the server, run the following command:

thelounge start

This will start a server and display something along the lines of:

Configuration file created at /etc/thelounge/config.js.
The Lounge v3.0.0 (Node.js 8.9.2 on linux x64)
Configuration file: /etc/thelounge/config.js
Available at http://:::9000/ in private mode
There are currently no users. Create one with thelounge add <name>.

This tells us a few things:

  • Since it is the first time The Lounge runs, a configuration file was created. Its location depends on how The Lounge was installed (see the installation page).
  • The Lounge can now be accessed at http://localhost:9000/.
  • It has started in private mode, which means only users who have an account can log in. There is no guest access.
  • There are no user accounts as of yet, so in fact, no one can log in for now (see the user management page).

The process can be stopped at any time by hitting Ctrl+C. This will effectively close all connections to remote IRC servers that users are connected to.

Specifying a different configuration file

It can be useful to provide a different location for the configuration file. For example, you might want to store it on another partition, or you might want to run multiple instances with different configurations.

To do so, use the environment variable called THELOUNGE_HOME. It will instruct a location where The Lounge will look for the configuration file, the available users, etc.

For example, to start a server with a configuration located at /tmp/config.js, run:

THELOUNGE_HOME=/tmp thelounge start

Installing additional themes

A list of all available themes can be found on the npm registry. To install a theme called thelounge-theme-foo, run:

thelounge install thelounge-theme-foo

After restarting The Lounge, the theme will now be available in the client settings.

Additionally, any theme can be used as the default one for all clients. See the theme section on the configuration page for more information.

Configuring The Lounge

As shown above, The Lounge starts by default in private mode on port 9000.

To change the mode or port quickly, the --config (or -c) option can be used.

For example, to start The Lounge on port 9001, run:

thelounge start --config port=9001

Similarly, to start it in public mode, run:

thelounge start --config public=true

This option can be specified multiple times to match the requested configuration:

thelounge start -c port=9001 -c public=true

However, --config is not limited to setting the port or mode. In fact, any option available in the configuration file can be passed using --config. See the configuration page for a full list.

A few rules apply to the --config option:

  • Nested objects require using a dot-notation. For example:
    thelounge -c debug.raw=true
    
  • Lists of values must be wrapped with []. For example:
    thelounge -c transports=[websocket,polling]
    
  • If a value has a whitespace, it must be wrapped in quotes. For example:
    thelounge -c logs.format="DD MMMM YYYY HH:mm:ss"