From 55aeafa687d29ad9650defcd7b51a385a2f4f1c3 Mon Sep 17 00:00:00 2001 From: Xstar97TheNoob <9399967+xstar97@users.noreply.github.com> Date: Fri, 18 Aug 2023 03:32:10 -0400 Subject: [PATCH] fix(lldap) add tooltips and update docs (#11631) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Add tooltips and update docs. ⚒️ Fixes # **⚙️ 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?** **📃 Notes:** **✔️ 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._ --- charts/stable/lldap/Chart.yaml | 2 +- charts/stable/lldap/docs/installation-notes.md | 14 ++++++++++++++ charts/stable/lldap/questions.yaml | 7 ++++++- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/charts/stable/lldap/Chart.yaml b/charts/stable/lldap/Chart.yaml index d7ec702efee..ca475e0d58e 100644 --- a/charts/stable/lldap/Chart.yaml +++ b/charts/stable/lldap/Chart.yaml @@ -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 diff --git a/charts/stable/lldap/docs/installation-notes.md b/charts/stable/lldap/docs/installation-notes.md index 4997bb4318c..7e88d899a46 100644 --- a/charts/stable/lldap/docs/installation-notes.md +++ b/charts/stable/lldap/docs/installation-notes.md @@ -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: - 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 + - SMTP Reply To: Do not reply + ## 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. diff --git a/charts/stable/lldap/questions.yaml b/charts/stable/lldap/questions.yaml index fdb57e89d2f..f3556596d71 100644 --- a/charts/stable/lldap/questions.yaml +++ b/charts/stable/lldap/questions.yaml @@ -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 " - variable: LLDAP_SMTP_OPTIONS__REPLY_TO - label: SMTP Reply TO + label: SMTP Reply To schema: type: string default: "Do not reply "