TrueChartsClone/charts/stable/miniflux/docs/installation_notes.md

9 lines
397 B
Markdown
Raw Normal View History

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>
2023-12-20 19:55:54 +00:00
# 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.