From 796ab587dbde8b7d528c7ad78f2f2dc9b4bac7fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Br=C3=BCnen?= <34708235+OddMagnet@users.noreply.github.com> Date: Fri, 8 Nov 2024 19:27:40 +0100 Subject: [PATCH 1/7] Add The Lounge Integration guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com> --- .../integrations/services/TheLounge/index.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 website/integrations/services/TheLounge/index.md diff --git a/website/integrations/services/TheLounge/index.md b/website/integrations/services/TheLounge/index.md new file mode 100644 index 000000000000..8ad1246b52ac --- /dev/null +++ b/website/integrations/services/TheLounge/index.md @@ -0,0 +1,46 @@ +--- +title: Integrate with The Lounge +sidebar_label: The Lounge +--- + +# The Lounge + +Support level: Community + +## 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 follwed 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 + +No additional authentik configuration needs to be configured. Follow the LDAP outpost instructions to create an LDAP outpost and configure access via the outpost + +### 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 From 75b480f32de77c959dcb9bfe5945321a2bdecc70 Mon Sep 17 00:00:00 2001 From: OddMagnet Date: Wed, 20 Nov 2024 14:31:41 +0100 Subject: [PATCH 2/7] Add The Lounge to sidebar, fix Note section formatting --- website/integrations/services/TheLounge/index.md | 12 +++++++----- website/sidebarsIntegrations.js | 1 + 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/website/integrations/services/TheLounge/index.md b/website/integrations/services/TheLounge/index.md index 8ad1246b52ac..b5f5cc27121d 100644 --- a/website/integrations/services/TheLounge/index.md +++ b/website/integrations/services/TheLounge/index.md @@ -13,15 +13,17 @@ sidebar_label: The Lounge > > -- 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. ::: +:::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 follwed the LDAP provider guide this is: `dc=goauthentik,dc=io` +- `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 @@ -41,6 +43,6 @@ In the `config.js` file find the `ldap` section and 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))` + 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 +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 diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 39d1c0dca54d..d97f5698abeb 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -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", From 24cb8d1bd94f1e8e01941fae0cc1b42a66154d3f Mon Sep 17 00:00:00 2001 From: OddMagnet Date: Wed, 20 Nov 2024 17:31:05 +0100 Subject: [PATCH 3/7] Fix folder name (1/2) --- website/integrations/services/{TheLounge => TheLounge_}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename website/integrations/services/{TheLounge => TheLounge_}/index.md (100%) diff --git a/website/integrations/services/TheLounge/index.md b/website/integrations/services/TheLounge_/index.md similarity index 100% rename from website/integrations/services/TheLounge/index.md rename to website/integrations/services/TheLounge_/index.md From 2cc7d50eed29f76dde821d6766b93fe6f15173e6 Mon Sep 17 00:00:00 2001 From: OddMagnet Date: Wed, 20 Nov 2024 17:31:27 +0100 Subject: [PATCH 4/7] Fix folder name (2/2) --- website/integrations/services/{TheLounge_ => thelounge}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename website/integrations/services/{TheLounge_ => thelounge}/index.md (100%) diff --git a/website/integrations/services/TheLounge_/index.md b/website/integrations/services/thelounge/index.md similarity index 100% rename from website/integrations/services/TheLounge_/index.md rename to website/integrations/services/thelounge/index.md From fb289e4f7382adc7304ca826db8052e57b23fdc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Br=C3=BCnen?= <34708235+OddMagnet@users.noreply.github.com> Date: Thu, 21 Nov 2024 07:39:01 +0100 Subject: [PATCH 5/7] Update website/integrations/services/thelounge/index.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tana M Berry Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com> --- website/integrations/services/thelounge/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/thelounge/index.md b/website/integrations/services/thelounge/index.md index b5f5cc27121d..fca2f7c312c5 100644 --- a/website/integrations/services/thelounge/index.md +++ b/website/integrations/services/thelounge/index.md @@ -30,7 +30,7 @@ The following placeholders will be used: ### Authentik Configuration -No additional authentik configuration needs to be configured. Follow the LDAP outpost instructions to create an LDAP outpost and configure access via the outpost +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 From 5a5f399c83aec5e2bdb50b1d02f10276a8320d35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Br=C3=BCnen?= <34708235+OddMagnet@users.noreply.github.com> Date: Thu, 21 Nov 2024 07:39:11 +0100 Subject: [PATCH 6/7] Update website/integrations/services/thelounge/index.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tana M Berry Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com> --- website/integrations/services/thelounge/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/thelounge/index.md b/website/integrations/services/thelounge/index.md index fca2f7c312c5..01456bdef8cf 100644 --- a/website/integrations/services/thelounge/index.md +++ b/website/integrations/services/thelounge/index.md @@ -28,7 +28,7 @@ The following placeholders will be used: ## LDAP Configuration -### Authentik 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. From 5ea7e232fdf90d0c746d4871b1583ad66e347e9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Br=C3=BCnen?= <34708235+OddMagnet@users.noreply.github.com> Date: Thu, 21 Nov 2024 07:41:13 +0100 Subject: [PATCH 7/7] Fix cutoff sentence MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com> --- website/integrations/services/thelounge/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/integrations/services/thelounge/index.md b/website/integrations/services/thelounge/index.md index 01456bdef8cf..620a8f60ed61 100644 --- a/website/integrations/services/thelounge/index.md +++ b/website/integrations/services/thelounge/index.md @@ -45,4 +45,4 @@ In the `config.js` file find the `ldap` section and make the following changes: 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 +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.