fix(lldap) add tooltips and update docs (#11631)

**Description**
Add tooltips and update docs.
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [X] 🔃 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:**

- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [X] 📄 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
- [X] ⬆️ 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._
This commit is contained in:
Xstar97TheNoob
2023-08-18 03:32:10 -04:00
committed by GitHub
parent c6d05076fa
commit 55aeafa687
3 changed files with 21 additions and 2 deletions
+1 -1
View File
@@ -23,7 +23,7 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/lldap
- https://github.com/nitnelave/lldap
type: application
version: 2.0.0
version: 2.0.1
annotations:
truecharts.org/catagories: |
- ldap
@@ -7,9 +7,23 @@ LLDAP is configured using the default options generated by the application on fi
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.
+6 -1
View File
@@ -18,24 +18,28 @@ questions:
attrs:
- variable: LLDAP_LDAP_BASE_DN
label: "LDAP Base DN"
description: "A domain entry within an Lldap directory."
schema:
type: string
required: true
default: "dc=example,dc=com"
- variable: LLDAP_LDAP_USER_DN
label: "Ldap User DN"
description: "The Ldap user for the default auth."
schema:
type: string
required: true
default: ""
- variable: LLDAP_LDAP_USER_EMAIL
label: "Ldap User Email"
description: "The Ldap user email for the default auth."
schema:
type: string
required: true
default: ""
- variable: LLDAP_LDAP_USER_PASS
label: "Ldap User Password"
description: "The Ldap user password for the default auth."
schema:
type: string
required: true
@@ -44,6 +48,7 @@ questions:
min_length: 8
- variable: LLDAP_HTTP_URL
label: "Public URL"
description: "A valid and public FQDN domain, ex https://lldap.example.com or http://IP:PORT"
schema:
type: string
required: true
@@ -104,7 +109,7 @@ questions:
type: string
default: "LLDAP Admin <sender@gmail.com>"
- variable: LLDAP_SMTP_OPTIONS__REPLY_TO
label: SMTP Reply TO
label: SMTP Reply To
schema:
type: string
default: "Do not reply <noreply@localhost>"