Skip to content

Update install.md #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidnewhall merged 2 commits into from
Jan 28, 2026
+14 −5
Merged

Update install.md #34

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c63ae98
Update install.md
dervasavred Jan 26, 2026
6436a32
Apply suggestion from @davidnewhall
davidnewhall Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/pages/client/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,19 @@ vi /usr/local/etc/notifiarr/notifiarr.conf
service notifiarr start
```

## TrueNAS Scale <!-- Make the line number below match this line's number. -->
## TrueNAS Community (formerly Scale, current as of Version 25.10.1) <!-- Make the line number below match this line's number. -->
Copy link
Collaborator

@bakerboy448 bakerboy448 Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should keep the header as-is as existing links work.

Can add the Community / version note as an infobox


!!! warning "TrueNAS"
If you figure out how to install Notifiarr on TrueNAS, please
[update these instructions](https://github.com/Notifiarr/mkdocs-wiki/blob/main/docs/pages/client/install.md?plain=1#L57).
Notifiarr support and developers have very little experience with TrueNAS.
1. Install the notifiarr app from the "Apps" menu category.
1. Set your timezone, config directory UID, GID, etc. as normal.
1. Assign a hostname to the container under the "Hostname" field. This field is required, but something simple like "notifiarr" works.
1. Copy either your global API key (or a client-specific API key you generate) from the "API Keys" section of your Profile menu on the notifiarr.com.
Copy link
Member

@austinwbest austinwbest Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the client, there is no "either" and only the Global key should be used. You cant make an integration specific key for the client (it isnt an integration, its the core local app)

1. Create a new environment variable under the "Additional Environment Variables" section. This will be the password for the web UI.

For whatever reason on TrueNAS, the container does not assign the API key you specify as the web UI password,
nor does it log the password correctly. We can fix this by manually setting a password with an environment variable.

1. Name: `DN_UI_PASSWORD`
1. Value: `your_password`
Copy link
Contributor

@davidnewhall davidnewhall Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to someone: this will be outdated in 3..2..1.. give me about 2 days.


## macOS

Expand Down Expand Up @@ -313,3 +320,4 @@ curl -sSL https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts

1. Type `systemctl --user restart nginx`
1. Now you should be able to browse to `https://your-ultraseedbox-url/notifiarr`