MeowcaTheoRange/LastFMDownloader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Web Scrobbler documentation

Browse source
This commit is contained in:
MeowcaTheoRange 2024-02-22 08:39:34 -06:00
parent aed9113b8d
commit 84b41c1530
1 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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.
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:
```
<NOTIFICATION_CLIENT_PROTOCOL>://<NOTIFICATION_CLIENT_INSTANCE>:<NOTIFICATION_CLIENT_PORT>/webscrobbler?password=<NOTIFICATION_SERVER_PASSWORD>
```
which may result in:
```
https://secret.abtmtr.link/webscrobbler?password=password123
```
Click "Add Webhook", and you have now set up the webhook.