truecharts/charts/stable/lldap/docs/authelia.md at 0cd63e8dc5f953652eaa899daebdfdcd8447fe2f

Files

T

Kjeld Schouten 0cd63e8dc5 chore(docs/ci): ensure docs and ci reflect new train names (#19211 )

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):` or `chore(chart-name):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

2024-03-16 11:47:30 +01:00

3.5 KiB

Raw Blame History

title

title
Authelia Setup

Authelia which is available in the premium train can act as the authentication provider for your apps and services either through OAuth or forward authentication. LLDAP can be used to manage your Authelia users and groups. To enable this as an option follow the steps outlined below. References to the specific questions as they appear in the TrueNAS SCALE UI are included in the guide and highlighted along with the answers you should use. Authelia is the recommended authentication provider for TrueCharts however you can use any other provider you wish for Authentik is available in the Stable train.

This guide has been written as LLDAP has specific requirements for the LDAP setup of Authelia. If you are using another LDAP provider you will need to follow the setup instructions for that provider.

Disclaimer: This guide only covers the LDAP setup of Authelia. Refer to other guides for the remaining setup of Authelia.

Setup instructions

Tick the box for LDAP backend configuration a further set of questions will then appear.
The dropdown Implementation should be set as custom
URL should be set to internally link back to your LLDAP instance for the default configuration it should look something like this, ldap://lldap-ldap.ix-lldap.svc.cluster.local:3890. This will need to be adapted if you have named LLDAP differently or used a different port for LDAP.
Next, set the Base DN. This is one of the configurable options you set when installing LLDAP, which by default is dc=example,dc=com and should be adapted to your domain if set.
The Username Attribute should be set to uid.
The Additional Users DN should be set to ou=people, as this is where all your users are stored.
The users filter can be set to one of two options depending on whether you want to allow sign-in with a username or both username and email. Both options are outlined below.

Username only
```
(&({username_attribute}={input})(objectClass=person))
```
Username and email
```
(&(|({username_attribute}={input})({mail_attribute}={input}))(objectClass=person))
```
The next option that needs setting is Additional Groups DN. It must be set to ou=groups, as this is where all your groups are stored.
LLDAP only supports only one filter, which should be set in Groups Filter and set to (member={dn}).
The Group name Attribute should be set to cn.
The Mail Attribute should simply be set to mail.
The Display Name Attribute should be set to displayName. This is the attribute that Authelia will use to greet users when they log in.
Admin user is the default admin user used when setting up LLDAP initially and is auto-generated for you. The entry you input into this box should look something like the one below. Change dc=example,dc=com to match the Base DN you set earlier.

Admin user
```
uid=admin,ou=people,dc=example,dc=com
```
Enter the admin user password into the Password field. As stated earlier, DO NOT use the default password.

References

The origin material for this guide is available on the LLDAP Github. While further information on Authelia can be found on their Github and website.

Support

If you have any issues with following this guide, we can be reached using Discord for real-time feedback and support.

3.5 KiB Raw Blame History

Setup instructions

References

Support

3.5 KiB

Raw Blame History