Updated Service Widgets (markdown)

Ben Phelps
2022-09-12 13:06:10 +03:00
parent 3da45a1966
commit 95afbf075e

@@ -17,6 +17,11 @@ Using Emby as an example, this is how you would attach the Emby service widget.
key: st5XKXl8C0olqTHFPXNVCPIuU5bS6y
```
# Streaming Media Providers
Outgoing media streaming services, these widgets display current media information and controls.
## Emby
You can create an API key from inside Emby at `Settings > Advanced > Api Keys`
@@ -28,6 +33,7 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
## Jellyfin
You can create an API key from inside Jellyfin at `Settings > Advanced > Api Keys`.
@@ -39,6 +45,7 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
## Tautulli (Plex)
The Plex API is hard to work with and very segmented, to simplify integration, the Tautulli service is used instead. You can find the API key from inside Tautulli at `Settings > Web Interface > API`.
@@ -50,6 +57,11 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
# Media Management Tools
This includes the `arr` range of utilities, as well as media request management tools.
## Sonarr
Find your API key under `Settings > General`.
@@ -61,6 +73,7 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
## Radarr
Find your API key under `Settings > General`.
@@ -72,6 +85,19 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
## Readarr
Find your API key under `Settings > General`.
```yaml
widget:
type: readarr
url: http://readarr.host.or.ip
key: apikeyapikeyapikeyapikeyapikey
```
## Ombi
Find your API key under `Settings > Configuration > General`.
@@ -83,6 +109,35 @@ widget:
key: apikeyapikeyapikeyapikeyapikey
```
## Overseerr
Find your API key under `Settings > General > API Key`.
```yaml
widget:
type: overseerr
url: http://overseerr.host.or.ip
key: apikeyapikeyapikeyapikeyapikey
```
## Jellyseerr
Find your API key under `Settings > General > API Key`.
```yaml
widget:
type: jellyseerr
url: http://jellyseerr.host.or.ip
key: apikeyapikeyapikeyapikeyapikey
```
# Download Clients
Download clients, like Usenet and BitTorrent, as well as their utility services for tracker and list management.
## Nzbget
This widget uses the same authentication method as your browser when logging in (HTTP Basic Auth), and is often referred to as the ControlUsername and ControlPassword inside of Nzbget documentation.
@@ -95,6 +150,19 @@ widget:
password: controlpassword
```
## SABnzbd
Find your API key under `Config > General > API Key`.
```yaml
widget:
type: sabnzbd
url: http://sabnzbd.host.or.ip
key: apikeyapikeyapikeyapikeyapikey
```
## ruTorrent
This requires the `httprpc` plugin to be installed and enabled, and is part of the default ruTorrent plugins. If you have not explicitly removed or disable this plugin, it should be available.
@@ -107,6 +175,11 @@ widget:
password: password # optional, false if not used
```
# Networking Utilities
Includes things like proxy managers, DNS providers and network statistics.
## PiHole
PiHole does not require any authentication for the widget to work, as it uses the data that is exposed publicly.
@@ -118,6 +191,7 @@ widget:
proxy: true # Optional, only use if it doesn't work otherwise
```
## Portainer
You'll need to make sure you have the correct environment set for the integration to work properly. From the Environments section inside of Portainer, click the one you'd like to connect to and observe the ID at the end of the URL (should be), something like `#!/endpoints/1`, here `1` is the value to set as the `env` value.
@@ -132,6 +206,7 @@ widget:
key: ptr_accesskeyaccesskeyaccesskeyaccesskey
```
## Traefik
No extra configuration is required.
@@ -142,6 +217,7 @@ widget:
url: http://traefik.host.or.ip
```
## Speedtest Tracker
No extra configuration is required.
@@ -150,4 +226,36 @@ No extra configuration is required.
widget:
type: speedtest
url: http://speedtest.host.or.ip
```
# System Utilities & Services
System specific utilities and tools like message queues, databases, etc.
## Gotify
No extra configuration is required.
```yaml
widget:
type: gotify
url: http://gotify.host.or.ip
```
# Information Providers
Non service related items that display information from other sources, like stock monitoring or news.
## Coin Market Cap
Get your API key from your [CoinMarketCap Pro Dashboard](https://pro.coinmarketcap.com/account).
```yaml
widget:
type: coinmarketcap
currency: GBP # Optional
symbols: [BTC, LTC, ETH]
key: apikeyapikeyapikeyapikeyapikey
```