¶ Clients Setup
The client is used to do all local communication between the site and your system. This allows all urls, apikeys, etc to stay local and requires apikey validation between the site and the client before any actions can be taken.
You may run more than 1 client, and it is recommended if you have more than 1 system to monitor.
Going forward, it will be assumed you have configured the client already and have the port forwarded or the reverse proxy setup properly so the site can communicate with the client.
Depending on your layout (Grid or List) you will see:
When you open the client settings you will see:
-
Client list: Each client you have configured will show up as a tab so its settings can be modified
-
This section is information about the local client and its host environment
-
This is the URL to the client so the site can communicate with it
- This is required for many features. Client will fallback to settings sync on a polling basis and limited feature support if not configured
- LAN - The URL cannot be any local network IP such as, but not limited to the following:
http://192.168.*.*:5454http://10.1.*.*:5454
- WAN - The URL can be
http://<your-external-ip>:5454- You may use any of the following commands to locate your external ip
curl ifconfig.mecurl -4/-6 icanhazip.comcurl ipinfo.io/ipcurl api.ipify.orgcurl checkip.dyndns.orgdig +short myip.opendns.com @resolver1.opendns.comhost myip.opendns.com resolver1.opendns.comcurl ident.mecurl bot.whatismyipaddress.comcurl ipecho.net/plain
- Note that you will be required to port forward your router to the system the Notifiarr client is running on.
- You may verify the port is open and forwarded with
curlor any port checking sites such as those listed below- https://portchecker.co/checking
- https://canyouseeme.org/
curl -w '%{time_total}' http://<ip>:5454
- You may verify the port is open and forwarded with
- Note that ISPs that are CGATS likely will need to use a VPS outside of their ISP to place the client on tunneled - such as using Tailscale or another VPN service - to the user's systems
- You may use any of the following commands to locate your external ip
- Domain - The URL can be
https://notifiarr.domain.comorhttps://domain.com/notifiarrif you use a reverse proxy with a port forward to point that reverse proxy port (http as port 80 / https as port 443) to the local machine IP- See Client Reverse Proxy for more details
-
This is the connection status, if it isn't green then the site can not reach the client. Change the URL accordingly and click the icon to re-test until it turns green. See Errors below.
-
Use this client for timers that are not part of a specific integration (non client integrated timers, daily overview posts for example)
-
Client triggers: If the URL is provided, you can trigger the client to run any of these actions by clicking the cloud icon
-
Save button: Once done, click this and it will update all your settings. If a URL is provided it will trigger the client to fetch the new settings right then. If no URL is provided then you can restart the client manually to pull the changed settings or wait 5 minutes for the client poller to request any changed settings and update
-
If you have a duplicate client showup (change the user, hostname changed, etc) you can merge the new client with the old one so all the settings copy over and the old one is removed
-
If you no longer have the client installed on a specific hostname, you can remove it
¶ Errors
- If the icon does not turn green, you can see the error and details in the Console via the Browser's DevTools (F12 in most browsers). Some common issues are listed below.
- Port forward not configured/enabled. Check port forwarding, IPs, and firewalls
- App in the client is taking too long to respond causing timeouts. Disable all apps and re-enable 1x1 to identify the culprit
- Confirm your URL you are entering is accurate
¶ Duplicate Clients
- This typically occurs in Docker or *BSD when a hostname is not configured everytime the container is restarted.
- For other installations this would occur if the unique attributes of your host system and installation change.
¶ Resolving Duplicate Clients
- Configure/Set a hostname for the client if applicable or resolve the changing attributes
- Restart the client
- On the Website in Client Configuration, Delete all client entries between the first and last client
- On the Website in Client Configuration, Merge the remaining two client entries