Tasks¶
This page allows you to direct the stash server to perform a variety of tasks.
Scanning¶
The scan function walks through the stash directories you have configured for new and moved files.
Stash currently identifies files by performing a quick file hash. This means that if the file is renamed for moved elsewhere within your configured stash directories, then the scan will detect this and update its database accordingly.
Stash currently ignores duplicate files. If two files contain identical content, only the first one it comes across is used.
The scan task accepts the following options:
| Option | Description |
|---|---|
| Generate scene covers | Generates scene covers for video files. |
| Generate previews | Generates video previews (mp4) which play when hovering over a scene. |
| Generate animated image previews | Also generate animated (webp) previews, only required when Scene/Marker Wall Preview Type is set to Animated Image. When browsing they use less CPU than the video previews, but are generated in addition to them and are larger files. |
| Generate scrubber sprites | The set of images displayed below the video player for easy navigation. |
| Generate perceptual hashes | Generates perceptual hashes for scene deduplication and identification. |
| Generate thumbnails for images | Generates thumbnails for image files. |
| Generate previews for image clips | Generates a gif/looping video as thumbnail for image clips/gifs. |
| Rescan | By default, Stash will only rescan existing files if the file's modified date has been updated since its previous scan. Stash will rescan files in the path when this option is enabled, regardless of the file modification time. Only required Stash needs to recalculate video/image metadata, or to rescan gallery zips. |
Auto Tagging¶
See the Auto Tagging page.
Scene Filename Parser¶
See the Scene Filename Parser page.
Generated Content¶
The scanning function automatically generates a screenshot of each scene. The generated content provides the following:
- Video or image previews that are played when mousing over the scene card
- Perceptual hashes - helps match against StashDB, and feeds the duplicate finder
- Sprites (scene stills for parts of each scene) that are shown in the scene scrubber
- Marker video previews that are shown in the markers page
- Transcoded versions of scenes. See below
- Image thumbnails of galleries
The generate task accepts the following options:
| Option | Description |
|---|---|
| Scene covers | Generates scene covers for video files. |
| Previews | Generates video previews (mp4) which play when hovering over a scene. |
| Animated image previews | Generates animated previews (webp). Only required if the Preview Type is set to Animated Image. Requires Generate previews to be enabled. |
| Scene Scrubber Sprites | The set of images displayed below the video player for easy navigation. |
| Markers Previews | Generates 20 second video previews (mp4) which begin at the marker timecode. |
| Marker Animated Image Previews | Also generate animated (webp) previews, only required when Scene/Marker Wall Preview Type is set to Animated Image. When browsing they use less CPU than the video previews, but are generated in addition to them and are larger files. |
| Marker Screenshots | Generates static JPG images for markers. Only required if Preview Type is set to Static Image. Requires Marker Previews to be enabled. |
| Transcodes | MP4 conversions of unsupported video formats. Allows direct streaming instead of live transcoding. |
| Perceptual hashes (for deduplication) | Generates perceptual hashes for scene deduplication and identification. |
| Generate heatmaps and speeds for interactive scenes | Generates heatmaps and speeds for interactive scenes. |
| Image Clip Previews | Generates a gif/looping video as thumbnail for image clips/gifs. |
| Overwrite existing generated files | By default, where a generated file exists, it is not regenerated. When this flag is enabled, then the generated files are regenerated. |
Transcodes¶
Web browsers support a limited number of video and audio codecs and containers. Stash will directly stream video files where the browser supports the codecs and container. Originally, stash did not support viewing scene videos where the browser did not support the codecs/container, and generating transcodes was a way of viewing these files.
Stash has since implemented live transcoding, so transcodes are essentially unnecessary now. Further, transcodes use up a significant amount of disk space and are not guaranteed to be lossless.
Image gallery thumbnails¶
These are generated when the gallery is first viewed, so generating them beforehand is not necessary.
Cleaning¶
This task will walk through your configured media directories and remove any scene from the database that can no longer be found. It will also remove generated files for scenes that subsequently no longer exist.
Care should be taken with this task, especially where the configured media directories may be inaccessible due to network issues.
Exporting and Importing¶
The import and export tasks read and write JSON files to the configured metadata directory. Import from file will merge your database with a file.
⚠️ Note: The full import task wipes the current database completely before importing.
See the JSON Specification page for details on the exported JSON format.