Updated docs
CI / check (push) Successful in 1m10s
CI / docker (push) Successful in 1m35s

This commit is contained in:
Connor Johnstone
2026-03-23 16:52:01 -04:00
parent 53b3a644a1
commit 6821427471
8 changed files with 65 additions and 103 deletions
+19 -17
View File
@@ -1,32 +1,38 @@
# Artist Monitoring
Monitoring lets Shanty automatically detect when your favorite artists release new music. When a new album or single is found, it is added to your watchlist and queued for download.
Monitoring lets Shanty automatically detect when your favorite artists release new music. When a new album or single is found, its tracks are added to your watchlist and queued for download.
## How monitoring differs from watching
## Watching tracks vs. monitoring artists
- **Watching** an artist means you have added some or all of their existing discography to your watchlist. Watched tracks go through the download pipeline.
- **Monitoring** an artist means Shanty periodically checks MusicBrainz for new releases that were not in the artist's discography when you first added them. When something new appears, it is automatically added to your watchlist.
In Shanty, **tracks** are what you watch. When you click "Watch All" on an artist page, every track in their current discography becomes a watched track. Those watched tracks get synced, downloaded, tagged, and organized by the pipeline.
You can watch an artist without monitoring them (just download their existing catalog), and you can monitor a watched artist to stay up to date with new releases.
**Monitoring** is different. Monitoring an artist means Shanty periodically checks MusicBrainz for new release groups (albums, singles, EPs) that did not exist when you last looked. When new releases are found, their tracks are automatically added to your watchlist.
In short:
- **Watching** is about tracks: "I want these specific tracks in my library."
- **Monitoring** is about artists: "Tell me when this artist puts out something new, and watch those tracks for me automatically."
You can watch tracks from an artist without monitoring them (just grab their existing catalog and move on). You can also monitor an artist to stay current with future releases.
## How to set up
1. Open the Shanty web UI and navigate to an artist's page (search for them or open them from your library).
2. Click the **Monitor** button on the artist page.
3. The artist is now monitored. A badge indicates their monitoring status.
3. The artist is now monitored. A "Monitored" badge appears next to their name, and a checkmark shows in the Library view.
To stop monitoring an artist, click the **Monitor** button again to toggle it off.
To stop monitoring an artist, click the **Unmonitor** button on their page.
## How it works
When monitoring is enabled, Shanty runs a background check on a schedule:
1. For each monitored artist, it fetches the current list of release groups from MusicBrainz.
2. It compares this against the release groups already in the watchlist.
3. Any new release groups (albums, singles, EPs) are expanded into individual track wanted_items and added to the watchlist.
2. It compares this against the tracks already in your watchlist.
3. Any new release groups are expanded into individual tracks and added to the watchlist.
4. The artist's `last_checked_at` timestamp is updated.
If you have the pipeline scheduler enabled (the default), new releases are automatically downloaded on the next pipeline run.
If you have the pipeline scheduler enabled (the default), new tracks are automatically downloaded on the next pipeline run.
## Automatic scheduling
@@ -40,7 +46,7 @@ Both the monitor check and the download pipeline run on configurable schedules:
This means that in the default configuration:
1. The monitor checks for new releases every 12 hours.
2. If new releases are found, they are added to the watchlist.
2. If new releases are found, their tracks are added to the watchlist.
3. Within 3 hours, the pipeline runs automatically, downloading and processing the new tracks.
## Configuring schedules
@@ -69,14 +75,10 @@ When disabled, you can still trigger checks manually from the Dashboard.
## Manual checks
You can trigger a monitor check at any time from the Dashboard by clicking **Check Monitored** (under the system actions). The results show how many artists were checked, how many new releases were found, and how many tracks were added.
You can trigger a monitor check at any time from the Dashboard by clicking **Check Monitored Artists** (under the individual actions). The results show how many artists were checked, how many new releases were found, and how many tracks were added.
Similarly, you can trigger the pipeline manually by clicking **Set Sail** at any time.
## Viewing monitored artists
The monitoring status is visible on each artist's page. You can also check the current monitor status via the API at `GET /api/monitor/status`, which returns a list of all monitored artists with their last check timestamps.
## Skipping scheduled runs
If you want to skip the next scheduled pipeline or monitor run without disabling them permanently, you can do so from the Dashboard. The skip is a one-time action -- the schedule resumes after the skipped run.
If you want to skip the next scheduled pipeline or monitor run without disabling them permanently, you can do so from the Dashboard. The skip is a one-time action -- the schedule resumes normally after the skipped run.