Connor Johnstone
83 lines
3.5 KiB
Markdown
83 lines
3.5 KiB
Markdown
# 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.
|
|
|
|
## How monitoring differs from watching
|
|
|
|
- **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.
|
|
|
|
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.
|
|
|
|
## 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.
|
|
|
|
To stop monitoring an artist, click the **Monitor** button again to toggle it off.
|
|
|
|
## 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.
|
|
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.
|
|
|
|
## Automatic scheduling
|
|
|
|
Both the monitor check and the download pipeline run on configurable schedules:
|
|
|
|
| Task | Default interval | Config key |
|
|
|------|-----------------|------------|
|
|
| Monitor check | Every 12 hours | `scheduling.monitor_interval_hours` |
|
|
| Pipeline (Set Sail) | Every 3 hours | `scheduling.pipeline_interval_hours` |
|
|
|
|
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.
|
|
3. Within 3 hours, the pipeline runs automatically, downloading and processing the new tracks.
|
|
|
|
## Configuring schedules
|
|
|
|
In your config file:
|
|
|
|
```yaml
|
|
scheduling:
|
|
pipeline_enabled: true
|
|
pipeline_interval_hours: 3
|
|
monitor_enabled: true
|
|
monitor_interval_hours: 12
|
|
```
|
|
|
|
Or adjust these settings in the web UI under **Settings**.
|
|
|
|
To disable automatic scheduling entirely:
|
|
|
|
```yaml
|
|
scheduling:
|
|
pipeline_enabled: false
|
|
monitor_enabled: false
|
|
```
|
|
|
|
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.
|
|
|
|
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.
|