truecharts/charts/stable/joplin-server/docs/installation_notes.md at b47fe2ce52937d72fa697c00a2cee201ddbd2669

Files

T

Stavros Kois 12b5c56b24 chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589 )

**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)-->

front matter is supported by all doc sites (including github markdown
rendering
and is easier to add extra metadata later on, if we want to.

```
---
title: sometitle
---
```

**⚙️ 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-12-31 16:24:05 +02:00

955 B

Raw Blame History

title

title
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.

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.

:::

955 B Raw Blame History

955 B

Raw Blame History