Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/.markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"first-line-h1": false,
"no-bare-urls": false,
"no-inline-html": false,
"heading-increment": false,
"code-block-style": {
"style": "fenced"
},
Expand Down
Binary file not shown.
39 changes: 19 additions & 20 deletions docs/pages/client/cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,29 @@

!!! danger
None of this is required or necessary. **We recommend NOT exposing your
Notifiarr client to the Internet at all. In other words, don't do any of this.**
But you can if you want to access your local Notifiarr Client from the Internet.

Notifiarr client to the Internet at all. In other words, don't do any of this.** But you can if you want to access your local Notifiarr Client from the internet

Many users use Cloudflare's "Cloudflare Tunnel" feature or additional Cloudflare security features to provide / protect external access to their Notifiarr Client box. Specific configuration required for Cloudflare's various options are detailed below.
Some users use Cloudflare's "Cloudflare Tunnel" feature or additional Cloudflare security
features to provide protected external access to their Notifiarr Client and other services.
Specific configuration required for Cloudflare's various options are detailed below.

## Cloudflare Tunnel

!!! info
This assumes that you already have a Cloudflare Tunnel set up on your system. If you want to get started with Cloudflare Tunnels follow this YouTube guide first: [Cloudflare Tunnel: Creating Tunnels via GUI - Bypass CG-NAT by IBRACORP](https://www.youtube.com/watch?v=RUJy9fjoiy4)
This assumes that you already have a Cloudflare Tunnel set up on your system.
If you want to get started with Cloudflare Tunnels follow this YouTube guide first:
[Cloudflare Tunnel: Creating Tunnels via GUI - Bypass CG-NAT by IBRACORP](https://www.youtube.com/watch?v=RUJy9fjoiy4)

1. Login to your Cloudflare teams account at [dash.teams.Cloudflare.com](https://dash.teams.Cloudflare.com/)
1. Click **Tunnels** and then **configure** next to the Cloudflare Tunnel you would like to use
![cf-tunnel-configure_sm2.png](../../assets/screenshots/client/cf-tunnel-configure_sm2.png)

1. In your Tunnel section click on **Public Hostname** and add a new hostname by clicking on **Add a public hostname**

![cf-tunnel-configure_publichostname.png](../../assets/screenshots/client/cf-tunnel-configure_publichostname.png)

1. Fill in the public hostname information

- `Subdomain`: Notifiarr (or whatever else you want it to be)
- `Domain`: choose one of your domains
- `Service`: HTTP + Your Local IP Address for Notifiarr

![cf-tunnel-configure_hostnamepage.png](../../assets/screenshots/client/cf-tunnel-configure_hostnamepage.png)

Save your host name settings, that's it! Your client is now exposed to the internet! :smile:
1. Click **Tunnels** and then **configure** next to the Cloudflare Tunnel you would like to use.
![cf-tunnel-configure_sm2.png](../../assets/screenshots/client/cf-tunnel-configure_sm2.png)
1. In your Tunnel section click on **Public Hostname** and add a new hostname by clicking on **Add a public hostname**.
![cf-tunnel-configure_publichostname.png](../../assets/screenshots/client/cf-tunnel-configure_publichostname.png)
1. Fill in the public hostname information on the next screen.
![cf-tunnel-configure_hostnamepage.png](../../assets/screenshots/client/cf-tunnel-configure_hostnamepage.png)
1. `Subdomain`: Notifiarr (or whatever else you want it to be)
1. `Domain`: choose one of your domains
1. `Service`: HTTP + Your Local IP Address for Notifiarr

Save your host name settings, that's it! Your client is now exposed to the Internet!
181 changes: 83 additions & 98 deletions docs/pages/client/configuration.md

Large diffs are not rendered by default.

45 changes: 24 additions & 21 deletions docs/pages/client/gui.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Notifiarr Client UI
# Notifiarr Client Web UI

The Client UI is the preferred and recommended method of modifying the Notifiarr configuration file. Its GUI provides an easy and intuitive interface for all users to configure Applications for use with Notifiarr.
The client's Web UI is the preferred and recommended method of modifying
the Notifiarr configuration. The Web UI provides an easy and intuitive
interface to configure Integrations for use with Notifiarr.

---

## Enabling the Client UI

Once the Notifiarr client is installed, follow the instructions to set the UI Username/Password as described under [Client -> Setup -> Web UI](../../pages/client/setup.md#web-ui)

Once the above is done, point your browser to the client and you will be taken to the login screen. Login with your specified Username (default: admin) and configured Password.
Login with your specified user name (default: `admin`) and configured password,
or API key if you haven't set a password yet.

For initial runs:

- If the API Key is configured and valid your password is the APIKey
- If the API Key is invalid and if there is no existing config the password will be printed in the logs on first run.
- If the API Key is configured and valid your password is the API Key.
- If the API Key is invalid and if there is no existing config file the password will be printed in the logs on first run.

![login](../../assets/screenshots/client/login.png)

## Forgotten Passwords

## Locate the Password in config file prior to UI Access
##### Fresh Installs

Execute the below command to print the unecrypted first-start password. **This only works for brand new installations.**
Execute the below command to print the unecrypted first-start password.
**This only works for brand new installations.**

```bash
# Fix the path yourself:
Expand All @@ -31,9 +31,9 @@ grep ui_password /path/to/notifiarr/notifiarr.conf
grep ui_password /mnt/user/appdata/Notifiarr/notifiarr.conf
```

## Liunx / FreeBSD
##### Liunx & FreeBSD

1. Run this command which resets the password then restarts the applicatoin
- Run these commands to reset the password and restart the application.

```bash
# Reset password.
Expand All @@ -42,19 +42,17 @@ notifiarr --reset
systemctl restart notifiarr
```

## Windows
##### Windows

1. Run this command, and then restart the application
- Run this command, and then restart the application.

```bash
notifiarr.exe --reset
```

## Docker
##### Docker & Unraid

\*Also applies to Unraid\*

1. Run these two commands in your host system's terminal (console) while the Notifiarr container is running.
- Run these two commands in your host system's terminal (console or ssh) while the Notifiarr container is running.
*If your container is named `notifiarr` then replace `Notifiarr` with the lowercase version.*

```bash
Expand All @@ -68,13 +66,18 @@ docker kill --signal=HUP Notifiarr
[INFO] 2023/09/08 09:32:11 Writing Config File: /config/notifiarr.conf
```

1. If you still can't login, restart the container.
- If you still can't login, restart the container.

---

## Client UI Homepage

Once logged in you will be taken to the Homepage. From here you are free to navigate the Client and have the power to Modify, Update, Trigger Applications/Integrations and much, much more.
!!! danger "Outdated"
These screenshots are outdated, and we'll get them fixed up ASAP! Captain @ October 20, 2025.

Once logged in you will be taken to the Homepage.
From here you are free to navigate the Client and have the power to Modify,
Update, Trigger Application Integrations and much, much more.

![ui_homepage2.png](../../assets/screenshots/client/ui_homepage2.png)

Expand Down
Loading