diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 100cb24..8746253 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -48,6 +48,6 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./site - cname: gh.notifiarr.wiki + cname: notifiarr.wiki user_name: Notifiarr user_email: notifiarr+github-actions[bot]@users.noreply.github.com diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json new file mode 100644 index 0000000..8b71f2f --- /dev/null +++ b/docs/.markdownlint.json @@ -0,0 +1,63 @@ +{ + "first-line-h1": false, + "no-bare-urls": false, + "no-inline-html": false, + "code-block-style": { + "style": "fenced" + }, + "code-fence-style": { + "style": "backtick" + }, + "emphasis-style": { + "style": "asterisk" + }, + "extended-ascii": { + "ascii-only": true + }, + "fenced-code-language": { + "language_only": true + }, + "heading-style": { + "style": "atx" + }, + "hr-style": { + "style": "---" + }, + "line-length": { + "strict": false, + "code_blocks": false, + "line_length": 410 + }, + "link-image-style": { + "collapsed": false, + "shortcut": false, + "url_inline": false + }, + "no-duplicate-heading": { + "siblings_only": true + }, + "ol-prefix": { + "style": "one_or_ordered" + }, + "proper-names": { + "code_blocks": false, + "names": [ + "Cake.Markdownlint", + "CommonMark", + "JavaScript", + "Markdown", + "markdown-it", + "markdownlint", + "Node.js" + ] + }, + "reference-links-images": { + "shortcut_syntax": true + }, + "strong-style": { + "style": "asterisk" + }, + "ul-style": { + "style": "dash" + } +} diff --git a/docs/index.md b/docs/index.md index fa9bb30..99393e9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ -Client:
+##### Client + ![GitHub commit activity](https://img.shields.io/github/commit-activity/t/notifiarr/notifiarr?label=Commits&style=for-the-badge&color=526cfe) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/notifiarr/notifiarr/main?label=Stable%20(:latest)&style=for-the-badge&color=526cfe) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/notifiarr/notifiarr/unstable?label=Unstable%20(:unstable)&style=for-the-badge&color=526cfe) @@ -11,18 +12,24 @@ Client:
![GitHub issues](https://img.shields.io/github/issues-pr-closed/Notifiarr/notifiarr?&logo=github&style=for-the-badge&color=526cfe) [![GitHub license](https://img.shields.io/github/license/Notifiarr/notifiarr?&logo=github&style=for-the-badge&color=526cfe)](https://github.com/Notifiarr/notifiarr/blob/main/LICENSE) -Site:
+##### Site + ![GitHub issues](https://img.shields.io/github/issues/Notifiarr/website?&logo=github&style=for-the-badge&color=526cfe) ![GitHub issues](https://img.shields.io/github/issues-closed/Notifiarr/website?&logo=github&style=for-the-badge&color=526cfe) -Support:
+##### Support + [![Discord](https://img.shields.io/discord/764440599066574859?label=Discord&style=for-the-badge&color=7F00FF)](https://notifiarr.com/discord) ![Logo](assets/logo.png) # Notifiarr -You just found one of the coolest tools on the Internet for a homelab enthusiast. We do notifications. We do them right. We've been doing then for years and we'll keep doing them for years to come. Notifiarr provides native custom integrations with dozens, maybe hundreds of applications and websites. That means these applications or websites can send data to Notifiarr, and we'll format a message according to your configuration then send it to your chat server. +You just found one of the coolest tools on the Internet for a homelab enthusiast. +We do notifications. We do them right. We've been doing then for years and we'll keep doing them for years to come. +Notifiarr provides native custom integrations with dozens, maybe hundreds of applications and websites. +That means these applications or websites can send data to Notifiarr, and we'll format a message according to +your configuration then send it to your chat server. What sets us apart from direct integrations are the options we provide to format your messages. We also maintain and provide, for your conveince, a local agent you may run on any server or network you wish to monitor. The agent is fully configurable to collect network and system data so you can get health reports from your servers. @@ -37,28 +44,33 @@ we have a big community, if you need assistance you can ask there by opening a s ## From the author -I built Notifiarr in late 2019 for [myself](https://github.com/austinwbest), and it was used by only myself until August of 2020 when I opened it up for others to use. My goal has always been to have a single location for common notification needs, so I am not jumping around 20 apps to do things. [Captain](https://github.com/davidnewhall) joined the crew in December 2020, and the two of us run the servers and write the code for the client and website. +I built Notifiarr in late 2019 for [myself](https://github.com/austinwbest), and it was used by only myself until +August of 2020 when I opened it up for others to use. My goal has always been to have a single location for common +notification needs, so I am not jumping around 20 apps to do things. [Captain](https://github.com/davidnewhall) +joined the crew in December 2020, and the two of us run the servers and write the code for the client and website. ## Integrations !!! note - [How to setup integrations](pages/integrations/basicUsage.md#how-to-setup-integrations) ## Additional Features -* Fully configurable on what triggers to get notifications for. Each integration and many triggers in them can go to their own channels. -* Layout configuration for some notifications -* Content configuration for most notifications (color, content, etc) -* Media Requests Bot - Discord Bot for all 4 \*Arr apps with: - * Media Requests - * User Permissions - * Approvals - * Sonarr Profiles - * Default Options - * Series Following - * Discover features - * Multi-Instance Support -* Minimal Access - No \*Arr apikeys or anything of the sort is used or saved on the site. All requests to the client are verified with your Notifiarr apikey and thrown out if they don't match up -* TRaSH Custom Format Sync [*\*Patron Feature\**](pages/faq/faq.md#q-what-are-the-user-level-differences) - Automated continuous add/sync for the custom formats TRaSH has made to use with Radarr -* Radarr Collections - A fully automated way to monitor all your Radarr collections with auto add new items to your library as they are put into the collection on TMDb for any monitored collections, etc. +- Fully configurable on what triggers to get notifications for. Each integration and many triggers in them can go to their own channels. +- Layout configuration for some notifications +- Content configuration for most notifications (color, content, etc) +- Media Requests Bot - Discord Bot for all 4 \*Arr apps with: + - Media Requests + - User Permissions + - Approvals + - Sonarr Profiles + - Default Options + - Series Following + - Discover features + - Multi-Instance Support +- Minimal Access - No \*Arr apikeys or anything of the sort is used or saved on the site. + All requests to the client are verified with your Notifiarr apikey and thrown out if they don't match up +- TRaSH Custom Format Sync [*\*Patron Feature\**](pages/faq/faq.md#q-what-are-the-user-level-differences) - + Automated continuous add/sync for the custom formats TRaSH has made to use with Radarr +- Radarr Collections - A fully automated way to monitor all your Radarr collections with auto add new + items to your library as they are put into the collection on TMDb for any monitored collections, etc. diff --git a/docs/pages/client/configuration.md b/docs/pages/client/configuration.md index 4d57fc5..7864e1e 100644 --- a/docs/pages/client/configuration.md +++ b/docs/pages/client/configuration.md @@ -21,7 +21,7 @@ When a new docker image is deployed with an empty /config folder mounted, the ap - You can use env variables, the conf file, or the UI - Must provide the "All" API key from your [Profile page on notifiarr.com](https://notifiarr.com/user.php?page=profile) - **The Notifiarr application uses the API key for bi-directional authorization between the Site and the Client.** - + !!! danger "Unraid Users" 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 @@ -131,7 +131,7 @@ Recommend not messing with these unless instructed to do so. | max_body | `DN_MAX_BODY` | Unlimited, `0` / Maximum debug-log body size (integer) for payloads to and from notifiarr.com | | | `TMPDIR` | `%TMP%` on Windows. Varies depending on system; must be writable if using Backup Corruption Check | -_Note: You may disable the GUI (menu item) on Windows by setting the env variable `USEGUI` to `false`._ +*Note: You may disable the GUI (menu item) on Windows by setting the env variable `USEGUI` to `false`.* #### MySQL Snapshots diff --git a/docs/pages/client/gui.md b/docs/pages/client/gui.md index b4cb60c..c4dce82 100644 --- a/docs/pages/client/gui.md +++ b/docs/pages/client/gui.md @@ -61,7 +61,7 @@ notifiarr.exe --reset docker exec Notifiarr /notifiarr --reset docker kill --signal=HUP Notifiarr ``` - + ```bash # Example output with new password: [INFO] 2023/09/08 09:32:11 New 'admin' user password: four38=Draw @@ -135,7 +135,12 @@ The General section is more catered to the ingress and egress options/functional !!! warning This API must be an All key! -1. `Extra Keys` - This application uses the Notifiarr.com API key (set above) for incoming authentication. It's not safe to give that key to any other website, person, or third party service. This is because that key is also used for authentication to the Notifiarr.com API. If you want third parties to authenticate to this application's API, you should create custom keys for each integration. As of March 8, 2022, there are no existing integrations, so this is for future use. You can use this section to add extra API keys. Whatever you want. Separate them with newlines or spaces. +1. `Extra Keys` - This application uses the Notifiarr.com API key (set above) for incoming authentication. +It's not safe to give that key to any other website, person, or third party service. +This is because that key is also used for authentication to the Notifiarr.com API. +If you want third parties to authenticate to this application's API, you should create custom keys for each integration. +As of March 8, 2022, there are no existing integrations, so this is for future use. You can use this section to add +extra API keys. Whatever you want. Separate them with newlines or spaces. 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. 1. `URL Base` - This application serves HTTP on / by default. You can change that by typing in something else here. 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. diff --git a/docs/pages/client/install.md b/docs/pages/client/install.md index 9fe7a7a..fa4bb66 100644 --- a/docs/pages/client/install.md +++ b/docs/pages/client/install.md @@ -267,7 +267,7 @@ WantedBy=default.target 1. Type `systemctl --user enable notifiarr` 1. Type `systemctl --user start notifiarr` 1. Type `systemctl --user status notifiarr` to check if there are any errors. -1. On your browser go to http://[ultraseedbox url]:5454 +1. On your browser go to `http://your-ultraseedbox-url:5454` 1. Log into your Notifarr client and change the base url to /notifiarr and save changes 1. Go back to your ssh console 1. Type `cd /home/$USER/.apps/nginx/proxy.d` @@ -296,4 +296,4 @@ deny all; # remove this line if you really want to expose the API. ``` 1. Type `systemctl --user restart nginx` -1. Now you should be able to browse to https://[ultraseedbox url]/notifiarr +1. Now you should be able to browse to `https://your-ultraseedbox-url/notifiarr` diff --git a/docs/pages/client/reverseProxy.md b/docs/pages/client/reverseProxy.md index 7eaae35..ae0a8b8 100644 --- a/docs/pages/client/reverseProxy.md +++ b/docs/pages/client/reverseProxy.md @@ -108,7 +108,7 @@ server { set $upstream_app notifiarr; set $upstream_port 5454; set $upstream_proto http; - + location / { # enable the next two lines for http auth #auth_basic "Restricted"; @@ -117,7 +117,7 @@ server { # enable the next two lines for organizr auth #include /config/nginx/orgauth.conf; #auth_request /organizr-auth/0; - + # enable the next two lines for ldap auth #auth_request /auth; #error_page 401 =200 /ldaplogin; @@ -129,7 +129,7 @@ server { proxy_set_header X-WebAuth-User $auth_user; proxy_pass $upstream_proto://$upstream_app:$upstream_port; } - + # API path must not be protected by auth, authelia, ldap, etc. location ~ (/notifiarr)?/api { deny all; # remove this line if you really want to expose the API. diff --git a/docs/pages/client/setup.md b/docs/pages/client/setup.md index fa73197..ca8eb4f 100644 --- a/docs/pages/client/setup.md +++ b/docs/pages/client/setup.md @@ -21,7 +21,7 @@ There are non-integration related settings and triggers are configured on the No 1. Open the conf file, set your Notifiarr API Key and restart the client. ```conf - ## This API key must be copied + ## This API key must be copied from your notifiarr.com account. api_key = "api-key-from-notifiarr.com" ``` @@ -47,7 +47,7 @@ When a new docker image is deployed and an empty /config folder is mounted the a - Must provide the "All" API key from your [Profile page on notifiarr.com](https://notifiarr.com/user.php?page=profile) - **The Notifiarr application uses the API key for bi-directional authorization between the Site and the Client.** -!!! warning +!!! warning **Unraid Users** 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 diff --git a/docs/pages/discordbot/permissions.md b/docs/pages/discordbot/permissions.md index 38f7094..345d7e5 100644 --- a/docs/pages/discordbot/permissions.md +++ b/docs/pages/discordbot/permissions.md @@ -1,10 +1,14 @@ # Discord Permissions -Getting permissions correct for your setup can be a struggle depending on how you have your Discord server setup. If you want to run a simple test to see if you have permission issues, set the Notifiarr role to have `Admin` permission and see whether it solves your issue. If everything works, this means you simply need to adjust permissions for the the Notifiarr role and you don't need to give it full admin permissions +Getting permissions correct for your setup can be a struggle depending on how you have your Discord server setup. +If you want to run a simple test to see if you have permission issues, set the Notifiarr role to have `Admin` +permission and see whether it solves your issue. If everything works, this means you simply need to adjust permissions +for the the Notifiarr role and you don't need to give it full admin permissions. --- -To update the integration's permissions, click on your server name at the top and pick `Server Settings > Roles`. Click on the `Notifiarr` role and then pick `Permissions`. +To update the integration's permissions, click on your server name at the top and pick `Server Settings > Roles`. +Click on the `Notifiarr` role and then pick `Permissions`. ## **Required Permissions** diff --git a/docs/pages/faq/faq.md b/docs/pages/faq/faq.md index 7f5694b..887c35e 100644 --- a/docs/pages/faq/faq.md +++ b/docs/pages/faq/faq.md @@ -89,7 +89,10 @@ If session info is missing from notifications or the sessions notification is no - Make sure you have selected the **Activity** checkbox in the Plex section of the [Client Settings](../../pages/website/clientConfig.md) - Try to increase the **Activity Delay** in the Plex section of the [Client Settings](https://notifiarr.wiki/en/Website/ClientConfiguration) as this will give Plex more time to get the session available in the endpoint - Note 1: The sessions notifications will only send when there is at least one item being played or paused -- Note 2: It doesn't matter what Tautulli shows or the Plex Dashboard shows, they both use the same sessions endpoint. If you where to look at them at the same time as the notification is sent (when it doesn't work) they would also not show the session yet. How long it takes Plex & your (possibly low powered or over worked) server to make the session available in the endpoint is out of our control which is why we added the delay option +- Note 2: It doesn't matter what Tautulli shows or the Plex Dashboard shows, they both use the same sessions endpoint. + If you where to look at them at the same time as the notification is sent (when it doesn't work) they would also not + show the session yet. How long it takes Plex & your (possibly low powered or over worked) server to make the session + available in the endpoint is out of our control which is why we added the delay option ## Q. What are the user level differences diff --git a/docs/pages/integrations/authentik.md b/docs/pages/integrations/authentik.md index 7e55b20..85553bb 100644 --- a/docs/pages/integrations/authentik.md +++ b/docs/pages/integrations/authentik.md @@ -1,8 +1,7 @@ # Authentik !!! info - - This integration is for setting up discord notifications for Authentik + This integration is for setting up discord notifications for Authentik --- @@ -21,9 +20,8 @@ ## Instructions !!! info "Authentik Notifications" - Detailed wiki for [Authentik Notifications](https://docs.goauthentik.io/docs/sys-mgmt/events/notifications) - + ![instructions.png](../../assets/screenshots/integrations/authentik/instructions.png) 1. Instructions on how too set webhook notifications in Authentik @@ -40,7 +38,6 @@ Click the cog icon too open the configuration settings ![configuration.png](../../assets/screenshots/integrations/authentik/configuration.png) 1. enabling each `trigger field`, and using the `customize toggle` too drop down the `notification fields` for each trigger - 2. choosing the color of the notification --- diff --git a/docs/pages/integrations/autobrr.md b/docs/pages/integrations/autobrr.md index eb16332..2a81cfd 100644 --- a/docs/pages/integrations/autobrr.md +++ b/docs/pages/integrations/autobrr.md @@ -40,4 +40,4 @@ Here you can customize the layout and color of your notifcation for each avaiabl ### Test Notification Examples -![examples.png](../../assets/screenshots/integrations/autobrr/examples.png) \ No newline at end of file +![examples.png](../../assets/screenshots/integrations/autobrr/examples.png) diff --git a/docs/pages/integrations/basicUsage.md b/docs/pages/integrations/basicUsage.md index defa2e7..ad9bf27 100644 --- a/docs/pages/integrations/basicUsage.md +++ b/docs/pages/integrations/basicUsage.md @@ -1,7 +1,6 @@ # How To Setup Integrations !!! info - All the integrations follow the same layout and logic so this means once you understand how one of them works you will be able to figure out how to setup any of them. --- diff --git a/docs/pages/integrations/bazarr.md b/docs/pages/integrations/bazarr.md index 63a9aa5..e82c903 100644 --- a/docs/pages/integrations/bazarr.md +++ b/docs/pages/integrations/bazarr.md @@ -1,14 +1,14 @@ # Bazarr !!! info - This integration allows for notifications from Bazarr and will also add reactions to notifications if a subtitle was found for it and you are using reactions. --- ## Current Versions -![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fbazarr%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=526cfe){ .off-glb } ![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fbazarr%2Fnightly%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=526cfe){ .off-glb } +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fbazarr%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=526cfe){ .off-glb } +![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fbazarr%2Fnightly%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=526cfe){ .off-glb } --- @@ -60,5 +60,4 @@ Reaction example: 1. Test the notification from Notifiarr to Discord !!! note - This will ensure your server, channel and permissions are set properly in Discord diff --git a/docs/pages/integrations/betterstack.md b/docs/pages/integrations/betterstack.md index 9c9bac6..7202819 100644 --- a/docs/pages/integrations/betterstack.md +++ b/docs/pages/integrations/betterstack.md @@ -1,7 +1,6 @@ # Better Stack !!! info - This integration allows for notifications from Better stack utilizing their webhook system --- @@ -32,5 +31,4 @@ Click the **cog icon** to open the configuration options for Better Uptime. 1. Better Uptime team id that is used to link the Incident in the notification !!! note - This integration sends a single notification for all triggers. After the first one is sent, the rest will update the existing notification in the chain. diff --git a/docs/pages/integrations/channelstats.md b/docs/pages/integrations/channelstats.md index 990b5ea..dc27943 100644 --- a/docs/pages/integrations/channelstats.md +++ b/docs/pages/integrations/channelstats.md @@ -21,19 +21,12 @@ While most of the information is pulled from the dashboard integration, things s You will also need the Plex client setup if you plan to use the available Plex triggers. 1. The trigger to enable each field that you may want. - 2. `Sonarr Total` - This will display the total number in sonarr. - 3. `Episodes on disk` - This is where you can choose how you want to name your `sonarr total` instance - 4. choose to list either the total `On Disk` or `In Database` - 5. `Plex Streaming` - Enabling this will list any plex streams that are happening. - 6. `Plex Transcoding` - Enabling this will list any present transcodes on the server. - 7. `Plex Lan Traffic` - Enabling this will display the current plex traffic on your LAN. - 8. `Plex Wan Traffic` - Enable this will display the current plex traffic on your WAN. **There are also some basic triggers such as:** @@ -41,9 +34,7 @@ While most of the information is pulled from the dashboard integration, things s ![basic-triggers.png](../../assets/screenshots/integrations/channel-stats/basic-triggers.png) 1. `discord: users` - Enabling this will list how many members are in the server. - 2. `Notifications: daily` - Enabling this will list how many notifications you get day by day. - 3. `Notifications: Total` - Enabling this will give you the total notifications that notifiarr has ever sent. ## Example diff --git a/docs/pages/integrations/dashboard.md b/docs/pages/integrations/dashboard.md index bae89cb..cc2456e 100644 --- a/docs/pages/integrations/dashboard.md +++ b/docs/pages/integrations/dashboard.md @@ -1,7 +1,6 @@ # Dashboard !!! info - This integration allows for notifications to keep you updated with an overview of some commonly used apps. --- @@ -53,7 +52,6 @@ Click the **cog icon** to open the configuration options for the Dashboard integ --- !!! warning - When you change the active status or the order, the next update will trigger a delete all and repost everything automatically, so they are in the correct order based on what you have turned on. ## Examples diff --git a/docs/pages/integrations/dockwatch.md b/docs/pages/integrations/dockwatch.md index 7d4d856..98e530c 100644 --- a/docs/pages/integrations/dockwatch.md +++ b/docs/pages/integrations/dockwatch.md @@ -50,4 +50,4 @@ Here is the setup on dockwatch's end. ### Notification Examples -![notification-example.png](../../assets/screenshots/integrations/Dockwatch/notification-example.png) \ No newline at end of file +![notification-example.png](../../assets/screenshots/integrations/Dockwatch/notification-example.png) diff --git a/docs/pages/integrations/fail2ban.md b/docs/pages/integrations/fail2ban.md index f2fe499..360df1b 100644 --- a/docs/pages/integrations/fail2ban.md +++ b/docs/pages/integrations/fail2ban.md @@ -13,7 +13,7 @@ F2B_HOST="$(hostname)" 1. **Open a shell** on the server where Fail2ban is installed. -2. **Change to the Fail2ban actions directory.** +2. **Change to the Fail2ban actions directory.** Adjust the path if your installation is different. ```bash @@ -42,7 +42,7 @@ F2B_HOST="$(hostname)" ``` 6. **Configure your `jail.local` file:** - + Open your jail configuration: ```bash diff --git a/docs/pages/integrations/github.md b/docs/pages/integrations/github.md index fb253a3..266ffa6 100644 --- a/docs/pages/integrations/github.md +++ b/docs/pages/integrations/github.md @@ -1,7 +1,6 @@ # Github !!! info - This integration allows for notifications from public Github repositories. --- @@ -39,5 +38,4 @@ Click the **cog icon** to open the configuration options for Github. ![instructions.png](../../assets/screenshots/integrations/github/instructions.png) !!! note - This is how you add the webhook to Github and then how you add the organization in the Github integration diff --git a/docs/pages/integrations/hotio.md b/docs/pages/integrations/hotio.md index 0d17938..6051b84 100644 --- a/docs/pages/integrations/hotio.md +++ b/docs/pages/integrations/hotio.md @@ -1,7 +1,6 @@ # Hotio !!! info - This integration allows for notifications from Hotio. ## Currently supported @@ -40,5 +39,4 @@ Click the **cog icon** to open the configuration options for Hotio apps. The compose entry to enable Notifiarr with Pullio !!! note - for images: If you do not specify an avatar image in the app compose one will be used from the site so you do not have to worry about image hosting sites. diff --git a/docs/pages/integrations/jellyfin.md b/docs/pages/integrations/jellyfin.md index fbb624c..d8db4bf 100644 --- a/docs/pages/integrations/jellyfin.md +++ b/docs/pages/integrations/jellyfin.md @@ -1,7 +1,6 @@ # Jellyfin !!! info - This integration allows for notifications from the Jellyfin media app ## Trigger options @@ -66,14 +65,12 @@ Write the URL of your Jellyfin server where it says `SERVER URL` and click on ** Give the Webhook a name !!! info - Example: Notifiarr - `Webhook Url` !!! note - - This is the URL of your webhook, which includes your API Key + This is the URL of your webhook, which includes your API Key ```bash https://notifiarr.com/api/v1/notification/jellyfin/YOUR_API_KEY @@ -93,8 +90,7 @@ Check **"Send All Properties (ignores template)"** Once the webhook has been configured, remember to click on **Save**. !!! note - - If you are using the 'Item Added' notification, be sure to enable it in the notifications settings, otherwise it won't work. + If you are using the 'Item Added' notification, be sure to enable it in the notifications settings, otherwise it won't work. Dashboard > Notifications > New content added You can also change how often Jellyfin notifies you of new items by changing the intervals of the scheduled task. Dashboard > Scheduled Tasks > Webhook Item Added Notifier @@ -104,14 +100,11 @@ Once the webhook has been configured, remember to click on **Save**. --- !!! info - - If your webhook isn't working, start debugging by adding webhooks to your logging configuration. + If your webhook isn't working, start debugging by adding webhooks to your logging configuration. Amend your Jellyfin's logging.json file to enable webhook debugging by adding `"Jellyfin.Plugin.Webhook": "Debug"` !!! warning - Remember to add a comma after `"System": "Warning"` to avoid formatting errors. - ```diff { "Serilog": { @@ -123,5 +116,4 @@ Once the webhook has been configured, remember to click on **Save**. + "Jellyfin.Plugin.Webhook": "Debug" } } - ``` diff --git a/docs/pages/integrations/jellyseerr.md b/docs/pages/integrations/jellyseerr.md index a2cb729..8c36fa7 100644 --- a/docs/pages/integrations/jellyseerr.md +++ b/docs/pages/integrations/jellyseerr.md @@ -1,7 +1,6 @@ # Jellyseerr !!! question "jellyseerr notifications" - If you have any issues setting up notifications for jellyseerr refer to this [wiki](https://docs.jellyseerr.dev/using-jellyseerr/notifications) --- @@ -34,7 +33,6 @@ 3. Notification Color !!! note - **Be sure to save settings** --- diff --git a/docs/pages/integrations/kometa.md b/docs/pages/integrations/kometa.md index f90ba6d..f79808c 100644 --- a/docs/pages/integrations/kometa.md +++ b/docs/pages/integrations/kometa.md @@ -3,7 +3,6 @@ ## Webhook Types !!! info - As of December 2022, this integration can send 5 webhooks. You can either activate them by ticking the on/off buttons or clicking on the gear icon where you can pic your notifications’ colours as well. ![notifiarr_pmm_toggles.png](../../assets/screenshots/integrations/plexmetamanger/notifiarr_pmm_toggles.png) @@ -22,14 +21,12 @@ The Notifiarr client on your local machine is not required for this integration ## Kometa Config File In order to activate Notifiarr on Kometa, you need to edit the yml config file and add the following: - ```yaml notifiarr: apikey: YOURKEY ``` Kometa is web-hook agnostic hence you need to instruct it where to send the webhooks. Inside the config file edit the following: - ```yaml webhooks: error: notifiarr diff --git a/docs/pages/integrations/lidarr.md b/docs/pages/integrations/lidarr.md index 4996f84..65c0791 100644 --- a/docs/pages/integrations/lidarr.md +++ b/docs/pages/integrations/lidarr.md @@ -1,12 +1,13 @@ # Lidarr !!! info "Lidarr" - This integration allows for notifications from Lidarr using its built in Connection for **Notifiarr**. In Lidarr click Settings → Connect → Notifiarr ## Current Versions -![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Master&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/master/changes){ .off-glb } ![Current Develop/Beta](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/develop/changes){ .off-glb } ![Current Nightly/Unstable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Nightly&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/nightly/changes){ .off-glb } +![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Master&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/master/changes){ .off-glb } +![Current Develop/Beta](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/develop/changes){ .off-glb } +![Current Nightly/Unstable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Nightly&query=%24%5B0%5D.version&url=https://lidarr.servarr.com/v1/update/nightly/changes){ .off-glb } --- diff --git a/docs/pages/integrations/logWatch.md b/docs/pages/integrations/logWatch.md index 9bde1de..adfb7be 100644 --- a/docs/pages/integrations/logWatch.md +++ b/docs/pages/integrations/logWatch.md @@ -12,9 +12,9 @@ This allows the Notifiarr Client to watch (log) files for lines matching a regul Below are community suggested expressions -| App | Regular Expression | Skip Expression | Regular Explanation | Skip Explanation | -| -------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| Radarr | `(?i)(\|warn\||\|error\||^\[v5.+\])` | `(?i)Movie with IMDBId|It will not be added|Invalid date found|Validation failed|An unhandled exception has occurred while executing the request.|HttpClient error` | Notify on all Warnings, Errors, and Stack Traces (Version Number) | Skip movie add errors. Skip Indexer Feed invalid date Errors. Skip Errors saying there was an Error | +| App | Regular Expression | Skip Expression | Regular Explanation | Skip Explanation | +| --- | ------------------ | --------------- | ------------------- | ---------------- | +| Radarr | `(?i)(\|warn\||\|error\||^\[v5.+\])` | `(?i)Movie with IMDBId|It will not be added|Invalid date found|Validation failed|An unhandled exception has occurred while executing the request.|HttpClient error` | Notify on all Warnings, Errors, and Stack Traces (Version Number) | Skip movie add errors. Skip Indexer Feed invalid date Errors. Skip Errors saying there was an Error | | Sonarr | `(?i)(\|warn\||\|error\||^\[v4.+\])` | `(?i)Invalid date found|Validation failed|An unhandled exception has occurred while executing the request.|Unable to find exact quality|HttpClient error` | Notify on all Warnings, Errors, and Stack Traces (Version Number) | Skip Indexer Feed invalid date Errors. Skip Errors saying there was an Error. Skip unknown quality errors. | | Prowlarr | `(?i)(\|warn\||\|error\||^\[v1.+\])` | `(?i)Validation failed|An unhandled exception has occurred while executing the request|[?:CinemaZ|PrivateHD](.a-z0-9/=&?: )+404\.NotFound|HttpClient error` | Notify on all Warnings, Errors, and Stack Traces (Version Number) | Skip Errors saying there was an error. Skip Cinemaz/PrivateHD 404 (NotFound Errors) | | Readarr | `(?i)(\|warn\||\|error\||^\[v1.+\])` | `(?i)Validation failed|An unhandled exception has occurred while executing the request.|HttpClient error` | Notify on all Warnings, Errors, and Stack Traces (Version Number) | Skip Errors saying there was an error. | diff --git a/docs/pages/integrations/mdblist.md b/docs/pages/integrations/mdblist.md index b920195..6d37851 100644 --- a/docs/pages/integrations/mdblist.md +++ b/docs/pages/integrations/mdblist.md @@ -2,7 +2,7 @@ ## What is MDBList -MDBList is a 3rd party service that allows you to curate lists of shows and movies from various sources and can be found [here](https://mdblist.com), this integration is meant to do three things: +MDBList is a 3rd party service that allows you to curate lists of shows and movies from various sources and [can be found here](https://mdblist.com), this integration is meant to do three things: 1. Allow for the ability to add individual shows or movies to Radarr or Sonarr using the add button on the show item on the MDBList website diff --git a/docs/pages/integrations/mediaRequests.md b/docs/pages/integrations/mediaRequests.md index 9457350..5397bdf 100644 --- a/docs/pages/integrations/mediaRequests.md +++ b/docs/pages/integrations/mediaRequests.md @@ -1,7 +1,6 @@ # Media Requests !!! info - This integration allows for requesting media via Discord. ## Currently Supported Applications diff --git a/docs/pages/integrations/network.md b/docs/pages/integrations/network.md index 0f5c81a..1861593 100644 --- a/docs/pages/integrations/network.md +++ b/docs/pages/integrations/network.md @@ -1,7 +1,6 @@ # network !!! info - This integration allows for notifications from the local Notifiarr client app to monitor network machines or services. ## Network Overview diff --git a/docs/pages/integrations/overseerr.md b/docs/pages/integrations/overseerr.md index 644c08a..7249ce4 100644 --- a/docs/pages/integrations/overseerr.md +++ b/docs/pages/integrations/overseerr.md @@ -30,7 +30,6 @@ 3. Notification Color !!! note - **Be sure to save settings** --- diff --git a/docs/pages/integrations/persistent.md b/docs/pages/integrations/persistent.md index 3653e0f..bada350 100644 --- a/docs/pages/integrations/persistent.md +++ b/docs/pages/integrations/persistent.md @@ -1,7 +1,6 @@ # Persistent !!! info - This integration allows for notifications to always stay in the channel. Anytime someone posts, it will remove its previous post and readd it to the bottom of the channel. ## Trigger options diff --git a/docs/pages/integrations/plex.md b/docs/pages/integrations/plex.md index 6b98b98..8c8b7f4 100644 --- a/docs/pages/integrations/plex.md +++ b/docs/pages/integrations/plex.md @@ -1,7 +1,6 @@ # Plex !!! info - This integration allows for notifications from Plex. Keep in mind this utilizes the [Notifiarr client](../../pages/client/install.md) ## Current Version @@ -137,8 +136,8 @@ This integration requires the Notifiarr client to be running locally. You can ge ### Webhook !!! info - - [Plex Webhooks](https://support.plex.tv/articles/115002267687-webhooks/) from Plex to the Client require [Plexpass](https://www.plex.tv/plex-pass/) + [Plex Webhooks](https://support.plex.tv/articles/115002267687-webhooks/) from Plex to the Client require + [Plexpass](https://www.plex.tv/plex-pass/) In Plex, [add a webhook](https://app.plex.tv/desktop/#!/settings/webhooks) that points to `http://localhost:port/plex?token=plex-token-here` diff --git a/docs/pages/integrations/prowlarr.md b/docs/pages/integrations/prowlarr.md index 6050757..bfa30fc 100644 --- a/docs/pages/integrations/prowlarr.md +++ b/docs/pages/integrations/prowlarr.md @@ -1,7 +1,6 @@ # Prowlarr !!! info - This integration is for setting up discord notifications for Prowlarr ## Trigger options @@ -29,8 +28,8 @@ 2. If you already have the client setup and configured use the `Add Notifiarr Connect` to automatically add the connect to prowlarr. !!! info - - We can see the connect has been added via Prowlarr → Settings → Notifications → Connections, You should also have recieved a test notification. + We can see the connect has been added via Prowlarr → Settings → Notifications → Connections, + You should also have received a test notification. Prowlarr Connect | Test Notification :-------------------------:|:-------------------------: diff --git a/docs/pages/integrations/radarr.md b/docs/pages/integrations/radarr.md index 0fbcb1f..60dc799 100644 --- a/docs/pages/integrations/radarr.md +++ b/docs/pages/integrations/radarr.md @@ -1,14 +1,15 @@ # Radarr !!! info - This integration allows for notifications from Radarr using its built in Connection for **Notifiarr**. In Radarr click Settings → Connect → + → Notifiarr --- ## Current Versions -![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Master&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/master/changes){ .off-glb } ![Current Develop/Beta](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/develop/changes){ .off-glb } ![Current Nightly/Unstable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Nightly&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/nightly/changes){ .off-glb } +![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Master&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/master/changes){ .off-glb } +![Current Develop/Beta](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/develop/changes){ .off-glb } +![Current Nightly/Unstable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Nightly&query=%24%5B0%5D.version&url=https://radarr.servarr.com/v1/update/nightly/changes){ .off-glb } --- diff --git a/docs/pages/integrations/readarr.md b/docs/pages/integrations/readarr.md index 4a3ad6f..4e6d6fe 100644 --- a/docs/pages/integrations/readarr.md +++ b/docs/pages/integrations/readarr.md @@ -1,7 +1,6 @@ # Readarr !!! info - This integration allows for notifications from Readarr using its built in Connection for **Notifiarr**. In Readarr click Settings → Connect → + → Notifiarr --- diff --git a/docs/pages/integrations/reddit.md b/docs/pages/integrations/reddit.md index e51064c..74e1c14 100644 --- a/docs/pages/integrations/reddit.md +++ b/docs/pages/integrations/reddit.md @@ -1,7 +1,6 @@ # Reddit !!! info - This integration allows for notifications from subreddits you choose to watch --- diff --git a/docs/pages/integrations/releaseParser.md b/docs/pages/integrations/releaseParser.md index 5e93b15..3ec4b0e 100644 --- a/docs/pages/integrations/releaseParser.md +++ b/docs/pages/integrations/releaseParser.md @@ -1,7 +1,6 @@ # Release Parser !!! info - This integration allows for users to parse a release name in the same method Radarr and Sonarr do to see how the name will be treated. ## Trigger options diff --git a/docs/pages/integrations/sonarr.md b/docs/pages/integrations/sonarr.md index 45912c8..1604a2c 100644 --- a/docs/pages/integrations/sonarr.md +++ b/docs/pages/integrations/sonarr.md @@ -1,12 +1,12 @@ # Sonarr !!! info - This integration allows for notifications from Sonarr using the connect for Webhooks. In Sonarr click Settings → Connect → + → Webhook. ## Current Versions -![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Main&query=%24%5B%27v4-stable%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb } ![Current Develop/Nightly](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B%27v4-nightly%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb } +![Current Master/Stable](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Main&query=%24%5B%27v4-stable%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb } +![Current Develop/Nightly](https://img.shields.io/badge/dynamic/json?color=526cfe&style=for-the-badge&label=Develop&query=%24%5B%27v4-nightly%27%5D.version&url=https%3A%2F%2Fservices.sonarr.tv%2Fv1%2Freleases){ .off-glb } ## Trigger options diff --git a/docs/pages/integrations/trash.md b/docs/pages/integrations/trash.md index a04c467..fc6d5b6 100644 --- a/docs/pages/integrations/trash.md +++ b/docs/pages/integrations/trash.md @@ -1,7 +1,6 @@ # TRaSH !!! info "TRaSH" - This integration allows you to setup and sync TRaSH guides with Radarr and Sonarr. Keep in mind this requires the Notifiarr client. !!! warning "patrons/subscribers" @@ -54,7 +53,6 @@ ![trigger-channels.png](../../assets/screenshots/integrations/trash/trigger-channels.png) 1. `CFs/Scores` - The amount of CF's and scores you have synced. - 2. `Channel` - Which channel to send TRaSH update notifications to (when TRaSH updates them, removes them, when you sync them or unsync them) ## Getting Started @@ -87,9 +85,7 @@ here we can manange existing profiles or add new profiles/link predefined TRaSH ![profiles-1.png](../../assets/screenshots/integrations/trash/profiles-1.png) 1. `Sync` - Enable this to sync your profile. - 2. `Starr instance profile` - Either create a new profile or select one of the TRaSH profiles available. - 3. `Profile name` - Here you can set your profile name **This needs to be unique**. !!! Note @@ -106,13 +102,9 @@ here we can manange existing profiles or add new profiles/link predefined TRaSH ![profile-customization-1.png](../../assets/screenshots/integrations/trash/profile-customization-1.png) 1. `Language` - If you want to sync your prefered language, **Disable this if you plan to use something other then the TRaSH default. - 2. `Upgrades allowed` - Enable this if you plan to allow upgrades in your profile. - 3. `Minimum score` - Enable this to set the minimum download score to 0. - 4. `Minimum upgrade score` - enable this to set the minimim score increase to allow a upgrade. - 5. `Cutoff score` - Enable this to set the cutoff score. **default set 10000** ### Quality Settings @@ -123,7 +115,6 @@ here we can manange existing profiles or add new profiles/link predefined TRaSH ![quality.png](../../assets/screenshots/integrations/trash/quality.png) 1. `Cutoff quality` - Cutoff quality is the quality that you want your starr instance to stop upgrading at. `Bluray-1080p` - 2. `Qualities` - You can choose to either match the TRaSH quality groups, or you can set this to allow custom set groups. For example we want to use the TRaSH `HD Bluray + WEB` profile but we don't want to include `720p`. ### Custom Formats "CF" @@ -131,7 +122,6 @@ here we can manange existing profiles or add new profiles/link predefined TRaSH ![custom-formats-1.png](../../assets/screenshots/integrations/trash/custom-formats-1.png) 1. `Add` - You can choose to either automatically add new formats, add missing formats, or add none. - 2. `Remove` - You can choose to remove custom scores on each sync, or if you want to set your own scores you would want to `allow custom scores from formats assigned to this profile`. If your planning to set scores different then what TRaSH has then you would want to set this to `allow`. 3. `Groups` - This is where you can select each group that you want in your profile sync, along with the available CF's within that group. @@ -144,7 +134,6 @@ here we can manange existing profiles or add new profiles/link predefined TRaSH ![formats-1.png](../../assets/screenshots/integrations/trash/formats-1.png) 1. `Sync TRaSH CF names` - If you want to sync the names set for the TRaSH CFs. - 2. `Interactive flowchart` - Useful interactive flow charts for TRaSH profiles. ### Scores @@ -154,11 +143,8 @@ Here you can setup custom scores to your liking, and choose to sync them. ![scores-1.png](../../assets/screenshots/integrations/trash/scores-1.png) 1. `Filter` - Filter between witch profile you're editing/looking at. - 2. `Multiplier` - (multiplier * TRaSH = your score) - 3. `Starr score/Custom` - Here you can set personal scores while still keeping your CF's in sync. - 4. `Sync` - Check-box to enable sync. ## Quality @@ -168,9 +154,7 @@ Here you can edit quality names within a specific group and choose to sync them ![quality-1.png](../../assets/screenshots/integrations/trash/quality-1.png) 1. `Definition group`- Here you can choose the starr profile, that you plan to edit or change. - 2. `Rename Field` - This is where you can customize the name of a quality. - 3. `Sync` - Check-box to enable sync. ### Naming @@ -184,21 +168,12 @@ Here you can choose a default TRaSH naming scheme for your media. There are reco ![formats-1.png](../../assets/screenshots/integrations/trash/delete-formats.png) 1. `Fix Map` - This will open the mapping tool options. - 2. `Enable sync` - This will re-enable all the CF toggles, this is useful if you want to change the selected CF's. - 3. `Enable sync + scores` - This will re-enable all the CF toggles, and scores. This is useful if you want to change CF's and scores. - 4. `Unlink starr` - This will unlink your starr id's from the map. This is useful if your moving your starr install to a different server or if your changing databases. - 5. `Relink starr` - This will attempt to re-link your starr instance id's and CF's to the map. - 6. `Delete map` - This will delete all of your sync settings. Useful for starting fresh. - -7. `Delete Selected CFs` - This will delete all of the selected CF's in your profile. - +7. `Delete Selected CFs` - This will delete all of the selected CF's in your profile. 8. `Delete Selected CFs & Map` - This will delete all of your CF's and the profile mapping. - 9. `Fresh Start CFs` - This will delete all the formats but leave the map so a sync would put everything back that is in sync. This is useful to clean things up without loosing your sync settings. - 10. `Fresh Start All` - This would delete all CF's/scores/ect. Only do this if you want to nuke everything and start over. diff --git a/docs/pages/integrations/unpackerr.md b/docs/pages/integrations/unpackerr.md index 0c1a575..e76be5d 100644 --- a/docs/pages/integrations/unpackerr.md +++ b/docs/pages/integrations/unpackerr.md @@ -1,7 +1,6 @@ # Unpackerr !!! info - This integration provides [Unpackerr](https://golift.io/unpackerr) notifications and reactions. You may choose to have either a reaction placed on existing Starr notifications, or receive a stand alone message for Unpackerr notifications, or both. Selecting the *Reactions* box enables or disables the Reaction emoji. diff --git a/docs/pages/integrations/uptimekuma.md b/docs/pages/integrations/uptimekuma.md index d0a9f1a..5496238 100644 --- a/docs/pages/integrations/uptimekuma.md +++ b/docs/pages/integrations/uptimekuma.md @@ -1,7 +1,6 @@ # Uptime-Kuma !!! note - setup notifications for Uptime Kuma ## Trigger Options @@ -16,7 +15,6 @@ ![instructions.png](../../assets/screenshots/integrations/uptimekuma/instructions.png) !!! info - Add the webhook too your Uptime Kuma via Uptime-Kuma → Settings → Notifications → Setup Notifications ![uptime-webhook](../../assets/screenshots/integrations/uptimekuma/uptime-webhook.png) diff --git a/docs/pages/integrations/websitestatus.md b/docs/pages/integrations/websitestatus.md index 16fd627..a7834c3 100644 --- a/docs/pages/integrations/websitestatus.md +++ b/docs/pages/integrations/websitestatus.md @@ -1,7 +1,6 @@ # Website Status !!! info - This integration allows for notifications based on website status. ## Trigger options diff --git a/docs/pages/integrations/whisparr.md b/docs/pages/integrations/whisparr.md index b6e27e1..c821e05 100644 --- a/docs/pages/integrations/whisparr.md +++ b/docs/pages/integrations/whisparr.md @@ -1,11 +1,9 @@ # Whisparr !!! info - This integration is for setting up discord notifications for Whisparr !!! Warning "Whisparr" - **NSFW content will not be shown** ## Trigger options @@ -34,7 +32,6 @@ 1. Instructions on how to setup the notifiarr connect in prowlarr !!! info - Add the Connect using its built in Connection for **Notifiarr**. In Whisparr click Settings → Connect → + → Notifiarr, once done correctly you will recieve a test notification :smile: Whisparr Connect | Test Notification diff --git a/docs/pages/quickstart/quickStart.md b/docs/pages/quickstart/quickStart.md index 4dab3fa..840343c 100644 --- a/docs/pages/quickstart/quickStart.md +++ b/docs/pages/quickstart/quickStart.md @@ -13,4 +13,8 @@ Once the client is setup locally and you can see it internally (example: `localh ## Integrations -First thing, [turn on a couple](../../pages/website/integrationsSetup.md#main-setup) that you want to use (or all of them at once that you want to use if you want but less is more while learning). Once you have them turned on the page will reload and you'll see a card for each one. If you cant figure out how to turn things on etc, each integration has a wiki page for it (well most do). Click the `Wiki` link in the integration card to get more information about that specific one. +First thing, [turn on a couple](../../pages/website/integrationsSetup.md#main-setup) that you want to use +(or all of them at once that you want to use if you want but less is more while learning). +Once you have them turned on the page will reload and you'll see a card for each one. +If you cant figure out how to turn things on etc, each integration has a wiki page for it (well most do). +Click the `Wiki` link in the integration card to get more information about that specific one. diff --git a/docs/pages/website/clientConfig.md b/docs/pages/website/clientConfig.md index b260933..ab9a376 100644 --- a/docs/pages/website/clientConfig.md +++ b/docs/pages/website/clientConfig.md @@ -14,7 +14,7 @@ When you open the client settings you will see: 1. Client list: Each client you have configured will show up as a tab so its settings can be modified 2. This section is information about the local client and its host environment -3. This is the automatically configured `Tunnel URL` to the client so the site can communicate with the locally installed client +3. This is the automatically configured `Tunnel URL` to the client so the site can communicate with the locally installed client 4. This is the connection status, if it isn't green then the site can not reach the client. See [Errors](#errors) below. 5. Use this client for timers that are not part of a specific integration (non client integrated timers, daily overview posts for example) 6. Client triggers: If the URL is provided, you can trigger the client to run any of these actions by clicking the cloud icon diff --git a/mkdocs.yml b/mkdocs.yml index 9ae3af7..59501b4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,83 +7,83 @@ repo_url: https://github.com/Notifiarr/mkdocs-wiki nav: - Notifiarr: - - About: index.md + - About: index.md - Quick Start: - - Quick Start: pages/quickstart/quickStart.md + - Quick Start: pages/quickstart/quickStart.md - Client: - - Install: pages/client/install.md - - Client configuration: pages/client/configuration.md - - Client UI: pages/client/gui.md - - Cloudflare config: pages/client/cloudflare.md - - Reverse proxy: pages/client/reverseProxy.md - - Setup: pages/client/setup.md + - Install: pages/client/install.md + - Client configuration: pages/client/configuration.md + - Client UI: pages/client/gui.md + - Cloudflare config: pages/client/cloudflare.md + - Reverse proxy: pages/client/reverseProxy.md + - Setup: pages/client/setup.md - Website: - - Client setup: pages/website/clientConfig.md - - Integrations setup: pages/website/integrationsSetup.md - - Media requests: pages/website/mediaRequests.md - - Notification history: pages/website/notificationHistory.md - - Transcode history: pages/website/transcodeHistory.md - - Trending: pages/website/trending.md - - Translations: pages/website/translations.md - - Metrics: pages/website/metrics.md + - Client setup: pages/website/clientConfig.md + - Integrations setup: pages/website/integrationsSetup.md + - Media requests: pages/website/mediaRequests.md + - Notification history: pages/website/notificationHistory.md + - Transcode history: pages/website/transcodeHistory.md + - Trending: pages/website/trending.md + - Translations: pages/website/translations.md + - Metrics: pages/website/metrics.md - Integrations: - - How To Setup Integrations: pages/integrations/basicUsage.md - - Apprise: pages/integrations/apprise.md - - Authentik: pages/integrations/authentik.md - - Autobrr: pages/integrations/autobrr.md - - Bazarr: pages/integrations/bazarr.md - - Better Stack: pages/integrations/betterstack.md - - Channel Stats: pages/integrations/channelstats.md - - Cronitor: pages/integrations/cronitor.md - - Cross Seed: pages/integrations/crossseed.md - - Crowdsec: pages/integrations/crowdsec.md - - Dashboard: pages/integrations/dashboard.md - - Discord App: pages/integrations/discordApp.md - - DockWatch: pages/integrations/dockwatch.md - - Duplicacy: pages/integrations/duplicacy.md - - Emby: pages/integrations/emby.md - - Fail2ban: pages/integrations/fail2ban.md - - Github: pages/integrations/github.md - - Hotio: pages/integrations/hotio.md - - Jellyfin: pages/integrations/jellyfin.md - - Jellyseerr: pages/integrations/jellyseerr.md - - Kometa: pages/integrations/kometa.md - - Lidarr: pages/integrations/lidarr.md - - Log Watcher: pages/integrations/logWatch.md - - MDBList: pages/integrations/mdblist.md - - Media Requests: pages/integrations/mediaRequests.md - - Network: pages/integrations/network.md - - Overseerr: pages/integrations/overseerr.md - - Package Manager: pages/integrations/packagemanager.md - - Passthrough: pages/integrations/passthrough.md - - Persistent: pages/integrations/persistent.md - - Plex: pages/integrations/plex.md - - Prowlarr: pages/integrations/prowlarr.md - - Qbit Manage: pages/integrations/qbitmanage.md - - Radarr: pages/integrations/radarr.md - - Readarr: pages/integrations/readarr.md - - Reciperr: pages/integrations/reciperr.md - - Reddit: pages/integrations/reddit.md - - Release Parser: pages/integrations/releaseParser.md - - RSS Watcher: pages/integrations/rssWatcher.md - - Simon Says: pages/integrations/simonSays.md - - Snapshots: pages/integrations/snapshots.md - - Sonarr: pages/integrations/sonarr.md - - Starr Proxy: pages/integrations/starrproxy.md - - Synology: pages/integrations/synology.md - - TRaSH: pages/integrations/trash.md - - Unpackerr: pages/integrations/unpackerr.md - - Uptime-Kuma: pages/integrations/uptimekuma.md - - Watchtower: pages/integrations/watchtower.md - - Website Status: pages/integrations/websitestatus.md - - Whisparr: pages/integrations/whisparr.md + - How To Setup Integrations: pages/integrations/basicUsage.md + - Apprise: pages/integrations/apprise.md + - Authentik: pages/integrations/authentik.md + - Autobrr: pages/integrations/autobrr.md + - Bazarr: pages/integrations/bazarr.md + - Better Stack: pages/integrations/betterstack.md + - Channel Stats: pages/integrations/channelstats.md + - Cronitor: pages/integrations/cronitor.md + - Cross Seed: pages/integrations/crossseed.md + - Crowdsec: pages/integrations/crowdsec.md + - Dashboard: pages/integrations/dashboard.md + - Discord App: pages/integrations/discordApp.md + - DockWatch: pages/integrations/dockwatch.md + - Duplicacy: pages/integrations/duplicacy.md + - Emby: pages/integrations/emby.md + - Fail2ban: pages/integrations/fail2ban.md + - Github: pages/integrations/github.md + - Hotio: pages/integrations/hotio.md + - Jellyfin: pages/integrations/jellyfin.md + - Jellyseerr: pages/integrations/jellyseerr.md + - Kometa: pages/integrations/kometa.md + - Lidarr: pages/integrations/lidarr.md + - Log Watcher: pages/integrations/logWatch.md + - MDBList: pages/integrations/mdblist.md + - Media Requests: pages/integrations/mediaRequests.md + - Network: pages/integrations/network.md + - Overseerr: pages/integrations/overseerr.md + - Package Manager: pages/integrations/packagemanager.md + - Passthrough: pages/integrations/passthrough.md + - Persistent: pages/integrations/persistent.md + - Plex: pages/integrations/plex.md + - Prowlarr: pages/integrations/prowlarr.md + - Qbit Manage: pages/integrations/qbitmanage.md + - Radarr: pages/integrations/radarr.md + - Readarr: pages/integrations/readarr.md + - Reciperr: pages/integrations/reciperr.md + - Reddit: pages/integrations/reddit.md + - Release Parser: pages/integrations/releaseParser.md + - RSS Watcher: pages/integrations/rssWatcher.md + - Simon Says: pages/integrations/simonSays.md + - Snapshots: pages/integrations/snapshots.md + - Sonarr: pages/integrations/sonarr.md + - Starr Proxy: pages/integrations/starrproxy.md + - Synology: pages/integrations/synology.md + - TRaSH: pages/integrations/trash.md + - Unpackerr: pages/integrations/unpackerr.md + - Uptime-Kuma: pages/integrations/uptimekuma.md + - Watchtower: pages/integrations/watchtower.md + - Website Status: pages/integrations/websitestatus.md + - Whisparr: pages/integrations/whisparr.md - Discord Bot: - - Permissions: pages/discordbot/permissions.md - - Custom Bot: pages/discordbot/custombot.md + - Permissions: pages/discordbot/permissions.md + - Custom Bot: pages/discordbot/custombot.md - Translations: - - Contribute: pages/translations/contribute.md - - Faq: - - Faq: pages/faq/faq.md + - Contribute: pages/translations/contribute.md + - Faq: + - Faq: pages/faq/faq.md theme: name: material @@ -108,15 +108,15 @@ theme: - search.suggest - search.highlight - search.share - + palette: - - media: "(prefers-color-scheme: dark)" + - media: '(prefers-color-scheme: dark)' scheme: slate primary: custom toggle: icon: material/weather-sunny name: Light mode - - media: "(prefers-color-scheme: light)" + - media: '(prefers-color-scheme: light)' scheme: default primary: custom toggle: @@ -152,4 +152,5 @@ markdown_extensions: alternate_style: true - md_in_html - toc: + toc_depth: 4 permalink: ''