Skip to content

Commit a004e3c

Browse files
committed
Cleanup client docs
1 parent dfc6885 commit a004e3c

File tree

10 files changed

+255
-685
lines changed

10 files changed

+255
-685
lines changed

docs/.markdownlint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"first-line-h1": false,
33
"no-bare-urls": false,
44
"no-inline-html": false,
5+
"heading-increment": false,
56
"code-block-style": {
67
"style": "fenced"
78
},
-16.3 KB
Binary file not shown.

docs/pages/client/cloudflare.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,29 @@
22

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

6-
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
7-
8-
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.
8+
Some users use Cloudflare's "Cloudflare Tunnel" feature or additional Cloudflare security
9+
features to provide protected external access to their Notifiarr Client and other services.
10+
Specific configuration required for Cloudflare's various options are detailed below.
911

1012
## Cloudflare Tunnel
1113

1214
!!! info
13-
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)
15+
This assumes that you already have a Cloudflare Tunnel set up on your system.
16+
If you want to get started with Cloudflare Tunnels follow this YouTube guide first:
17+
[Cloudflare Tunnel: Creating Tunnels via GUI - Bypass CG-NAT by IBRACORP](https://www.youtube.com/watch?v=RUJy9fjoiy4)
1418

1519
1. Login to your Cloudflare teams account at [dash.teams.Cloudflare.com](https://dash.teams.Cloudflare.com/)
16-
1. Click **Tunnels** and then **configure** next to the Cloudflare Tunnel you would like to use
17-
![cf-tunnel-configure_sm2.png](../../assets/screenshots/client/cf-tunnel-configure_sm2.png)
18-
19-
1. In your Tunnel section click on **Public Hostname** and add a new hostname by clicking on **Add a public hostname**
20-
21-
![cf-tunnel-configure_publichostname.png](../../assets/screenshots/client/cf-tunnel-configure_publichostname.png)
22-
23-
1. Fill in the public hostname information
24-
25-
- `Subdomain`: Notifiarr (or whatever else you want it to be)
26-
- `Domain`: choose one of your domains
27-
- `Service`: HTTP + Your Local IP Address for Notifiarr
28-
29-
![cf-tunnel-configure_hostnamepage.png](../../assets/screenshots/client/cf-tunnel-configure_hostnamepage.png)
30-
31-
Save your host name settings, that's it! Your client is now exposed to the internet! :smile:
20+
1. Click **Tunnels** and then **configure** next to the Cloudflare Tunnel you would like to use.
21+
![cf-tunnel-configure_sm2.png](../../assets/screenshots/client/cf-tunnel-configure_sm2.png)
22+
1. In your Tunnel section click on **Public Hostname** and add a new hostname by clicking on **Add a public hostname**.
23+
![cf-tunnel-configure_publichostname.png](../../assets/screenshots/client/cf-tunnel-configure_publichostname.png)
24+
1. Fill in the public hostname information on the next screen.
25+
![cf-tunnel-configure_hostnamepage.png](../../assets/screenshots/client/cf-tunnel-configure_hostnamepage.png)
26+
1. `Subdomain`: Notifiarr (or whatever else you want it to be)
27+
1. `Domain`: choose one of your domains
28+
1. `Service`: HTTP + Your Local IP Address for Notifiarr
29+
30+
Save your host name settings, that's it! Your client is now exposed to the Internet!

docs/pages/client/configuration.md

Lines changed: 83 additions & 98 deletions
Large diffs are not rendered by default.

docs/pages/client/gui.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# Notifiarr Client UI
1+
# Notifiarr Client Web UI
22

3-
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.
3+
The client's Web UI is the preferred and recommended method of modifying
4+
the Notifiarr configuration. The Web UI provides an easy and intuitive
5+
interface to configure Integrations for use with Notifiarr.
46

57
---
68

7-
## Enabling the Client UI
8-
9-
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)
10-
11-
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.
9+
Login with your specified user name (default: `admin`) and configured password,
10+
or API key if you haven't set a password yet.
1211

1312
For initial runs:
1413

15-
- If the API Key is configured and valid your password is the APIKey
16-
- If the API Key is invalid and if there is no existing config the password will be printed in the logs on first run.
14+
- If the API Key is configured and valid your password is the API Key.
15+
- 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.
1716

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

2019
## Forgotten Passwords
2120

22-
## Locate the Password in config file prior to UI Access
21+
##### Fresh Installs
2322

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

2626
```bash
2727
# Fix the path yourself:
@@ -31,9 +31,9 @@ grep ui_password /path/to/notifiarr/notifiarr.conf
3131
grep ui_password /mnt/user/appdata/Notifiarr/notifiarr.conf
3232
```
3333

34-
## Liunx / FreeBSD
34+
##### Liunx & FreeBSD
3535

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

3838
```bash
3939
# Reset password.
@@ -42,19 +42,17 @@ notifiarr --reset
4242
systemctl restart notifiarr
4343
```
4444

45-
## Windows
45+
##### Windows
4646

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

4949
```bash
5050
notifiarr.exe --reset
5151
```
5252

53-
## Docker
53+
##### Docker & Unraid
5454

55-
\*Also applies to Unraid\*
56-
57-
1. Run these two commands in your host system's terminal (console) while the Notifiarr container is running.
55+
- Run these two commands in your host system's terminal (console or ssh) while the Notifiarr container is running.
5856
*If your container is named `notifiarr` then replace `Notifiarr` with the lowercase version.*
5957

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

71-
1. If you still can't login, restart the container.
69+
- If you still can't login, restart the container.
7270

7371
---
7472

7573
## Client UI Homepage
7674

77-
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.
75+
!!! danger "Outdated"
76+
These screenshots are outdated, and we'll get them fixed up ASAP! Captain @ October 20, 2025.
77+
78+
Once logged in you will be taken to the Homepage.
79+
From here you are free to navigate the Client and have the power to Modify,
80+
Update, Trigger Application Integrations and much, much more.
7881

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

0 commit comments

Comments
 (0)