fix(joplin-server) add docs (#4313)

* fix(joplin-server) add docs

* fix commons + postgres

* bump version

* Update charts/stable/joplin-server/docs/installation_notes.md

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

charts/stable/joplin-server/Chart.yaml

@@ -1,19 +1,5 @@
 apiVersion: v2
 appVersion: "2.9.5"
-description: This server allows you to sync any Joplin client
-name: joplin-server
-version: 8.1.9
-kubeVersion: ">=1.16.0-0"
-keywords:
-  - joplin
-  - notes
-home: https://truecharts.org/docs/charts/stable/joplin-server
-icon: https://truecharts.org/img/hotlink-ok/chart-icons/joplin-server.png
-sources:
-  - https://github.com/truecharts/charts/tree/master/charts/stable/joplin-server
-  - https://github.com/laurent22/joplin/tree/dev/packages/server
-  - https://github.com/laurent22/joplin
-  - https://hub.docker.com/r/joplin/server
 dependencies:
   - name: common
     repository: https://library-charts.truecharts.org
@@ -22,10 +8,26 @@ dependencies:
     name: postgresql
     repository: https://charts.truecharts.org/
     version: 8.0.118
+deprecated: false
+description: Allows you to sync any Joplin client.
+home: https://truecharts.org/docs/charts/stable/joplin-server
+icon: https://truecharts.org/img/hotlink-ok/chart-icons/joplin-server.png
+keywords:
+  - joplin
+  - notes
+kubeVersion: ">=1.16.0-0"
 maintainers:
   - email: info@truecharts.org
     name: TrueCharts
     url: https://truecharts.org
+name: joplin
+sources:
+  - https://github.com/truecharts/charts/tree/master/charts/stable/joplin-server
+  - https://github.com/laurent22/joplin/tree/dev/packages/server
+  - https://github.com/laurent22/joplin
+  - https://hub.docker.com/r/joplin/server
+type: application
+version: 8.1.10
 annotations:
   truecharts.org/catagories: |
     - media

charts/stable/joplin-server/docs/installation_notes.md

@@ -0,0 +1,23 @@
+# Installation Notes
+
+- To set the variable `App Base Url` correctly:
+  - If you are accessing it _without_ ingress/domain -> `http://IP:PORT`.
+  - If ingress is enabled, set it to `https://app.mydomain.tld:443`.
+  - No matter which option you choose it **must** end with the correct `:PORT`.
+
+---
+
+- To enable the `mailer` options just set `Mailer Enabled` to `1`.
+  - Set `Mailer Host` to the smtp service that you use, eg `smtp.example.com`
+  - Set `Mailer Port` to the smtp service port, eg `465`, `587`, etc.
+  - Set `Mailer Secure` to **true** if you need SSL/HTTPS.
+  - Set `Mailer Auth User` to email as the username.
+  - Set `Mailer Auth Password` to your email's password.
+  - Set `Mailer No Reply Name` to whatever you want.
+  - Set `Mailer No Reply Email` to the default email for `no reply`.
+
+:::note
+
+If you are using google as the SMTP service, your email password will _not_ work. You need to create a `app password` instead. find out more [here](https://support.google.com/accounts/answer/185833?hl=en).
+
+:::

charts/stable/joplin-server/questions.yaml

@@ -20,14 +20,14 @@ questions:
       type: dict
       attrs:
         - variable: APP_BASE_URL
-          label: APP_BASE_URL
+          label: App Base Url
-          description: Sets the APP_BASE_URL env var
+          description: Sets the APP BASE URL, eg http://ip:port | https://app.mydomain.tld:443
           schema:
             type: string
             required: true
             default: ""
         - variable: MAILER_ENABLED
-          label: MAILER_ENABLED
+          label: Mailer Enabled
           description: Set 1 to enabled and 0 to disable
           schema:
             type: int
@@ -36,35 +36,35 @@ questions:
             default: 0
         - variable: MAILER_HOST
           label: Mailer Host
-          description: Sets the MAILER_HOST env var, eg smtp.example.com
+          description: Set the mail host, eg smtp.example.com
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: string
             default: ""
         - variable: MAILER_PORT
           label: Mailer Port
-          description: Sets the MAILER_PORT env var, eg SMTP PORT 465
+          description: Sets the mail port, eg SMTP PORT 465
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: int
             default: 465
         - variable: MAILER_SECURE
           label: Mailer Secure
-          description: Sets the MAILER_SECURE env var, HTTPS for the smtp
+          description: Enable SSL for SMTP
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: boolean
             default: true
         - variable: MAILER_AUTH_USER
           label: Mailer Auth User
-          description: Sets the MAILER_AUTH_USER env var, username for Email server
+          description: Sets the username for the email server
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: string
             default: ""
         - variable: MAILER_AUTH_PASSWORD
           label: Mailer Auth Password
-          description: Sets the MAILER_AUTH_PASSWORD env var, password for Email server
+          description: Sets the password for the email server
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: string
@@ -72,14 +72,14 @@ questions:
             default: ""
         - variable: MAILER_NOREPLY_NAME
           label: Mailer No Reply Name
-          description: Sets the MAILER_NOREPLY_NAME env var, No Reply email name
+          description: Sets the No Reply email name
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: string
             default: ""
         - variable: MAILER_NOREPLY_EMAIL
           label: Mailer No Reply Email
-          description: Sets the MAILER_NOREPLY_EMAIL env var, No Reply default email
+          description: Sets the No Reply default email
           schema:
             show_if: [["MAILER_ENABLED", "=", 1]]
             type: string