Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/charts/stable/notifiarr/docs/how-to.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

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 14:24:05 +00:00
---
title: Setup Guide
---
fix(notifiarr): Fix inability to change auth settings (#15294) **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. --> Notifiarr treats env as a higher priority than its config file. Therefore, by setting the `DN_UI_PASSWORD` the user is not able to change the password or auth method via the Notifiarr UI. However, Notifiarr also generates a random password on the first run, which is stored in its config file. Therefore, if the `DB_UI_PASSWORD` env is not set the user will be expected to input the randomly generated password. To obtain it, the user must remember to inspect the logs on the first run of the app. To avoid this, I have added a simple init container that creates an empty config file (containing only a comment). This prevents Notifiarr from generating a new config file and thus a random password. When the config file is present but no password is set in it, Notifiarr accepts logins with the username of `admin` and the value of the `DN_API_KEY` env as the password. ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [X] 🪛 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 --> Deployed via helm and tried to log in with the set API key. Then, I tried setting a password and changing the auth method. **📃 Notes:** <!-- Please enter any other relevant information here --> Note: Now that the `DB_UI_PASSWORD` env is not set anymore, the will be expected to log in with the password that is stored in the config file. If they haven't tried to change it via the UI, that password will be the randomly generated one on the first run of the app. Because of this, I am wondering if we should flag this update as breaking instead of as just a fix? **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [X] #️⃣ I have commented my code, particularly in hard-to-understand areas - [X] 📄 I have made corresponding changes to the documentation - [X] ⚠️ My changes generate no new warnings - [X] 🧪 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: sdimovv <36302090+sdimovv@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>
2023-12-08 23:21:35 +00:00
## Requirements
- Your 'All integrations' API key from your account on `notifiarr.com`
- Installation of the TrueCharts Catalog, starting [here](https://truecharts.org/manual/SCALE/guides/getting-started#adding-truecharts)
## Install Notifiarr inside TrueNAS SCALE
- Select `Apps` inside the `TrueNAS` menu,
- Then choose the `Available Applications` tab,
- and search for `notifiarr`
- Click the Install button, and you’ll be prompted to set up Notifiarr.
- Most of the settings can be left at the default values, but ensure to add in your API key
- Take note of the default port (5454) that **Notifiarr** is listening on.
## Notifiarr Initial Setup
For your first time log in, use the username `admin` and the API key you configured as the password.
After you log in, navigate to **`admin` -> `Profile`**. Input your API key as the current password and type in a new password in the new password field. Save your changes.
:::danger
Create a new password right away and do not share your API key (or password) with anyone unless you absolutely, 100%, trust them!
:::
## Support
- You can also reach us using [Discord](https://discord.gg/tVsPTHWTtr) for real-time feedback and support
- If you found a bug in our chart, open a Github [issue](https://github.com/truecharts/apps/issues/new/choose)
- For further information on operating **Notifiarr** itself, start with their [Quick Start Guide](https://notifiarr.wiki/en/QuickStart).