Skip to content

Commit

Permalink
docs: add page about monitors
Browse files Browse the repository at this point in the history
  • Loading branch information
Spark-NF committed Oct 3, 2023
1 parent 21114d1 commit d50133e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/docs/monitors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Monitors
---


## Introduction

When you never want to miss any image for one of your given searches, you might want to consider using a monitor. Monitors run from time to time in the background, and can either automatically download new images, or simply notify you when new images have appeared.

It works by checking for new images since the last time the monitor ran. It will **not** check images before that. Monitors are used for _incremental_ checks, not full checks. If you need to download all images for a given search, you should use a batch download instead. You could then setup a monitor if you want to download images that might be uploaded after your batch download is done running.


## Adding a monitor

Just perform the search that you want to monitor, then click the "Monitor" button at the bottom of the tab. Note that monitoring big searches might not be very efficient, so it is recommended to monitor more specific searches, like a single artist.


## Handling non-tagged images

Sometimes, images will be posted on your sources without proper tags or information. For example, some sources us a special `tagme` tag to indicate that. To avoid this, you can set a delay on a monitor. If you do so, it will ignore the most recent images and only download images that have been uploaded after the delay you've set.

So instead of checking images between `now` and `last check`, it will check images between `now - delay` and `last check - delay`.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ nav:
- Advanced:
- docs/shortcuts.md
- docs/metadata.md
- docs/monitors.md
- Tools:
- docs/tools/blacklist-fixer.md
- docs/tools/image-renamer.md
Expand Down

0 comments on commit d50133e

Please # to comment.