Update health checks page and images

Author: davidnewhall

docs/.markdownlint.json

@@ -31,7 +31,7 @@
   },
   "link-image-style": {
     "collapsed": false,
-    "shortcut": false,
+    "shortcut": true,
     "url_inline": false
   },
   "no-duplicate-heading": {

docs/assets/screenshots/website/commands-4.png

@@ -4,7 +4,13 @@ toc_depth: 2
 
 # Notifiarr Client After Install
 
-Log into the Web UI to configure the client. Skim through the rest of this page for important information.
+Do these things:
+
+1. [Log into the Web UI](#web-ui) to configure the client.
+1. [Set a Hostname](#hostname).
+1. [Setup Plex Webhook](#plex-webhook).
+1. [Install Snapshot Dependencies](#snapshot-dependencies).
+1. Do all the things under [Configure the client](#configure-the-client).
 
 ## Web UI
 
@@ -21,8 +27,8 @@ key in the config file @ `/etc/notifiarr/notifiarr.conf` or
 the API key in the config file in your home folder.
 
 Most users will use the API key as the password to login into the client's WebUI for
-the first time. You can set a dedicated password after logging in.
-**The default username is `admin`**.
+the first time. You can set a dedicated password after logging in by clicking your
+*username in the menu => Trust Profile*. **The default username is `admin`**.
 
 The login URL will usually look like one of these. The default listen port is `5454`.
 
@@ -41,9 +47,10 @@ Some examples of how to do that:
 - Unraid users add `-h notifiarr` to `Extra Parameters`.
 - Kubernetes hostnames are automatically determined based on the pod name.
 
-!!! note
+!!!note
     Failure to set a hostname will result in duplicate clients that need to be
     [fixed once a hostname is set](../../pages/website/clientConfig.md#resolving-duplicate-clients).
+    **Restart the client if you set or change the hostname.**
 
 ## WSL2 users
 
@@ -70,19 +77,6 @@ Environment Variables - and the Unraid Template - override settings in the Confi
     configure these values using the client's Web UI. For consistency, we recommend setting the API key and Plex token
     in the Unraid template.
 
-## Log Files
-
-Find your logs here:
-
-- Linux: `/var/log/notifiarr/{app,http,services}.log`
-  - Log paths for linux apt/deb installations are hardcoded
-- FreeBSD: `/var/log/syslog` (w/ default syslog)
-- macOS: `~/.notifiarr/Notifiarr.log`
-- Windows: `<home folder>/.notifiarr/Notifiarr.log`
-
-In the Web UI log settings can be found under `Logging` in *Settings => Configuration*.
-Log file contents can be viewed in the UI under *Insights => Log Files*.
-
 ## Plex Webhook
 
 If you're using Plex, you can configure it to send Notifications. Unlike other integrations, Plex
@@ -118,7 +112,7 @@ for it, shown below. This feature is enabled on the website.
 
 ### Snapshot Sudoers
 
-The following sudoers entries are used by various snapshot features. Add them if you use the respective feature.
+The following sudoers entries are used by various snapshot features. Add them if you use the respective feature. **Restart the client after modifying sudoers entries.**
 You can usually just put the following content into `/etc/sudoers` or `/etc/sudoers.d/00-notifiarr`.
 Make sure the 00-notifiarr file has the proper permissions needed `chmod 400 /etc/sudoers.d/00-notifiarr`.
 
@@ -150,3 +144,65 @@ Install optional package(s) for snapshot data collection.
 - **Synology**: `opkg install smartmontools`, but first get Entware:
   - Entware (synology):  <https://github.com/Entware/Entware-ng/wiki/Install-on-Synology-NAS>
   - Entware Package List:  <https://github.com/Entware/Entware-ng/wiki/Install-on-Synology-NAS>
+
+## Configure The Client
+
+![Profile Page](./images/profile.png){ width="250" align="right" }
+
+- **This is your after install check list.**
+
+It does not cover everything, but it's the things you should get done first.
+You should definitely check out the stuff above though, a lot of it is important prerequisites.
+
+### Set a password
+
+Set a password, or configure your auth proxy header on the *Trust Profile* page.
+Find this page by clicking your username in the Web UI menu. There's a screenshot
+of it to the left; click that to see a larger version.
+
+### Setup Log Files
+
+Head to the *Settings => Configuration* page and scroll down to *Logging*.
+If you don't see an *Application Log File* (and only a placeholder), then add one,
+and click Save Configuration.
+
+![Logging Configuration](./images/logging.png){ width="400" }
+
+Click the Folder icon to open a server-side file browser.
+You may optionally add Services, HTTP and Debug log files. These are not strictly necessary.
+
+![Starr Page](./images/starr.png){ width="250" align="right" }
+
+### Configure Apps
+
+!!!info "Test Button"
+    Click the Test button while adding instances. Make sure it works. The test button is
+    the green double-check mark button next to the URL.
+
+1. On the Starr Apps pages, configure your apps.
+    1. We recommend adding them all. If you have all the starr apps, add them all.
+    1. All you need is a URL and an API key.
+    1. If you turn on database backup checks (on the website), a username and password is also required.
+1. Add all your download apps too. And Plex, and add Tautulli if you use it.
+    Find these on their respective pages: *Download Apps* and *Media Apps*.
+
+### Health Checks
+
+Set the health check intervals on all your apps if you want notifications when an app goes down.
+See the [Health Checks](./healthChecks.md) page for more information about that.
+
+## Log Files
+
+![Log Files Page](./images/logFiles.png){ width="250" align="right" }
+
+**Log file contents can be viewed in the UI under *Insights => Log Files*.**
+
+These are the default location for application output (logs).
+Make sure you [setup a log file](#setup-log-files) if you can't find your logs.
+
+- Linux: `/var/log/notifiarr/{app,http,services}.log`
+  - Log paths for linux apt/deb installations are hardcoded
+- FreeBSD: `/var/log/syslog` (w/ default syslog)
+- macOS: `~/.notifiarr/Notifiarr.log`
+- Windows: `<home folder>/.notifiarr/Notifiarr.log`
+- Docker: `docker logs Notifiarr` (recommend [setting a log file](#setup-log-files))

docs/pages/client/afterInstall.md

@@ -18,11 +18,11 @@ Specific configuration required for Cloudflare's various options are detailed be
 
 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)
+    ![cf-tunnel-configure_sm2.png](./images/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)
+    ![cf-tunnel-configure_publichostname.png](./images/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)
+    ![cf-tunnel-configure_hostnamepage.png](./images/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

docs/pages/client/cloudflare.md

@@ -9,15 +9,15 @@ interface to configure Integrations for use with Notifiarr.
 Head back to [After Install](afterInstall.md#web-ui) or
 [Troubleshooting](troubleshooting.md#forgotten-passwords) for help getting logged in.
 
-![login](../../assets/screenshots/client/login.png)
+![Login Form](./images/login.png)
 
 ## Landing Page
 
 Once logged in you will be taken to the Landing page.
 From here you are free to navigate the Client and have the power to
 update settings, configure and trigger integrations and much, much more.
 
-![landing](../../assets/screenshots/client/landing.png)
+![Landing Page](./images/landing.png)
 
 The Web UI is full of documentation. **It's even available in multiple languages.**
 If you have suggestions where the UI can be improved, or documentation added,

docs/pages/client/gui.md

@@ -0,0 +1,63 @@
+# Notifiarr Client Health Checks
+
+This is one of the most powerful features we provide. And it's free.
+You can configure an unlimited number of service checks in the Notifiarr
+Client. These checks can check URLs for specific response codes, look for
+running processes, or check TCP ports.
+
+!!!warning "Enable Network Integration"
+    - This client feature sends reports to the [website] using the *Network Integration*.
+    - Make sure you enable that Integration on the website and choose a chat channel for notifications.
+
+This page explains the logic the [service check module] uses.
+
+![Starr Page](./images/starr.png){ width="250" align="right" }
+
+## Automatic Instance Checks
+
+The application will automatically add service checks for any instances you configure.
+An instance is just an application like Radarr or Transmission. When you add the instance,
+all you need to do is choose a *Check Interval* duration. That determines how often the
+client checks the instance's health.
+
+!!!danger "Assumptions"
+    Some of the automatic service checks may set the HTTP expect code to something other
+    than 200 / OK. This is normal. There are few configurations for the automatic service
+    checks, most settings are hard coded assumptions. The [test buttons] in the Web UI
+    use different logic than the [automatic service checks].
+
+**The automatic service checks do not work in every environment.**
+You should disable them, and create custom checks if they are not working for you.
+
+![Services Page](./images/services.png){ width="250" align="right" }
+
+## Custom Health Checks
+
+Health checks currently supported are `HTTP`, `TCP port`, `ICMP`, and `UDP Ping`.
+Future versions may include the ability for [subscribers] to run commands and scripts.
+
+Configure custom checks in the Web UI on the *Settings => Services* page.
+The Web UI does a good job of documenting the service check configuration, so
+this section is light on words. Go check out the Web UI for information about
+how to configure a service check. The screenshot to the right does not do it justice.
+
+## Monitoring
+
+- Find current statuses on the *Insights => Monitoring* page in the client Web UI.
+- Configure a custom *Service Status Page* on the [website] in the **Network Integration**.
+
+![Monitoring Page](./images/monitoring.png){ width="250" align="right" }
+
+!!!info "Website Configuration"
+    Configure the notifications chat channel, which role gets pinged, and a few
+    other notification settings in the **Network Integration** on the [website].
+
+When a service changes state the new state is immediately reported to the website.
+By default the website will turn this state change into an immediate notification.
+The notification goes to the *Network Integration* channel that has been selected.
+
+[website]: https://nightly.notifiarr.app/user.php?page=integrations#
+[automatic service checks]: https://github.com/Notifiarr/notifiarr/blob/04ae29c5d0e7c01bd0dd9cfa53302ca7bf4f8d5b/pkg/services/apps.go
+[test buttons]: https://github.com/Notifiarr/notifiarr/blob/04ae29c5d0e7c01bd0dd9cfa53302ca7bf4f8d5b/pkg/checkapp/downloaders.go
+[service check module]: https://github.com/Notifiarr/notifiarr/tree/main/pkg/services
+[subscribers]: ../faq/faq.md#q-what-are-the-user-level-differences