Skip to content

Latest commit

 

History

History
190 lines (130 loc) · 5.22 KB

README.md

File metadata and controls

190 lines (130 loc) · 5.22 KB
Raw

Build Status License

Ansible role for The Lounge

Ansible role to install The Lounge, a self-hosted web IRC client.

What this role does:

Note that this playbook will also install esprima and jsonlint npm packages to check syntax of configuration files.

Configuration files for The Lounge and its users can be found at /etc/thelounge/.

Requirements

This role should be compatible with Ansible 2.6 or higher.

It was written for Debian and Ubuntu distributions.

Role variables

thelounge_debug

Sets debug mode for available keys (irc_framework and raw).

All keys of this variable default to false.

Example

thelounge_debug:
  irc_framework: true
  raw: true

thelounge_port

Sets the port that thelounge is listening on.

This variable defaults to 9000.

thelounge_prefetch

Enables or disables link and image prefetching for clients of this instance.

This variable defaults to false (change it to true for a better experience).

thelounge_reverse_proxy

Sets whether the server is behind a reverse proxy and should honor the X-Forwarded-For header or not.

This variable defaults to false (change it to true if The Lounge is running Nginx, etc.).

thelounge_theme

Sets the visual style to apply to The Lounge, among those offered with the software.

This variable defaults to example.

Example

# Options are: crypto, example (default), morning, zenburn
thelounge_theme: morning

thelounge_users

Lists all users allowed to access The Lounge using their credentials.

By default, no users are created.

Warning: At the moment, user configuration files are only created if they do not exist, so changing passwords does not get reflected when provisioning. Use the web interface (since v1.3.0) or the thelounge reset command to change passwords.

Example

thelounge_users:
  - user: WiZ
    hashed_password: $2a$04$g8xA7UYVGXwtMp1fJIyINerlXjzieA/lva9O3rUWV2KEpLTjhdVD6 # "password"
  - ...

Passwords are hashed using bcrypt. To generate a password using the bcryptjs npm package, run the following commands:

yarn add bcryptjs
 node node_modules/bcryptjs/bin/bcrypt "my password"

(Note that the bcrypt command is prefixed with a whitespace to not be saved in your bash history, if configured accordingly).

thelounge_version

Installs a specific version of The Lounge. It must be one of the official releases.

This variable defaults to the stable version mentioned at the top of this document.

Example

thelounge_version: "3.0.0-pre.1"

Example playbook

Go to the test playbook to see an example playbook using this role.

Development environment

Install Vagrant and VirtualBox using your favorite package manager and run:

vagrant up

This will spin up a minimal virtual machine and provision it with a test playbook using that role.

If that step succeeds, syntax of the role is correct and all tasks are successful on a bare machine. It does not test the specifics of the role however, that you need to check yourself by connecting to the VM:

vagrant ssh

To provision the virtual machine again, run the following:

vagrant up # Unnecessary if the VM is already running
vagrant provision

You should then be able to access The Lounge at http://localhost:9000/, and connect with the following test credentials:

  • Username: WiZ
  • Password: password

You can also run the tests against the VM with:

./tests/tests.sh

Lastly, once you are done with changes, you can run one of the following:

vagrant halt -f # Shuts down the VM for later re-use
vagrant destroy -f # Destroys the VM entirely

This role is backed by Travis CI. It uses the same test playbook to ensure that, for every push:

  • Syntax is correct
  • The role and playbook run fine
  • The role is idempotent (running it twice in a row results in un-changed states only)