Skip to content

Commit d6945e3

Browse files
committed
lint
1 parent 9653262 commit d6945e3

File tree

5 files changed

+36
-14
lines changed

5 files changed

+36
-14
lines changed

docs/pages/client/cloudflare.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@
55

66
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
77

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+
Many users use Cloudflare's "Cloudflare Tunnel" feature or additional Cloudflare security features to
9+
provide / protect external access to their Notifiarr Client box. Specific configuration required for
10+
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. If you want to get started
16+
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/)
1620
1. Click **Tunnels** and then **configure** next to the Cloudflare Tunnel you would like to use

docs/pages/client/configuration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ When a new docker image is deployed with an empty /config folder mounted, the ap
2323
- **The Notifiarr application uses the API key for bi-directional authorization between the Site and the Client.**
2424

2525
!!! danger "Unraid Users"
26-
You must configure the Notifiarr API Key in the Unraid Template/ Container Settings. If you wish to use Plex then you'll also need to set the Plex Token and Plex URL in the template as well. The other integrations can be defined in notifiarr.conf
26+
You must configure the Notifiarr API Key in the Unraid Template/ Container Settings.
27+
If you wish to use Plex then you'll also need to set the Plex Token and Plex URL in the template as well.
28+
The other integrations can be defined in notifiarr.conf
2729

2830
!!! info "Docker Users"
2931
Note that Docker Environmental Variables - and thus the Unraid Template - override the Config file.
@@ -93,7 +95,9 @@ Config File and Docker Environmental Variables are listed below
9395
- Environmental Variables take precedent over config file settings
9496
- Must provide an API key from [notifiarr.com](https://notifiarr.com).
9597
- **The Notifiarr application uses the API key for bi-directional authorization.**
96-
- You may provide multiple Sonarr, Radarr or Readarr instances using `DN_SONARR_1_URL`, `DN_SONARR_2_URL`, etc or by duplicating the starr block in the conf file. Note the header of `[[radarr]]`, `[[sonarr]]`, `[[readarr]]`, etc. is required.
98+
- You may provide multiple Sonarr, Radarr or Readarr instances using
99+
`DN_SONARR_1_URL`, `DN_SONARR_2_URL`, etc or by duplicating the starr block in the conf file.
100+
Note the header of `[[radarr]]`, `[[sonarr]]`, `[[readarr]]`, etc. is required.
97101

98102
### Client
99103

docs/pages/client/gui.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Notifiarr Client 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 UI is the preferred and recommended method of modifying the Notifiarr configuration file.
4+
Its GUI provides an easy and intuitive interface for all users to configure Applications for use with Notifiarr.
45

56
---
67

@@ -143,8 +144,13 @@ As of March 8, 2022, there are no existing integrations, so this is for future u
143144
extra API keys. Whatever you want. Separate them with newlines or spaces.
144145
1. `Bind Address` - This is the IP and port the app will listen on. 0.0.0.0 means all IPs, and you should use that in almost all cases! Change the port if the default 5454 does not work for you.
145146
1. `URL Base` - This application serves HTTP on / by default. You can change that by typing in something else here.
146-
1. `Upstreams` - If Notifiarr client is behind a reverse proxy (swag, nginx, etc), then you should add that proxy IP here. You can also specify full networks. This controls which IP is written to the web server log file (requestor or x-forwarded-for header). It also allows the x-webauth-user header for proxy authentication. Separate with spaces or new lines.
147-
1. `Host ID` - The Host ID parameter is used to uniquely identify this client installation. Changing this value is discouraged; it should be found automatically. Do not copy this value to another Notifiarr client insallation.
147+
1. `Upstreams` - If Notifiarr client is behind a reverse proxy (swag, nginx, etc), then you should add that proxy IP here.
148+
You can also specify full networks. This controls which IP is written to the web server log file (requestor or
149+
x-forwarded-for header). It also allows the x-webauth-user header for proxy authentication.
150+
Separate with spaces or new lines.
151+
1. `Host ID` - The Host ID parameter is used to uniquely identify this client installation.
152+
Changing this value is discouraged; it should be found automatically.
153+
Do not copy this value to another Notifiarr client insallation.
148154
1. `Parallel Threads` - Disabling this setting will make the application use fewer go routines (threads) when gathering data from configured applications. Spreads out CPU usage and lowers memory footprint.
149155
1. `Retries` - Sometimes connections to Notifiarr.com fail. This controls how many times each request will be attempted in case of failures.
150156
1. `Timeout` - This is the timeout for API requests to Notifiarr.com.

docs/pages/client/install.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,9 @@ curl -sSL https://raw.githubusercontent.com/Notifiarr/notifiarr/main/userscripts
166166
167167
## Docker
168168
169-
This project builds automatically in [Docker Cloud](https://hub.docker.com/r/golift/notifiarr) and creates [ready-to-use multi-architecture images](https://hub.docker.com/r/golift/notifiarr/tags). The `latest` tag is always a tagged release in GitHub.
169+
This project builds automatically in [Docker Cloud](https://hub.docker.com/r/golift/notifiarr) and creates
170+
[ready-to-use multi-architecture images](https://hub.docker.com/r/golift/notifiarr/tags).
171+
The `latest` tag is always a tagged release in GitHub.
170172
171173
### Compose
172174

docs/pages/client/reverseProxy.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# Client Reverse Proxy Configuration
22

33
!!! danger "Reverse Proxy Users"
4-
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
4+
None of this is required or necessary.
5+
**We recommend NOT exposing your 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-
While you can certainly poke a hole your firewall and send the traffic directly to this app, it is recommended that you put it behind a reverse proxy if you're going to expose it. It's pretty easy.
8+
While you can certainly poke a hole your firewall and send the traffic directly to this app,
9+
it is recommended that you put it behind a reverse proxy if you're going to expose it. It's pretty easy.
710

8-
- You'll want to tune the `upstreams` and `urlbase` client settings for your environment
9-
- If your reverse proxy IP is `192.168.3.45` then set `upstreams` in the Profile page of the local Notifiarr Client to `192.168.3.45/32`
10-
- The `urlbase` on the local Notifiarr Client configuration page can be left at `/`, but change it if you serve this app from a subfolder like `/notifiarr`
11+
- You'll want to tune the `upstreams` and `urlbase` client settings for your environment.
12+
- If your reverse proxy IP is `192.168.3.45` then set `upstreams`
13+
in the Profile page of the local Notifiarr Client to `192.168.3.45/32`
14+
- The `urlbase` on the local Notifiarr Client configuration page can be left at `/`,
15+
but change it if you serve this app from a subfolder like `/notifiarr`.
1116

1217
## Cloudflare Users
1318

14-
Cloudflare Firewall / ZeroTrust users - See [this wiki entry](../../pages/client/cloudflare.md) to ensure Notifiarr is allowed through Cloudflare
19+
If yuo use Cloudflare Firewall or ZeroTrust see
20+
[this wiki entry](../../pages/client/cloudflare.md) to ensure Notifiarr is allowed through Cloudflare.
1521

1622
## NGINX Subfolder Example
1723

0 commit comments

Comments
 (0)