Update Tasks documentation (#2079)

This commit is contained in:
kermieisinthehouse
2021-12-13 01:20:43 +00:00
committed by GitHub
parent 9bd18c20af
commit d659411c61

View File

@@ -2,15 +2,13 @@
This page allows you to direct the stash server to perform a variety of tasks.
> **⚠️ Note:** It is currently only possible to run one task at a time. No queuing is currently implemented.
# Scanning
The scan function walks through the stash directories you have configured for new and moved files.
Stash currently identifies files by performing a full MD5 hash on them. 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 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 a file is detected with the same hash as a file already in the database (and that file still exists on the filesystem), then the duplicate file is ignored.
Stash currently ignores duplicate files. If two files contain identical content, only the first one it comes across is used.
The "Set name, data, details from metadata" option will parse the files metadata (where supported) and set the scene attributes accordingly. It has previously been noted that this information is frequently incorrect, so only use this option where you are certain that the metadata is correct in the files.
@@ -23,11 +21,12 @@ See the [Scene Filename Parser](/help/SceneFilenameParser.md) 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
* 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
* 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
## Transcodes
@@ -47,9 +46,9 @@ Care should be taken with this task, especially where the configured media direc
# Exporting and Importing
The import and export tasks read and write JSON files to the configured metadata directory.
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 import task wipes the current database completely before importing.
> **⚠️ Note:** The full import task wipes the current database completely before importing.
See the [JSON Specification](/help/JSONSpec.md) page for details on the exported JSON format.