[READ-ONLY] Mirror of https://github.com/FoxxMD/tautulli-notification-digest. Consolidate Tautuilli Notification agent events for discord
digest
discord
newsletter
notification
plex
tautulli
tautulli-api
webhook
docs: Add quick start
+41
-1
+41
-1
README.md
+41
-1
README.md
···
4
4
5
5
<!-- TOC -->
6
6
* [What Does It Do?](#what-does-it-do)
7
+
* [Quick Start](#quick-start)
7
8
* [Install](#install)
8
9
* [Docker](#docker)
9
10
* [Local (Node)](#local-node)
···
45
46
<img src="/docs/assets/thumbnail-multiple.png"
46
47
alt="thumbnail view" width="400">
47
48
49
+
# Quick Start
50
+
51
+
Assuming:
52
+
53
+
* Host machine IP is 192.168.1.101
54
+
* Tautulli and TND will be installed on the same machine using Docker with bridge mode networking
55
+
* Discord webhook/notification agent already setup in Tautulli
56
+
* You want the digest to be posted at 5pm Eastern Standard Time
57
+
58
+
#### Setup Docker
59
+
60
+
* Include environmental variables for:
61
+
* Your existing discord webhook from Tautulli discord notification agent using `DISCORD_WEBHOOK`
62
+
* The 5pm cron expression using `CRON`
63
+
* Map the default port 8078
64
+
65
+
```shell
66
+
docker run -e DISCORD_WEBHOOK="https://discord.com/api/webhooks/606873513" -e CRON="0 17 * * *" -p 8078:8078 ghcr.io/foxxmd/tautuilli-notification-digest
67
+
```
68
+
69
+
TND endpoint is now available at `http://192.168.1.101:8078/my-digest`
70
+
71
+
#### Modify Tautulli
72
+
73
+
Edit your existing Tautuilli discord notification agent:
74
+
75
+
* On the **Configuration** tab
76
+
* Change **Discord Webhook URL** to `http://192.168.1.101:8078/my-digest`
77
+
* Make sure these settings are set
78
+
* ✅ Include Rich Metadata Info
79
+
* ✅ Include Summary
80
+
* ✅ Include Link to Plex Web (optional)
81
+
* ❎ Use Poster Thumbnail
82
+
* On the **Triggers**
83
+
* ✅ Recently Added
84
+
85
+
**Save** your changes. TND is now setup and running.
86
+
48
87
# Install
49
88
50
89
## Docker
···
69
108
In your agent ensure these settings are used:
70
109
71
110
* Configuration
72
-
* Discord Webhook Url
111
+
* Discord Webhook URL
73
112
* **TND location + Slug (see below)**
74
113
* ✅ Include Rich Metadata Info
75
114
* ✅ Include Summary
76
115
* ✅ Include Link to Plex Web (optional)
116
+
* ❎ Use Poster Thumbnail
77
117
* Triggers
78
118
* ✅ Recently Added
79
119