From 84b41c1530a6609c26122e0d1651d4b12a5e99db Mon Sep 17 00:00:00 2001 From: MeowcaTheoRange Date: Thu, 22 Feb 2024 08:39:34 -0600 Subject: [PATCH] Web Scrobbler documentation --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 47e4459..21244d0 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ NOTIFICATION_CLIENT_PROTOCOL= # https ##### NOTIFICATION_SERVER_INSTANCE -Mostly for testing, but if you're running your notification server seperate from LastFMDownloader (you shouldn't be, in production), fill this with your server's domain. Otherwise, use `localhost`. +Mostly for testing, but if you're running your notification server on a different machine from LastFMDownloader (you shouldn't be, in production), fill this with your server's domain. Otherwise, use `localhost`. ##### NOTIFICATION_SERVER_PORT @@ -122,7 +122,7 @@ This will be the port that your notification server runs on. Set this to any por ##### NOTIFICATION_SERVER_PASSWORD -This will be the password that LastFMDownloader will use to communicate messages to the notification server. Set it to something secure, or random. You won't have to type this in, so it can be as long as you want. +This will be the password that LastFMDownloader will use to communicate messages to the notification server. Set it to something secure, or random. You won't have to type this in (unless you want to use the [Web Scrobbler](#web-scrobbler) webhook), so it can be as long as you want. #### Systemd @@ -206,4 +206,22 @@ do done ``` -Running this script should notify you when you are connected to the server. If it sends a notification saying so, congratulations! You have successfully set up LastFMDownloader. \ No newline at end of file +Running this script should notify you when you are connected to the server. If it sends a notification saying so, congratulations! You have successfully set up LastFMDownloader. + +### Web Scrobbler + +You can use Web Scrobbler to notify LastFMDownloader when it has scrobbled a new song. + +Open the Web Scrobbler configuration, and go to **Accounts**. Under **Webhook**, enter any application name and then enter your API url, like this: + +``` +://:/webscrobbler?password= +``` + +which may result in: + +``` +https://secret.abtmtr.link/webscrobbler?password=password123 +``` + +Click "Add Webhook", and you have now set up the webhook. \ No newline at end of file