feat(miniflux): Add doc and update questions (#15249)

**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  #15248 

**⚙️ Type of change**

- [x] ⚙️ 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
-->

Custom catalog generated on top of the changes made in the PR and I was
able to install it via TrueNAS UI.

**📃 Notes:**
<!-- Please enter any other relevant information here -->

According to new policy to not mirror every container, the upstream
container will be used.

I propose to change the category to rss as I feel it is more fitted
there.

As the changes brings breaking changes and data loss if upgraded as is
(switch from postgresql chart to cnpg operator), a breaking change note
has been added to the changelog file and git commit. I don't know if
there is a better way to announce it to avoid users data loss.

**✔️ Checklist:**

- [ ] ⚖️ 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
- [ ] 📄 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._

---------

Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
This commit is contained in:
Max 2023-12-20 20:55:54 +01:00 committed by GitHub
parent 1b4ce58b07
commit ea2513c543
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 20 deletions

View File

@ -1,7 +1,7 @@
kubeVersion: ">=1.24.0-0"
apiVersion: v2
name: miniflux
version: 12.0.7
version: 12.0.9
appVersion: 2.0.51
description: Miniflux is a minimalist and opinionated feed reader.
home: https://truecharts.org/charts/incubator/miniflux
@ -31,8 +31,8 @@ annotations:
max_scale_version: 23.10.2
min_scale_version: 23.10.0
truecharts.org/SCALE-support: "true"
truecharts.org/category: media
truecharts.org/category: rss
truecharts.org/max_helm_version: "3.13"
truecharts.org/min_helm_version: "3.12"
truecharts.org/train: incubator
truecharts.org/train: stable
type: application

View File

@ -0,0 +1,4 @@
# Default Username/Password
- **Username**: `admin`
- **Password**: `changeme`

View File

@ -0,0 +1,8 @@
# Installation Notes
- Set `BASE_URL` to **http://scale_ip:APP_PORT/** and then login using the default [credentials](./credentials.md).
- If you plan to use ingress and a domain you need to:
- Set `BASE_URL` to **https://app.mydomain.tld/**
- Configure ingress on the app
Refer to [Miniflux documentation](https://miniflux.app/docs/configuration.html) for more advance configuration.

View File

@ -17,6 +17,12 @@ questions:
additional_attrs: true
type: dict
attrs:
- variable: BASE_URL
label: "BASE_URL"
description: "Base URL to generate HTML links and base path for cookies."
schema:
type: string
default: ""
- variable: ADMIN_USERNAME
label: "ADMIN_USERNAME"
description: "Sets the ADMIN_USERNAME env var"
@ -30,18 +36,6 @@ questions:
type: string
default: "changeme"
private: true
- variable: RUN_MIGRATIONS
label: "RUN_MIGRATIONS"
description: "Sets the RUN_MIGRATIONS env var"
schema:
type: int
default: 1
- variable: CREATE_ADMIN
label: "CREATE_ADMIN"
description: "Sets the CREATE_ADMIN env var"
schema:
type: int
default: 1
# Include{containerBasic}
# Include{containerAdvanced}
# Include{containerConfig}