Skip to content

Commit

Permalink
website/integrations: add The Lounge (#11971)
Browse files Browse the repository at this point in the history
* Add The Lounge Integration guide

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

* Add The Lounge to sidebar, fix Note section formatting

* Fix folder name (1/2)

* Fix folder name (2/2)

* Update website/integrations/services/thelounge/index.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

* Update website/integrations/services/thelounge/index.md

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

* Fix cutoff sentence

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

* Linter fixes

---------

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
  • Loading branch information
OddMagnet and tanberry authored Dec 4, 2024
1 parent d3a581b commit 695de45
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
48 changes: 48 additions & 0 deletions website/integrations/services/thelounge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Integrate with The Lounge
sidebar_label: The Lounge
---

# The Lounge

<span class="badge badge--secondary">Support level: Community</span>

## What is The Lounge

> The Lounge is a modern, web-based IRC (Internet Relay Chat) client that allows users to stay connected to IRC servers even when offline.
>
> -- https://thelounge.chat/
:::note
This guide assumes you already deployed an LDAP Provider, if not check [here](https://docs.goauthentik.io/docs/add-secure-apps/providers/ldap/generic_setup).
If you made any changes, e.g. using a different name for the user, make sure to apply them here as well.
:::

## Preparation

The following placeholders will be used:

- `authentik.company` is the FQDN of the authentik install.
- `dc=company,dc=com` the Base DN of the LDAP outpost. If you followed the LDAP provider guide this is: `dc=goauthentik,dc=io`
- `ldap_bind_user` the username of the desired LDAP Bind User. If you followed the LDAP provider guide this is: `ldapservice`

## LDAP Configuration

### authentik Configuration

Follow the [instructions](https://docs.goauthentik.io/docs/add-secure-apps/outposts/#create-and-configure-an-outpost) to create an LDAP outpost and configure access via the outpost. No additional authentik configuration needs to be configured.

### The Lounge configuration

In the `config.js` file find the `ldap` section and make the following changes:

1. Set `enable` to `true`
2. Set `url` to `ldap://authentik.company`
3. Set `primaryKey` to `cn`
4. In the `searchDN` section make the following changes:
1. Set `rootDN` to `cn=ldap_bind_user,ou=users,dc=company,dc=com`
2. Set `rootPassword` to the password you have given to the `ldap_bind_user`
3. Set `filter` to `(&(objectClass=user)`
1. Alternatively, if you want to restrict access by group, you can set it to: `(&(objectClass=user)(memberOf=cn=group_name,ou=groups,dc=ldap,dc=company,dc=com))`
4. Set `base` to `dc=ldap,dc=company,dc=com`
5. Finally, save the `config.js` file and restart The Lounge. You should be able to log in via LDAP now, as long as a user with the same name exists.
1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module.exports = {
"services/roundcube/index",
"services/sharepoint-se/index",
"services/slack/index",
"services/thelounge/index",
"services/vikunja/index",
"services/wekan/index",
"services/wiki-js/index",
Expand Down

0 comments on commit 695de45

Please sign in to comment.