Files
truecharts/charts/stable/lldap/docs/installation-notes.md
StevenMcElligott 45ef1cafb8 docs(lldap): Fix upstream link (#11701)
**Description**

Pulling in the fix from @depasseg on the `/website` repo
⚒️ 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

** App addition**

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

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ 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._
2023-08-19 20:07:03 +02:00

2.0 KiB

Installation notes

Default Configuration

LLDAP is configured using the default options generated by the application on first run. The exception to this is the 'Base DN for LDAP' option which has been exposed to the user.

By default, LLDAP will use the following options:

  • Base DN for LDAP: dc=example,dc=org

  • Ldap User DN: admin

  • Ldap User Email: admin@admin.com

  • Ldap User Password: password

  • Public URL: https://lldap.example.com

  • LDAP port: 3890

  • JWT secret: random (generated on first run)

  • Show SMTP Settings

    • Enable Password Reset: false
    • SMTP Server Url: smtp.gmail.com
    • SMTP Server Port: 587
    • SMTP Encryption: STARTTLS
    • SMTP User: email
    • SMTP Password: password | app password
    • SMTP From: LLDAP Admin sender@gmail.com
    • SMTP Reply To: Do not reply noreply@localhost

Usage

LLDAP can be used as the user backend for Authelia and Authentik as well as any other application that supports LDAP e.g. Jellyfin and Nextcloud. A specific guide for Authelia is available in this documentation but other authentication applications can be configured in a similar way.

When setting your bind user you should avoid using the admin user as this is a security risk. Instead, create a new user with the minimum permissions required for your application. LLDAP has a user group lldap_strict_readonly which can be used for this purpose. This group has read-only access to the LDAP database and can be used to create a new user with the minimum permissions required for your application. However, if you want to provide password reset then create a user in the lldap_password_manager group.

Support

  • If you need more details or have a more custom setup the documentation on the upstream is very useful so check the descriptions of the options there including example configs for various apps.
  • You can also reach us using Discord for real-time feedback and support

All Rights Reserved - The TrueCharts Project