Files
truecharts/charts/stable/notifiarr/docs/how-to.md
T
Stavros KoisandGitHub 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

1.4 KiB
Raw Blame History

title
title
Setup Guide

Requirements

  • Your 'All integrations' API key from your account on notifiarr.com
  • Installation of the TrueCharts Catalog, starting here

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 youll 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 for real-time feedback and support
  • If you found a bug in our chart, open a Github issue
  • For further information on operating Notifiarr itself, start with their Quick Start Guide.