-
-
- - - - Join our community - - - - -
-
@@ -2804,15 +2795,6 @@ GitHub sponsorship
-
-
- - - - Join our community - - - - -
-
@@ -2891,8 +2873,6 @@ GitHub sponsorship
Stash is a web application written in Go for serving and organizing your porn collection. It is self-hosted and released under AGPL-3.0 license. Stash currently supports Windows, macOS, Linux, FreeBSD and Docker.
-Join our community¶
-We are excited to announce that we have a new home for support, feature requests, and discussions related to Stash and its associated projects. Join our community on the Discourse forum to connect with other users, share your ideas, and get help from fellow enthusiasts.
About Stash¶
- Stash gathers information about videos in your collection from the internet, and is extensible through the use of community-built plugins for a large number of content producers and sites. @@ -2960,7 +2940,7 @@ GitHub sponsorship - May 1, 2025 + October 21, 2025 diff --git a/scripts/index.html b/scripts/index.html index 35dd77cc..978d3fb0 100644 --- a/scripts/index.html +++ b/scripts/index.html @@ -2806,6 +2806,34 @@ GitHub sponsorship + + + + + + GitHub + + + + + + diff --git a/scripts/list/index.html b/scripts/list/index.html index 7a1ea8c3..1d52ff50 100644 --- a/scripts/list/index.html +++ b/scripts/list/index.html @@ -3327,6 +3327,34 @@ GitHub sponsorship + + + + + + GitHub + + + + + + diff --git a/search/search_index.json b/search/search_index.json index 355b5f8a..f4c704eb 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"
- Stash gathers information about videos in your collection from the internet, and is extensible through the use of community-built plugins for a large number of content producers and sites.
- Stash supports a wide variety of both video and image formats.
- You can tag videos and find them later.
- Stash provides statistics about performers, tags, studios and more.
-
Community forum (recommended)
Primary place for community support, feature requests and discussions.
Browse forum
-
Discord
Real-time chat and community support.
Join Discord
-
Lemmy
Community discussions.
Visit Lemmy
- Spread the word: the more people that know about Stash, the more people can help with the tasks below.
- Help other users: we got new users coming in all the time that need assistance. Stopping in help channels/rooms now and again to assist can save developers some time.
- Write documentation: help to improve the Stash documentation.
- Contribute to the website: the website could definitely use some attention.
- Find bugs: test the software for bugs and create GitHub issues for them to help developers confirm and fix them faster.
- Write scrapers: if there is a site that isn't being scraped properly or at all, head on over to scrapers channel/room and see if you can't help scrape some metadata from a site.
- Populate StashDB: StashDB is our canonical database where we store metadata and hashes. You can submit info from your Stash instance to the database or just help to improve the already existing information.
- Support financially: Stash development runs on donations. Donations are collected through OpenCollective. You can do anonymous one-time donations or recurring donations.
- Sponsor on GitHub: You can sponsor the stashapp organization on GitHub via one-time or monthly donation.
- You can access the playground by navigating to
<server>:<port>/playground(default: http://localhost:9999/playground). - Click on the left to access the Documentation Explorer.
Stash is a web application written in Go for serving and organizing your porn collection. It is self-hosted and released under AGPL-3.0 license. Stash currently supports Windows, macOS, Linux, FreeBSD and Docker.
"},{"location":"#join-our-community","title":"Join our community","text":"We are excited to announce that we have a new home for support, feature requests, and discussions related to Stash and its associated projects. Join our community on the Discourse forum to connect with other users, share your ideas, and get help from fellow enthusiasts.
"},{"location":"#about-stash","title":"About Stash","text":"You can learn more about the software generally via the README on the official repository or via the Stash official website.
"},{"location":"#get-started","title":"Get started","text":"To get started go to Installation and download the latest version for your operating system.
"},{"location":"#support","title":"Support","text":"The Stash GraphQL API facilitates automated operations through a type-based schema that is both introspective and self-documenting.
Stash includes an integrated playground where users can execute queries and retrieve schema structures and documentation via a special introspection query.
All HTTP requests should be directed to
<server>:<port>/graphql(default:http://localhost:9999/graphql).Tip
For further information, visit the official GraphQL site.
"},{"location":"api/#authentication","title":"Authentication","text":"Include the API key generated in Stash in the header of every request. For details on obtaining the API Key, refer to Stash's in-app manual.
Example using curlReplace
<your_api_key>with your API Key found under Settings > Security > Authentication.Replace
<graphql_query>with the raw query, which can be formatted using the playground.
"},{"location":"api/#legacy-cookie-authentication","title":"Legacy cookie authentication","text":"curl -X POST -H \"ApiKey: <your_api_key>\" -H \"Content-Type: application/json\" --data '{ \"query\": \"<graphql_query>\" }' localhost:9999/graphql\nFor configurations using a username/password, cookies must be used for authentication.
Example using curlcurl --verbose --cookie-jar cookie.txt --data 'username=stash&password=**' localhost:9999/login\ncurl --cookie cookie.txt -H \"Content-Type: application/json\" --data '{ \"query\": \"<graphql_query>\" }' localhost:9999/graphql\nIt is recommended to use the
"},{"location":"code-of-conduct/","title":"Code of conduct","text":""},{"location":"code-of-conduct/#our-pledge","title":"Our Pledge","text":"API Keymethod over the legacy cookie method.We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
"},{"location":"code-of-conduct/#our-standards","title":"Our Standards","text":"Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery outside of areas that explicitly allow them, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
"},{"location":"code-of-conduct/#scope","title":"Scope","text":"This Code of Conduct applies within all community spaces, community servers, code repositories, and also applies when an individual is officially representing the community in public spaces.
"},{"location":"code-of-conduct/#enforcement","title":"Enforcement","text":"Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. You can contact Admin or Org Lead members directly via Discord or using an integrated report function on other platforms. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
"},{"location":"code-of-conduct/#enforcement-guidelines","title":"Enforcement Guidelines","text":"Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
"},{"location":"code-of-conduct/#warning","title":"Warning","text":"Offense: First time offence.
Consequence: A public or private written warning depending on the space where offense happened.
"},{"location":"code-of-conduct/#temporary-or-permanent-ban","title":"Temporary or Permanent Ban","text":"Offense: Second time offense.
Consequence: Temporary or permanent ban from any sort of public interaction within the community and removal of any previously given elevated permissions.
"},{"location":"code-of-conduct/#attribution","title":"Attribution","text":"This Code of Conduct is a modified and adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
"},{"location":"beginner-guides/exclude-file-configuration/","title":"Exclude file configuration","text":""},{"location":"beginner-guides/guide-to-scraping/","title":"Guide to Scraping","text":"The following is our recommended procedure for new Stash users who want to get info for their scenes as quickly, easily, and as accurately as possible. Pulling info directly from StashDB is still the best option, but unfortunately this will not always be possible. Alternative methods are also covered for when StashDB doesn't have what you need. This is an expanded version of @Scruffy's pinned post in the #stashdb-general channel in our Discord. Go there if you'd like something more succinct and direct. Hopefully this guide will reduce the pain and frustration for those who are lost and don't know where to start.
The following sections are in this particular order for a reason, so please follow this guide from the beginning.
"},{"location":"beginner-guides/guide-to-scraping/#generate-phashes","title":"Generate pHashes","text":"-
Navigate to the Settings page (\u2699 icon in top right), make sure you're on \"Tasks\" in the sidebar to the left, then find the first heading \"Library\" in the middle of the page. Make sure \"Generate perceptual hashes\" is turned on so pHashes will be created automatically each time you run a scan to add new scenes. This will slow down the scanning process, but for most users it's worth it. pHashes are the main way to match your scenes with our data on StashDB.
-
pHash generation is not turned on by default, so you'll need to generate them manually if you haven't already. This can be done on your entire library on the same Settings --> Tasks page, scroll down to the \"Generated Content\" heading. Make sure \"Perceptual hashes (for deduplication)\" is turned on and click the \"Generate\" button at the top. As long as \"Overwrite existing generated files\" is turned off, this will only generate missing files and hashes.
If you haven't set up StashDB in your Stash settings yet, now's the time to do it. The best way to do that is to follow this guide to Accessing StashDB. It includes step-by-step instructions for both signing up to StashDB and connecting your new account to Stash.
"},{"location":"beginner-guides/guide-to-scraping/#use-the-scene-tagger","title":"Use the Scene Tagger","text":"-
Go to your Scenes page on Stash and click the double \ud83d\udd16 icon to the far right of the search bar. This is your Scene Tagger view and should be your first choice for pulling data, not Identify / Autotag / Filename Parser / URL Scrapers / etc. Always use the Scene Tagger first, the rest are for users with more specific needs who understand the strengths and weaknesses of each tool.
Important
Tags are not created automatically. You need to click
+icon near the tag name to create it for you locally and attach it to the scene. Once it's created, it will match automatically in the future. -
First, click the \"Scrape All\" button. This will use your pHashes to find matching scenes on StashDB for every scene on the current page. The \"Scrape by fragment\" buttons will do the same thing but just for one scene at a time. Also, you may want to change your Scene Tagger settings with the \u2699 icon next to \"Scrape All.\" You can tell it to Merge (keep all) tags, Overwrite (keep only new) tags, or ignore StashDB's tags entirely (leave box unchecked). If you plan on contributing to StashDB, you should have \"Show male performers\" turned on to better follow these guidelines.
-
If your fingerprint search doesn't return a correct result for your scene, you can try searching with the \"Query\" field using title, performer, release date, or studio. Try to use as little text as possible to find your scene. Otherwise, unnecessary words that do not match StashDB's info may block correct results. If you can find the matching scene on StashDB.org but can't find it using the Scene Tagger, you can use the scene's StashID as your Tagger query.
-
Be sure to double-check that each selected result matches your scene before clicking the \"Save\" button at the bottom of each card. If you're confident that all of your saved matches are accurate, you may click the \"Submit fingerprints\" button after you're done. This will add your files' hashes to StashDB to make them easier for other users to find. But again, make sure your files were matched correctly first. The button will appear right next to the \"Scrape All\" button.
- If you are absolutely sure a scene isn't on StashDB anywhere, the next easiest method is to try ThePornDB. They have significantly more scenes than StashDB thanks to their automated scrapers, but their info isn't always as complete or accurate compared to StashDB's manually curated approach. They also don't have as many pHashes so matching scenes can be trickier as well. By using their Endpoint and submitting fingerprints to them when you have a good match via searching, you make life easier for everyone else scraping there.
{:style=\"counter-reset:none\"} 1. First step is to make an account at theporndb.net. With your account created, navigate to your API Tokens page. Type \"stash\" as your token's name (or whatever you'd prefer), make sure the \"read\" permission is checked (you don't need the others), and click the \"Create\" button. A pop-up will display your newly created token. Save your API token somewhere so you can find it later!. It will not be visible on ThePornDB's website after you close the pop-up. If you lose it, you may need to create a new one and repeat this entire setup process. This can be done in a password manager, notes app, or a well-placed text file.
\n- Go to the Settings page in Stash (http://localhost:9999/settings by default), click Metadata Providers on the left side and find Stash-box Endpoints at the top.
{:style=\"counter-reset:none\"} 1. Click Add and fill out the form that pops up: paste in your API key you created earlier amd enter
ThePornDB(or anything else you'd like, like TPDB) for Name, and enterhttps://theporndb.net/graphqlas the GraphQL endpoint.-
Click Test Credentials to make sure you've entered everything correctly, then click Confirm.
-
Finally, we can use the Scene Tagger to scrape from ThePornDB. First you'll need to switch to \"ThePornDB\" as the Tagger's source. It will always default to the first Stash-Box source, so you'll need to switch it every time you need something else. Use the same process here as we used with StashDB and the Scene Tagger. The \"Scrape All\" and \"Scrape by fragment\" buttons will match by using file hashes (pHash and oshash). If these don't give you the right results, you can try the \"Search\" button and customize your search terms as needed. Remember to use as few terms as possible in your search because unneccessary words that don't match ThePornDB's info may block correct results. You can also copy-paste additional terms from TPDB's page if you need to narrow down the Tagger's results more.
For those wanting to contribute to StashDB
As noted before, ThePornDB leans heavily on automated scrapers to pull all of their info. Often that data is incomplete or inaccurate compared to what we'd want on StashDB. Before you submit your scene to StashDB, you'll need to double-check your info, clean it up a bit first, and make sure you're following these guidelines. Submitting to StashDB is discussed further in the last step of this guide.
"},{"location":"beginner-guides/guide-to-scraping/#use-site-specific-scrapers","title":"Use Site-Specific Scrapers","text":"-
If you've already tried StashDB, you've already tried ThePornDB, and you still want to scrape a site directly, you can try using a site-specific scraper. However, every scraper is going to work differently. Some will need Python installed. Others will need you to set a user agent or a Chrome CDP path. A handful will need to be edited and configured first. Only a few can search a studio's website for the right scene. The entire process is much more advanced and is different for each scraper, which is why we recommend StashDB and TPDB first for new users. They can all be found in the same repo. You can download them individually, or you can download the entire repo as a zip archive.
-
First you'll want to search this page for your website to see if we have a scraper for it and to get an idea of what its requirements are. For most of these scrapers, you'll need to find and save a studio URL to your scene first. If you've managed to set up a fragment scraper, you can click on the \"Scrape with...\" button in the scene's edit tab to select your scraper. Typically fragment scrapers are better than URL scrapers. Otherwise, you'll need to click the button at the far right end of the URL field to run a URL scraper. It should light up when the field is filled with a URL that matches one of your installed scrapers. That's about as detailed as we can get in this guide for new users. If you've tried StashDB, tried TPDB, checked the relevant documentation, checked your logs, and still can't get one of these scrapers working, you can ask for help on Discord in the #help channel. More advanced discussions might be moved to the #scrapers channel
-
If you're certain a scene isn't on StashDB and you've found the info using ThePornDB or some other scraper, please consider submitting it to StashDB yourself. That way nobody else will have to duplicate the same work you've done for that particular scene if they can match their pHash with yours. You'll need to ask for edit privileges in our Discord and follow the guidelines on this website. In particular, please note that not every scene can be added to StashDB at this time. Some studios aren't allowed and full movies likely won't be eligible either.
-
Also, please don't blindly resubmit data gotten from ThePornDB. You should verify the data is correct and complete first, make sure the URL is right, check for any missing performers, and look up any relevant guidelines if something else seems funky to you. You should update your data within Stash before submitting a draft or you can edit the draft on StashDB itself before creating the edit. You should also have the studio URL now, so you should also compare with that page manually or even scrape again with a site-specific scraper as explained in the previous step of this guide. Also please note in your edit comment where your data is coming from.
Stash data is considered private, and Stash is not designed to be publicly exposed, except to trusted confidants. Stash has a built-in protection against accidentally exposing itself publicly outside of your network. If Stash receives a request from the public internet, and you do not have a password enabled, Stash will reject the request and stop handling requests to protect your privacy.
This often happens when you use the port-forwarding feature of your router or install Stash on a publicly accessible server, such as a VPS. When you do this, anybody in the world can access your Stash instance, so we enforce a password requirement. If your Stash instance has shutdown due to an insecure configuration, it will not handle requests again until you tell it that you have fixed the problem. After setting up either authentication, firewall, or removing your port forwarding rules, you can edit
"},{"location":"faq/setup/#alternative-and-safe-methods-to-access-your-stash","title":"Alternative and safe methods to access your Stash","text":".stash/config/config.ymland remove the keysecurity_tripwire_accessed_from_public_internet.You may use several methods to safely access Stash from outside of your home network. In the most basic, you can enable authentication in Stash, and re-enable port forwarding. You can also use a VPN solution that allows you to securely access your home network, such as Tailscale, Zerotier, Wireguard, or others.
"},{"location":"faq/setup/#using-an-external-authentication-provider","title":"Using an external authentication provider","text":"If you are an advanced user, and have secured your Stash instance behind an authwall provided by a reverse proxy or hosting solution, you may continue to use that. You simply have to edit
.stash/config/config.ymland setdangerous_allow_public_without_authtotrue. If you have already tripped the security feature, you will also have to remove thesecurity_tripwire_accessed_from_public_internetkey in order to allow Stash to serve requests.You will also have to disable Stash built-in authentication by clearing the username/password values in Security > Authentication > Credentials.
"},{"location":"getting-started/first-steps/","title":"First steps","text":""},{"location":"getting-started/first-steps/#setting-up-content-libraries","title":"Setting up content libraries","text":"- Go to Settings > Library and click Add Directory.
- To change the drive letter/volume, just type it in the field.
- Select the folder containing the content you want to add. It will select the folder and all sub-folders.
- Click Confirm.
- Go to Settings > Tasks.
- Select options you want based on your preferences, but keep in mind that every option increases time the scan will take.
- You can stop and re-scan it will ignore the files that are already scanned and just scan new or missing files.
- Go to Settings > Tasks.
- Click Scan to start scanning for the content from your setup libraries or Selective Scan... if you want to scan a specific location.
Info
If you decide to cancel the task in the queue, next time you will start the task, it will skip the files that were already scanned.
"},{"location":"guides/","title":"Guides","text":"In this section the community written guides will be published. You can submit your own via Stash-Docs repository.
If you find the guide has a typo or is outdated you can submit a pull request to fix it or make an issue on the GitHub. Thank you!
"},{"location":"guides/advanced-configuration-options/","title":"Advanced configuration options","text":"Some configuration options can not be edited through the UI and should only be used if needed.
Depending on the option they can be configured either by editing the
config.ymlconfiguration file or by using an enviroment variable or in a few cases by using flags when running stash.As an example the
portoption can be changed from the default9999to1234by one of the below methods:- adding
port: 1234to the config.yml file - setting the ENV variable STASH_PORT to 1234 eg
STASH_PORT=1234 ./stash - using the flag --port when running stash
./stash --port 1234
Always use the UI to create a backup of the database. As with all live databases DO NOT copy manually the database file as a means of backup.
Stash uses an sqlite database with
WALmode enabled. This practically means that along with the main db filestash.go-sqlitethere can be a-shmand a-walfile present (more info). Even stopping Stash might leave some of these index files present so again DO NOT manually copy the database file.The Backup or Download Backup tasks are the proper way to create a backup file.
- Go to Settings > System.
- Under Application Paths heading scroll down to Backup Directory Path.
- Set directory to store your backups.
- Go to Settings > Tasks.
- Under Backup heading you will find 2 tasks.
- Select either Backup or Download Backup task.
Assuming you have properly created a backup file you can use it to restore your database if needed.
Info
The restore procedure uses the default
stash-go.sqlitefilename, if you changed that when configuring Stash adjust accordingly.The following steps are recommended when restoring a database file:
- Go to Settings > System, scroll down to Database heading and check your Database Path location.
- Create a backup of the current database. (optional)
- Stop Stash.
- In your file browser, go to the location of your database path.
- Move or delete the
stash-go.sqlitedatabase file (along with the-shm-wal.journalfiles if present). - Copy the backup file that you want to restore to
stash-go.sqlite. - Make sure that you now have a
stash-go.sqlitefile and that no-shm-wal.journalfiles are present. - Start Stash.
You should now have Stash running with a working and restored database.
"},{"location":"guides/backup-and-restore-database/#advanced-troubleshooting","title":"Advanced troubleshooting","text":"If you get a database malformed message during upgrade or backup that probably means that the database is already corrupt. One way to get past that is to do a full export and check the error log. If there are not a lot of errors you can then try to do a full import and get a working db with minimal losses. As the full import is destructive proceed with caution. For cases like this it is better to ask for support.
"},{"location":"guides/importing-via-csv-using-gql-iterate/","title":"Bulk importing via CSV using gql-iterate","text":"If you want to add a collection of performers, tags, studios, etc, and you have a text/spreadsheet list of them, here's the walkthrough of how to do it via a simple CLI method.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-1-install-gql-iterate","title":"Step 1: Install gql-iterate","text":"gql-iterate repository
npm install @efstajas/gql-iterate -goryarn add @efstajas/gql-iterate -gFor latest versions of NodeJS (14>) you need to go where you globally install your npm modules (AppData/Roaming/npm/node_modules/@efstajas/gql-iterate/bin) and add the following to the first line of the cli.js file.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-2-prepare-your-gqlfile-if-needed","title":"Step 2: Prepare your gql.file if needed","text":"import { createRequire } from 'module'; const require = createRequire(import.meta.url);See below for example versions of performers.gql and tags.gql samples that should work for you. Others can be figured out (with minor changes needeed) from stash/graphql/documents/mutations
These are NOT identical to the original files found above. Compare you'll see how they differ. This is very specific to be used for gql-iterate.
tags.gqlperformers.gqlmutation TagCreate( \n $name: String!,\n $image: String) {\n tagCreate(input: { \n name: $name, \n image: $image \n }) {\n id\n }\n }\nmutation PerformerCreate( \n $name: String!, \n $url: String, \n $gender: GenderEnum, \n $birthdate: String, \n $ethnicity: String, \n $country: String, \n $eye_color: String, \n $height: String, \n $measurements: String, \n $fake_tits: String, \n $career_length: String, \n $tattoos: String, \n $piercings: String, \n $aliases: String, \n $twitter: String, \n $instagram: String, \n $favorite: Boolean, \n $image: String) {\n performerCreate(input: { \n name: $name, \n url: $url, \n gender: $gender, \n birthdate: $birthdate, \n ethnicity: $ethnicity, \n country: $country, \n eye_color: $eye_color, \n height: $height, \n measurements: $measurements, \n fake_tits: $fake_tits, \n career_length: $career_length, \n tattoos: $tattoos,\n piercings: $piercings, \n aliases: $aliases, \n twitter: $twitter, \n instagram: $instagram, \n favorite: $favorite, \n image: $image }\n ) \n { id } \n }\nIf you have a suggested change, please add it below.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-3-prepare-your-textfile-or-spreadsheet-into-a-csv","title":"Step 3: Prepare your textfile or spreadsheet into a CSV","text":"let's say you have a textfile with these performers (just names and eyecolors for a simple example) If you have a spreadsheet, add a first line with the column headers, you HAVE to provide all fields listed above in the first line, but you don't have to actually have data in them.
name,url,gender,birthdate,ethnicity,country,eye_color,height,measurements,fake_tits,career_length,tattoos,piercings,aliases,twitter,instagram,favorite,imagethen add your data if text, or export as CSV if it's a spreadsheet (gender is not a string, see documentation in code, and favorite is a boolean, if you want to add those)
Alice,,,,,,blue\nBetty,,,,,,green\nCarter,,,,,,brown\nthe above lines all go into a file, like performerdata.csv
Gender is complicated due to Stash using GenderEnum.
For tags, you only need the tag title, and if desired, a url to a image
If you're unable to get this to work, then omit the favorite and image property from your CSV header, and from the performers.gql file.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-4","title":"Step 4","text":"Note
Must use numerical IP instead of localhost.
Run this CLI command (assumes your files are in current directory and location for gql-interate is in your path)
gql-iterate --host http://_yourserverIP:portgoeshere_/graphql --input ./performerdata.csv --query ./performers.gqlIt will run and add performers, it won't duplicate existing names, so you can run it multiple times if you want to add more names. Or delete something and readd it, if need be.
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/","title":"Manually editing the Stash sqlite3 database","text":""},{"location":"guides/manually-editing-the-stash-sqlite3-database/#location","title":"Location","text":"The Stash Sqlite3 database file is located at
~/.stash/stash-go.sqlite.Before making changes to the Stash sqlite3 database - please make a backup first!
You can use the
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/#opening-the-database-file","title":"Opening the database file","text":"sqlite3client to directly edit this file.
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/#examples","title":"Examples","text":""},{"location":"guides/manually-editing-the-stash-sqlite3-database/#deleting-all-tags","title":"Deleting all tags","text":"cd ~/.stash\nsqlite3 stash-go.sqlite\nIf you need to delete all tags, you can use the following commands:
sqlite> DELETE FROM scenes_tags;\nsqlite> DELETE FROM tags;\nNote
This will not work if you have Scene marker tags.
"},{"location":"guides/reverse-proxy/","title":"Reverse proxy","text":"The use of a reverse proxy for Stash is possible.
"},{"location":"guides/reverse-proxy/#general","title":"General","text":"Generally, the following headers will need to be set (check your proxy's documentation for how to configure).
- Host (http host)
- X-Real-IP
- X-Forwarded-For
- X-Forwarded-Proto
See issue 134 for more information.
"},{"location":"guides/reverse-proxy/#using-a-url-prefix","title":"Using a URL prefix","text":"Stash also supports running under a URL prefix, in which case the the
"},{"location":"guides/reverse-proxy/#setting-external-url","title":"Setting External URL","text":"X-Forwarded-Prefixheader must also be set. The proxy also needs to remove the prefix from the requested URLs. For example, if you want your homepage to be accessible athttp://example.domain.com/stash, then you need to setX-Forwarded-Prefix: /stash.You can also set the host that will be served by Stash manually by adding an
external_host:setting in your Stash config.yml and assigning it the publicly accessible hostname, including thehttp://orhttps://.X-Forwarded-Prefixwill still need to be set if using a prefix.
"},{"location":"guides/reverse-proxy/#server-configuration-examples","title":"Server Configuration Examples","text":""},{"location":"guides/reverse-proxy/#nginx","title":"Nginx","text":"external_host: http://example.domain.com\n
"},{"location":"guides/reverse-proxy/#nginx-docker-linuxserver-letsencrypt","title":"Nginx + Docker (Linuxserver Letsencrypt)","text":"location / {\n proxy_pass http://127.0.0.1:9999;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_read_timeout 60000s;\n}\nIf you are using the linuxserver letencrypt docker you can use create a
stash.subdomain.conffile in yourproxy-confsfolder and use this as the config:
"},{"location":"guides/reverse-proxy/#nginx-with-prefix","title":"Nginx with prefix","text":"# make sure that your dns has a cname set for stash\n\nserver {\n listen 443 ssl;\n listen [::]:443 ssl;\n\n server_name stash.*;\n\n include /config/nginx/ssl.conf;\n\n client_max_body_size 0;\n\n # enable for ldap auth, fill in ldap details in ldap.conf\n #include /config/nginx/ldap.conf;\n\n location / {\n # enable the next two lines for http auth\n #auth_basic \"Restricted\";\n #auth_basic_user_file /config/nginx/.htpasswd;\n\n # enable the next two lines for ldap auth\n #auth_request /auth;\n #error_page 401 =200 /login;\n\n include /config/nginx/proxy.conf;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n resolver 127.0.0.11 valid=30s;\n set $upstream_app stash;\n set $upstream_port 9999;\n set $upstream_proto http;\n proxy_pass $upstream_proto://$upstream_app:$upstream_port;\n proxy_set_header Host $http_host;\n proxy_read_timeout 60000s;\n }\n}\nAn example for
nginxusing the prefix/stash:
"},{"location":"guides/reverse-proxy/#nginx-with-external_host","title":"Nginx with external_host","text":"location /stash/ {\n # Notice the trailing slash - this causes nginx to remove the /stash prefix from requested URLs\n proxy_pass http://192.168.0.1:9999/;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"Upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Port $server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Forwarded-Prefix /stash;\n proxy_read_timeout 60000s;\n}\nAnother example for
nginx:In this case we are using
stash.homeas our domain and192.168.0.1is stash's ip so edit acccordingly.The
external_hostconfiguration option should also be set, in this caseexternal_host: http://stash.home. Refer to external_host for more details.
"},{"location":"guides/reverse-proxy/#apache","title":"Apache","text":"server {\n listen 80;\n listen [::]:80;\n\n server_name stash.home;\n client_max_body_size 0;\n\n location / {\n proxy_pass http://192.168.0.1:9999;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"Upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Port $server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n }\n}\n
"},{"location":"guides/reverse-proxy/#prerequisites","title":"Prerequisites","text":"# if using apache < 2.4.47, remove upgrade=websocket\nProxyPass \"/stash\" \"http://127.0.0.1:9999\" upgrade=websocket\nProxyPassReverse \"/stash\" \"http://127.0.0.1:9999\"\nRequestHeader setIfEmpty X-Forwarded-Prefix \"/stash\"\nProxyPreserveHost on\n\n# for name resolution\nServerAdmin admin@example.com\nServerName example.com\nServerAlias stash.example.com\n\n# to enable websockets for apache < 2.4.47\n#RewriteEngine on\n#RewriteCond %{HTTP:Upgrade} websocket [NC]\n#RewriteCond %{HTTP:Connection} upgrade [NC]\n#RewriteRule ^/?stash/(.*) \"ws://127.0.0.1:9999/$1\" [P,L]\n\n# to add SSL\nSSLEngine on\nSSLCertificateFile /path/to/cert.pem\nSSLCertificateKeyFile /path/to/cert.key\n
"},{"location":"guides/reverse-proxy/#caddy-v2","title":"Caddy v2","text":"sudo a2enmod proxy\nsudo a2enmod proxy_http\nsudo a2enmod proxy_balancer\nsudo a2enmod lbmethod_byrequests\n\nsudo a2enmod rewrite\nsudo a2enmod headers\n\n# for SSL\nsudo a2enmod ssl\nstash.example.com {\n reverse_proxy 127.0.0.1:9999 {\n header_up Host {host}\n header_up X-Real-IP {remote_host}\n header_up X-Forwarded-Port {server_port}\n }\n}\nThe
"},{"location":"guides/reverse-proxy/#troubleshooting","title":"Troubleshooting","text":""},{"location":"guides/reverse-proxy/#504-errors","title":"504 Errors","text":"external_hostconfiguration option should also be set, in this caseexternal_host: http://stash.home. Refer to external_host for more details.- In some cases with big database files you might encounter
504errors during stash db migration due to timeout. Adjusting theproxy_read_timeoutvalue (proxy.conffile in Letencrypt/Swag docker container)
- In order for the websocket to work, you may need to also add these lines to your server block (
proxy.conffile in the Letencrypt Unraid docker container for instance) as mentioned here should fix the issue.
"},{"location":"guides/reverse-proxy/#cloudflare-tunnel","title":"Cloudflare Tunnel","text":"proxy_http_version 1.1;\nproxy_set_header Upgrade $http_upgrade;\nproxy_set_header Connection \"upgrade\";\nCloudflare Tunnels are not recommended since they throttle non-HTML traffic (which video falls under).
See Cloudflare blog post for more details.
"},{"location":"guides/run-cdp-on-truenas-scale/","title":"Run CDP on TrueNAS Scale","text":"Info
Written by WiiGe. Originally posted on stashapp/stash discussions1.
A way to use CDP scraper on TrueNAS Scale and install chromedp/headless-shell on TrueNAS Scale.
People using stash-app on TrueNAS Scale like me may face the problem that no supported CDP app by truecharts or truenas , and now I found a way to properly run chromedp/headless-shell.
This can be done by custom-app.
According to docker hub page of chromedp/headless-shell, we start container with
docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell, but this's not enough for TrueNAS Scale which run everything with K3s.In order to run a docker image on K3s, we need to warp docker image with custom-app, fill the Container Repository with
chromedp/headless-shelland Container Tag withlatestso that TrueNAS can pull the image for you.As for the docker args
docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell, we need to translate the args and env parameter into custom-app configuration. Under the Workload Settings section of custom-app configuration page, there will be a list of Extra Args, we put--name headless-shell --shm-size 2Ghere in custom-app way.But due to this issue, K3s will report an error of zygote:
ERROR:zygote_host_impl_linux.cc(262)] Failed to adjust OOM score of renderer with pid 28: Permission denied (13), solution is simple - just offer extra args to disable it :--headless --disable-gpu --no-sandbox --no-zygote --disable-software-rasterizer --disable-dev-shm-usage.--remote-debugging-address=0.0.0.0 --remote-debugging-port=9222is not needed because we will set port and ip on Networking and Services section for LoadBalancer (I am using 192.168.1.45 and 9222, change it for your own scenario).The Networking section and the final Extra Args page should be like this:
and click Install button then your headless-shell will be good to go.
The last step: just fill stash's CDP setting with
http://192.168.1.45:9222/json/version(still, change ip:port for your own scenario), and now cdp should be running for you.An extra note is Ingress section of custom-app, you may want to use chromedp/headless-shell remotely (e.g. accessing cdp by https://cdp.example.com/json/version), you need to modify the header of request with SetHeader function, see Host header is specified and is not an IP address or localhost. Obviously stash scraper do not support such operation, write your own scraper in this circumstances.
I just put the info I found together and share here, hope this page help more people who try to use CDP scraper on K3s-based OS.
-
https://github.com/stashapp/stash/discussions/4719 \u21a9
A regular scraper can only scrape information from webpages that are open to the public access. If you want to scrape a webpage that requires login or behind a paywall, you need to use the \"Visible CDP\" technique.
Normal CDP scraping will launch a headless chrome browser, which will not show up for any user interactions. \"Visible CDP\" turns the \"headless chrome\" into a \"visible\" instance.
- Prepare your scraper's .yml file and make sure it's valid and working. Your scraper should have the following setting inside:
driver:\n useCDP: true\n - Run a command console. Go to the Chrome's binary directory and run
chrome.exe --remote-debugging-port=9222. This will launch a special Chrome instance that Stash Scrapers can control later on. - In Stash, make sure that the Settings > Metadata Providers > Scraping > Chrome CDP Path is set to
http://localhost:9222/json/version. - Use the special Chrome instance you launched earlier, go to the webpage you want to scrape, type in your user/pass or pass any other human tests, until you see the page with desired content.
- Paste the webpage's URL in your Stash scene and start scraping. It should get the information correctly.
stash-box is an open-source video indexing and metadata API server for porn developed by Stash team. It provides a crowdsourced database of metadata for adult performers, studios and scenes.
Stash has several ways to scrape from stash-box instances. From automatic to manual. Each has its own advantages and disadvantages.
- Tagger (recommended) - partially automatic, great accuracy
- Identify - fully automatic, mediocre accuracy
- Scrape with... - fully manual, great accuracy
- Go to Settings > Tasks.
- Under Library header you will find configuration options for Scan task and Generate task.
- Enable Generate perceptual hashes under Scan header.
- Enable Perceptual hashes under Generate header.
Scan task and its options are applied when the content is being added to the database the first time.
Generate task and its options are applied when you want to generate additional things for content that is already in your database.
"},{"location":"guides/scraping-scenes-via-stash-box/#configure-stash-box-endpoint","title":"Configure stash-box endpoint","text":"Known stash-box instances
A list of public stash-box instances is available here.
- Go to Settings > Metadata Providers.
- Under Stash-box Endpoints header click Add and include the details of the stash-box instance you want to add.
- Click Test Credentials to make sure everything is correct.
Recommended to people that value accuracy the most. It can automatically go through scenes and match them based on perceptual hash, but object creation and verification is left to you and nothing is saved until you click Save.
- Open Scenes page.
- Click on display mode selector in the toolbar.
- Set it to Tagger.
- Under Source select a stash-box instance you want to use.
-
Opposite the Source click on the to open configuration.
- You can enable Show male performers if you want them to be scraped for you locally.
- You can disable Set scene cover image if you prefer to keep your existing cover.
- You can enable Set tags if you want to be shown all the crowdsourced tags the scene has on the stash-box instance.
-
You can enable Mark as Organized on save which will apply Organized flag.
Organized flagOrganized flag has a technical purpose in addition to being able to be used in a filter. All objects marked as organized will be ignored by automatic tasks like Identify and Auto Tag.
-
Click on Scrape All and look through the results. Add missing objects and click Save.
- If you got returned No results found, you can try using query method. You can enter title, performer, release date, or studio and click Search. Keep in mind that sometimes fewer details, are better.
- If you know the scene exists on that stash-box instance, but it wasn't found, you can input the exact StashID in the Query field, click Search and it will return that exact scene.
-
For scenes that you clicked Save on, you can submit your file fingerprints (hashes) back to the instance to help improve the accuracy. Scroll to the top and click Submit x fingerprints.
FingerprintsAll fingerprints are tied to the user API key, no other information is sent to the stash-box instance. Privacy is paramount.
For people that want fully automatic option and don't mind some potential inaccuracies. The task will automatically go through all scenes and match them based on perceptual hash. You can also create all missing objects automatically. No manual verification is possible.
Warning
Task is irreversible, so it's a good idea to make a backup before running it.
- Go to Settings and enable Advanced Mode.
- Go to Settings > Tasks.
- Under Library header click on Identify....
-
Under Sources select a stash-box instance(s) you want to match against.
Info
Identify task iterates through sources until it finds a match, once it finds a match, it will ignore all other sources for that scene.
-
Configure default options that will apply to all sources (they can be overwritten for individual sources by clicking next to each source).
- You can disable Show male performers if you don't want them to be scraped for you locally.
- You can disable Set scene cover image if you prefer to keep your existing cover.
- You can enable Set organized flag which will apply Organized flag.
- You can disable Skip matches that have more than one result if you don't mind potentially getting more mismatched results. If enabled, it can also be tagged with a custom tag to let you know which scenes were skipped.
- You can disable Skip single name performers with no disambiguation if you don't mind potentially getting more mismatched results. If enabled, it can also be tagged with a custom tag to let you know which scenes were skipped.
- Click Set as default to save your configuration.
- Configure default field options that will apply to all sources (they can be overwritten for individual sources by clicking next to each source).
- Click Set as default to save your configuration.
- Click Identify to start the task.
In addition to previous methods, there is also a completely manual way to match scenes individually.
- Go to a scene you want to match.
- Click on the Edit tab.
- Click Scrape with... and select a stash-box instance you want to match against.
- Check the return results, create missing objects and click Apply.
- Click Save.
You can use the ffprobe command to gather useful information about a video file:
ffprobe -show_format -show_streams big_buck_bunny.mkv\nThis can be useful for example, when filing bug reports, or discussing in chat.
"},{"location":"guides/troubleshooting-video-playback/#remuxing-files","title":"Remuxing files","text":"Another good test, is to see if remuxing the file into a new video file helps:
"},{"location":"guides/troubleshooting-video-playback/#extracting-a-sample-of-a-video","title":"Extracting a sample of a video","text":"ffmpeg -i big_buck_bunny.mkv -c:v copy -c:a copy remuxed_file.mkv\nIf you are asked for a sample of a video (e.g. for developers to analyse), you can use
ffmpeg -ss 120 -i big_buck_bunny.mkv -t 30 -c:v copy -c:a copy 30_second_sample.mkv\nThe above command starts at the 120-second marker, and takes a 30-second sample of the video file.
"},{"location":"in-app-manual/","title":"In-app manual","text":"Info
Stash internal help manual, mirrored from stashapp/stash/ui/v2.5/src/docs/en/Manual.
Internal links will be broken as a result, but will work correctly when browsing the Help section inside Stash.
"},{"location":"in-app-manual/browsing/","title":"Browsing","text":""},{"location":"in-app-manual/browsing/#browsing","title":"Browsing","text":""},{"location":"in-app-manual/browsing/#querying-and-filtering","title":"Querying and Filtering","text":""},{"location":"in-app-manual/browsing/#keyword-searching","title":"Keyword searching","text":"The text field allows you to search using keywords. Keyword searching matches on different fields depending on the object type:
Type Fields searched Scene Title, Details, Path, OSHash, Checksum, Marker titles Image Title, Path, Checksum Group Title Marker Title, Scene title Gallery Title, Path, Checksum Performer Name, Aliases Studio Name, Aliases Tag Name, AliasesKeyword matching uses the following rules:
- all words are required in the matching field. For example,
foo barmatches scenes with bothfooandbarin the title. - the
orkeyword or symbol (|) is used to match either fields. For example,foo or bar(orfoo | bar) matches scenes withfooorbarin the title. Or sets can be combined. For example,foo or bar or baz xyz or zyxmatches scenes with one offoo,barandbaz, andxyzorzyx. - the not symbol (
-) is used to exclude terms. For example,foo -barmatches scenes withfooand excludes those withbar. The not symbol cannot be combined with an or operand. That is,-foo or barwill be interpreted to match-fooorbar. On the other hand,foo or bar -bazwill matchfooorbarand excludebaz. - surrounding a phrase in quotes (
\") matches on that exact phrase. For example,\"foo bar\"matches scenes withfoo barin the title. Quotes may also be used to escape the keywords and symbols. For example,foo \"-bar\"will match scenes withfooand-bar. - quoted phrases may be used with the or and not operators. For example,
\"foo bar\" or baz -\"xyz zyx\"will match scenes withfoo barorbaz, and exclude those withxyz zyx. orkeywords or symbols at the start or end of a line will be treated literally. That is,or foowill match scenes withorandfoo.- all keyword matching is case-insensitive
Filters can be accessed by clicking the filter button on the right side of the query text field.
Note that only one filter criterion per criterion type may be assigned.
"},{"location":"in-app-manual/browsing/#regex-modifiers","title":"Regex modifiers","text":"Some filters have regex modifier as an option. Regex modifiers are case-sensitive by default.
"},{"location":"in-app-manual/browsing/#sorting-and-page-size","title":"Sorting and page size","text":"The current sorting field is shown next to the query text field, indicating the current sort field and order. The page size dropdown allows selecting from a standard set of objects per page, and allows setting a custom page size.
"},{"location":"in-app-manual/browsing/#saved-filters","title":"Saved filters","text":"Saved filters can be accessed with the bookmark button on the left of the query text field. The current filter can be saved by entering a filter name and clicking on the save button. Existing saved filters may be overwritten with the current filter by clicking on the save button next to the filter name. Saved filters may also be deleted by pressing the delete button next to the filter name.
Saved filters are sorted alphabetically by title with capitalized titles sorted first.
"},{"location":"in-app-manual/browsing/#default-filter","title":"Default filter","text":"The default filter for the top-level pages may be set to the current filter by clicking the
"},{"location":"in-app-manual/captions/","title":"Captions","text":""},{"location":"in-app-manual/captions/#captions","title":"Captions","text":"Set as defaultbutton in the saved filter menu.Stash supports captioning with SRT and VTT files.
Captions will only be detected if they are located in the same folder as the corresponding scene file.
Ensure the caption files follow these naming conventions:
"},{"location":"in-app-manual/captions/#scene","title":"Scene","text":"- {scene_file_name}.{language_code}.ext
- {scene_file_name}.ext
Where
{language_code}is defined by the ISO-6399-1 (2 letters) standard andextis the file extension. Captions files without a language code will be labeled as Unknown in the video player but will work fine.Scenes with captions can be filtered with the
captionscriterion.Note: If the caption file was added after the scene was initially added during scan, you will need to run a Selective Scan task for it to show up.
"},{"location":"in-app-manual/configuration/","title":"Configuration","text":""},{"location":"in-app-manual/configuration/#configuration","title":"Configuration","text":""},{"location":"in-app-manual/configuration/#library","title":"Library","text":"This section allows you to add and remove directories from your library list. Files in these directories will be included when scanning. Files that are outside of these directories will be removed when running the Clean task.
\u26a0\ufe0f Note: Don't forget to click
"},{"location":"in-app-manual/configuration/#excluded-patterns","title":"Excluded patterns","text":"Saveafter updating these directories!Given a valid regex, files that match even partially are excluded during the Scan process and are not entered in the database. Also during the Clean task if these files exist in the DB they are removed from it and their generated files get deleted. Prior to matching both the filenames and patterns are converted to lower case so the match is case insensitive.
Regex patterns can be added in the config file or from the UI. If you add manually to the config file a restart is needed while from the UI you just need to click the Save button. When added through the config file directly special care must be given to double escape the
\\character.There are 2 separate exclusion settings. One is for videos, another is for images/galleries.
Some examples:
\"sample\\.mp4$\"will exclude all files ending insample.mp4.\"/\\.[[:word:]]+/\"will exclude all hidden directories like/.directoryname/.\"c:\\\\stash\\\\videos\\\\exclude\"will exclude specific Windows directoryc:\\stash\\videos\\exclude.\"^/stash/videos/exclude/\"will exclude all directories that match/stash/videos/exclude/pattern.\"\\\\\\\\stash\\\\network\\\\share\\\\excl\\\\\"will exclude specific Windows network path\\\\stash\\network\\share\\excl\\.
Note: If a directory is excluded for images and videos, then the directory will be excluded from scans completely.
There is a useful regex101 site that can help test and experiment with regexps.
"},{"location":"in-app-manual/configuration/#gallery-creation-from-folders","title":"Gallery creation from folders","text":"In the Library section you can find an option to create a gallery from each folder containing images. This will be applied on all libraries when activated, including the base folder of a library.
If you wish to apply this on a per folder basis, you can create a file called .nogallery or .forcegallery in a folder that should act different than this global setting.
This will either exclude the folder from becoming a gallery even if the setting is set, or create a gallery from the folder even if the setting is not set.
The file will only be recognized if written in lower case letters.
Files with a dot in front are handled as hidden in the Linux OS and Mac OS, so you will not see those files after creation on your system without setting your file manager accordingly.
"},{"location":"in-app-manual/configuration/#hashing-algorithms","title":"Hashing algorithms","text":"Stash identifies video files by calculating a hash of the file. There are two algorithms available for hashing:
oshashandMD5.MD5requires reading the entire file, and can therefore be slow, particularly when reading files over a network.oshash(which uses OpenSubtitle's hashing algorithm) only reads 64k from each end of the file.The hash is used to name the generated files such as preview images and videos, and sprite images.
By default, new systems have MD5 calculation disabled for optimal performance. Existing systems that are upgraded will have the oshash populated for each scene on the next scan.
"},{"location":"in-app-manual/configuration/#changing-the-hashing-algorithm","title":"Changing the hashing algorithm","text":"To change the file naming hash to oshash, all scenes must have their oshash values populated. oshash population is done automatically when scanning.
To change the file naming hash to
MD5, the MD5 must be populated for all scenes. To do this,Calculate MD5for videos must be enabled and the library must be rescanned.MD5 calculation may only be disabled if the file naming hash is set to
oshash.After changing the file naming hash, any existing generated files will now be named incorrectly. This means that stash will not find them and may regenerate them if the
"},{"location":"in-app-manual/configuration/#step-by-step-instructions-to-migrate-to-oshash-for-existing-users","title":"Step-by-step instructions to migrate to oshash for existing users","text":"Generate taskis used. To remedy this, run theRename generated filestask, which will rename existing generated files to their correct names.These instructions are for existing users whose systems will be defaulted to use and calculate MD5 checksums. Once completed, MD5 checksums will no longer be calculated when scanning, and oshash will be used for generated file naming. Existing calculated MD5 checksums will remain on scenes, but checksums will not be calculated for new scenes.
- Scan the library (to populate oshash for all existing scenes).
- In Settings -> System page, untick
Calculate MD5and selectoshashas file naming hash. Save the configuration. - In Settings -> Tasks page, click on the
Rename generated filesmigration button.
This setting controls how many sub-tasks will be run in parallel during scanning and generation tasks. (See Tasks)
Auto-detection can be enabled by setting this to zero. This will calculate the number of parallel tasks to be logical cores/4 + 1.
This setting can be used to increase/decrease overall CPU utilisation in two scenarios:
- High performance 4+ core cpus.
- Media files stored on remote/cloud filesystem.
Note: If this is set too high it will decrease overall performance and causes failures (out of memory).
"},{"location":"in-app-manual/configuration/#hardware-accelerated-live-transcoding","title":"Hardware accelerated live transcoding","text":"Hardware accelerated live transcoding can be enabled by setting the
"},{"location":"in-app-manual/configuration/#hlsdash-streaming","title":"HLS/DASH streaming","text":"FFmpeg hardware encodingsetting. Stash outputs the supported hardware encoders to the log file on startup at the Info log level. If a given hardware encoder is not supported, it's error message is logged to the Debug log level for debugging purposes.To stream using HLS (such as on Apple devices) or DASH, the Cache path must be set. This directory is used to store temporary files during the live-transcoding process. The Cache path can be set in the System settings page.
"},{"location":"in-app-manual/configuration/#ffmpeg-arguments","title":"ffmpeg arguments","text":"Additional arguments can be injected into ffmpeg when generating previews and sprites, and when live-transcoding videos.
The ffmpeg arguments configuration is split into
InputandOutputarguments. Input arguments are injected before the input file argument, and output arguments are injected before the output file argument.Arguments are accepted as a list of strings. Each string is a separate argument. For example, a single argument of
"},{"location":"in-app-manual/configuration/#scraping","title":"Scraping","text":""},{"location":"in-app-manual/configuration/#user-agent-string","title":"User Agent string","text":"-foo barwould be treated as a single argument\"-foo bar\". The correct way to pass this argument would be to split it into two separate arguments:\"-foo\", \"bar\".Some websites require a legitimate User-Agent string when receiving requests, or they will be rejected. If entered, this string will be applied as the
"},{"location":"in-app-manual/configuration/#chrome-cdp-path","title":"Chrome CDP path","text":"User-Agentheader value in http scrape requests.Some scrapers require a Chrome instance to function correctly. If left empty, stash will attempt to find the Chrome executable in the path environment, and will fail if it cannot find one.
Chrome CDP pathcan be set to a path to the chrome executable, or an http(s) address to remote chrome instance (for example:http://localhost:9222/json/version).Important: As of Chrome 136 you need to specify
"},{"location":"in-app-manual/configuration/#authentication","title":"Authentication","text":"--user-data-diralongside--remote-debugging-port. Read more on their official post.By default, stash is not configured with any sort of password protection. To enable password protection, both
"},{"location":"in-app-manual/configuration/#api-key","title":"API key","text":"UsernameandPasswordmust be populated. Note that when entering a new username and password where none was set previously, the system will immediately request these credentials to log you in.If password protection is enabled, you may also generate an API key. An API key is used by external systems to access your stash system without needing to login first.
External systems using the API key must set the
"},{"location":"in-app-manual/configuration/#logging-out","title":"Logging out","text":"ApiKeyheader value to the configured API key in order to bypass the login requirement.The logout button is situated in the upper-right part of the screen when you are logged in.
"},{"location":"in-app-manual/configuration/#recovering-from-a-forgotten-username-or-password","title":"Recovering from a forgotten username or password","text":"Stash saves login credentials in the config.yml file. You must reset both login and password if you have forgotten your password by doing the following:
- Close your Stash process
- Open the
config.ymlfile found in your Stash directory with a text editor - Delete the
usernameandpasswordlines from the file and save
Stash authentication should now be reset with no authentication credentials.
"},{"location":"in-app-manual/configuration/#advanced-configuration-options","title":"Advanced configuration options","text":"These options are typically not exposed in the UI and must be changed manually in the
Field Remarksconfig.ymlfile.custom_served_foldersA map of URLs to file system folders. See below.custom_ui_locationThe file system folder where the UI files will be served from, instead of using the embedded UI. Empty to disable. Stash must be restarted to take effect.developer_options.extra_blob_pathsA list of alternative blob paths. These paths will be read for blob files. Blobs will not be written or deleted from these paths. Intended for developer use only.max_upload_sizeMaximum file upload size for import files. Defaults to 1GB.theme_colorSets thetheme-colorproperty in the UI.gallery_cover_regexThe regex responsible for selecting images as gallery coversproxyThe url of a HTTP(S) proxy to be used when stash makes calls to online services. Example: https://user:password@my.proxy:8080. Note: SOCKS5 proxies are unsupported.no_proxyA list of domains for which the proxy must not be used. Default is all local LAN: localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12sequential_scanningModifies behaviour of the scanning functionality to generate support files (previews/sprites/phash) at the same time as fingerprinting/screenshotting. Useful when scanning cached remote files.The following environment variables are also supported:
Environment variable RemarksSTASH_SQLITE_CACHE_SIZESets the SQLite cache size. See https://www.sqlite.org/pragma.html#pragma_cache_size. Default is-2000which is 2MB."},{"location":"in-app-manual/configuration/#custom-served-folders","title":"Custom served folders","text":"Custom served folders are served when the server handles a request with the
/customURL prefix. The following is an example configuration:custom_served_folders:\n /: D:\\stash\\static\n /foo: D:\\bar\nWith the above configuration, a request for
/custom/foo/bar.pngwould serveD:\\bar\\bar.png.The
"},{"location":"in-app-manual/contributing/","title":"Ways to contribute","text":""},{"location":"in-app-manual/contributing/#ways-to-contribute","title":"Ways to contribute","text":""},{"location":"in-app-manual/contributing/#financial","title":"Financial","text":"/entry matches anything that is not otherwise mapped by the other entries. For example,/custom/baz/xyz.pngwould serveD:\\stash\\static\\baz\\xyz.png.Financial contributions are welcomed and are accepted using Open Collective.
"},{"location":"in-app-manual/contributing/#development-related","title":"Development-related","text":"The Stash backend is written in Go, using a SQLite database. The UI is written in Typescript, using React. Bug fixes, improvements and new features are welcomed. Please see the DEVELOPMENT.md file for details on how to get started. Assistance is available via our Discord.
"},{"location":"in-app-manual/contributing/#documentation","title":"Documentation","text":"Efforts to improve documentation in Stash helps new users and reduces the number of questions we have to field in Discord. Contributions to documentation are welcomed. While submitting documentation changes via GitHub pull requests is ideal, we will gladly accept submissions via GitHub issues or on Discord.
For those with web page experience, we also welcome contributions to our website (which as of writing is very undeveloped).
"},{"location":"in-app-manual/contributing/#testing-features-improvements-and-bug-fixes","title":"Testing features, improvements and bug fixes","text":"Testing is currently covered by a very small group, so new testers are welcomed. Being able to build Stash locally is ideal, but binaries for pull requests are also available.
First, you will need to be signed in to GitHub. Find and open the relevant pull request, and then click on the
"},{"location":"in-app-manual/contributing/#submitting-and-contributing-to-bug-reports-improvements-and-new-features","title":"Submitting and contributing to bug reports, improvements and new features","text":"Checkstab. On the right, there should be a button titledArtifacts- click that, and you should get a dropdown with links to download binaries built from that pull request for Linux, Windows and macOS.We welcome ideas for future improvements and features, and bug reports help everyone. These can all be found on GitHub.
"},{"location":"in-app-manual/contributing/#providing-support","title":"Providing support","text":"Offering support for new users on our Community forum and Discord is also welcomed.
"},{"location":"in-app-manual/deduplication/","title":"Dupe checker","text":""},{"location":"in-app-manual/deduplication/#dupe-checker","title":"Dupe Checker","text":"The dupe checker searches your collection for scenes that are perceptually similar. This means that the files don't need to be identical, and will be identified even with different bitrates, resolutions, and intros/outros.
To achieve this stash needs to generate what's called a phash, or perceptual hash. Similar to sprite generation stash will generate a set of 25 images from fixed points in the scene. These images will be stitched together, and then hashed using the phash algorithm. The phash can then be used to find scenes that are the same or similar to others in the database. Phash generation can be run during scan, or as a separate task. Note that generation can take a while due to the work involved with extracting screenshots.
The dupe checker can be run with four different levels of accuracy.
Exactlooks for scenes that have exactly the same phash. This is a fast and accurate operation that should not yield any false positives except in very rare cases. The other accuracy levels look for duplicate files within a set distance of each other. This means the scenes don't have exactly the same phash, but are very similar.HighandMediumshould still yield very good results with few or no false positives.Lowis likely to produce some false positives, but might still be useful for finding dupes.Note that to generate a phash stash requires an uncorrupted file. If any errors are encountered during sprite generation the phash will not be generated. This is to prevent false positives.
"},{"location":"in-app-manual/images/","title":"Images and galleries","text":""},{"location":"in-app-manual/images/#images-and-galleries","title":"Images and Galleries","text":"Images are the parts which make up galleries, but you can also have them be scanned independently. To declare an image part of a gallery, there are four ways:
- Group them in a folder together and activate the Create galleries from folders containing images option in the library section of your settings. The gallery will get the name of the folder.
- Group them in a folder together and create a file in the folder called .forcegallery. The gallery will get the name of the folder.
- Group them into a zip archive together. The gallery will get the name of the archive.
- You can simply create a gallery in stash itself by clicking on New in the Galleries tab.
You can add images to every gallery manually in the gallery detail page. Deleting can be done by selecting the according images in the same view and clicking on the minus next to the edit button.
For best results, images in zip file should be stored without compression (copy, store or no compression options depending on the software you use. Eg on linux:
zip -0 -r gallery.zip foldertozip/). This impacts heavily on the zip read performance.If a filename of an image in the gallery zip file ends with
cover.jpg, it will be treated like a cover and presented first in the gallery view page and as a gallery cover in the gallery list view. If more than one images match the name the first one found in natural sort order is selected.You can also manually select any image from a gallery as its cover. On the gallery details page, select the desired cover image, and then select Set as Cover in the \u22ef menu.
"},{"location":"in-app-manual/images/#image-clipsgifs","title":"Image clips/gifs","text":"Images can also be clips/gifs. These are meant to be short video loops. Right now they are not possible in zipfiles. To declare video files to be images, there are two ways:
- Deactivate video scanning for all libraries that contain clips/gifs, but keep image scanning active. Set the Scan Video Extensions as Image Clip option in the library section of your settings.
- Make sure none of the file endings used by your clips/gifs are present in the Video Extensions and add them to the Image Extensions in the library section of your settings.
A clip/gif will be a stillframe in the wall and grid view by default. To view the loop, you can go into the Lightbox Carousel (e.g. by clicking on an image in the wall view) or the image detail page.
If you want the loop to be used as a preview on the wall and grid view, you will have to generate them. You can do this as you scan for the new clip file by activating Generate previews for image clips on the scan settings, or do it after by going to the Generated Content section in the task section of your settings, activating Image Clip Previews and clicking generate. This takes a while, as the files are transcoded.
"},{"location":"in-app-manual/interactive/","title":"Interactivity","text":""},{"location":"in-app-manual/interactive/#interactivity","title":"Interactivity","text":"Stash currently supports syncing with Handy devices, using funscript files.
In order for stash to connect to your Handy device, the Handy Connection Key must be entered in Settings -> Interface.
Funscript files must be in the same directory as the matching video file and must have the same base name. For example, a funscript file for
video.mp4must be namedvideo.funscript. A scan must be run to update scenes with matching funscript files.Scenes with funscript files can be filtered with the
"},{"location":"in-app-manual/interface/","title":"Interface options","text":""},{"location":"in-app-manual/interface/#interface-options","title":"Interface Options","text":""},{"location":"in-app-manual/interface/#language","title":"Language","text":"interactivecriterion.Setting the language affects the formatting of numbers and dates.
"},{"location":"in-app-manual/interface/#scenemarker-wall-preview-type","title":"Scene/Marker Wall Preview Type","text":"The Scene Wall and Marker pages display scene preview videos (mp4) by default. This can be changed to animated image (webp) or static image.
\u26a0\ufe0f Note: scene/marker preview videos must be generated to see them in the applicable wall page if Video preview type is selected. Likewise, if Animated Image is selected, then Image Previews must be generated.
"},{"location":"in-app-manual/interface/#show-studios-as-text","title":"Show Studios as text","text":"By default, a scene's studio will be shown as an image overlay. Checking this option changes this to display studios as a text name instead.
"},{"location":"in-app-manual/interface/#scene-player-options","title":"Scene Player options","text":"By default, scene videos do not automatically start when navigating to the scenes page. Checking the \"Auto-start video\" option changes this to auto play scene videos.
The maximum loop duration option allows looping of shorter videos. Set this value to the maximum scene duration that scene videos should loop. Setting this to 0 disables this functionality.
"},{"location":"in-app-manual/interface/#activity-tracking","title":"Activity tracking","text":"The \"Track Activity\" option allows tracking of scene play count and duration, and sets the resume point when a scene video is not finished.
The \"Minimum Play Percent\" gives the minimum proportion of a video that must be played before the play count of the scene is incremented.
By default, when a scene has a resume point, the scene player will automatically seek to this point when the scene is played. Setting \"Always start video from beginning\" to true disables this behaviour.
"},{"location":"in-app-manual/interface/#custom-css","title":"Custom CSS","text":"The stash UI can be customised using custom CSS. See here for a community-curated set of CSS snippets to customise your UI.
There is also a collection of community-created themes available.
"},{"location":"in-app-manual/interface/#custom-javascript","title":"Custom Javascript","text":"Stash supports the injection of custom javascript to assist with theming or adding additional functionality. Be aware that bad Javascript could break the UI or worse.
"},{"location":"in-app-manual/interface/#custom-locales","title":"Custom Locales","text":"The localisation strings can be customised. The master list of default (en-GB) locale strings can be found here. The custom locale format is the same as this json file.
For example, to override the
actions.add_directorylabel (which isAdd Directoryby default), you would have the following in the custom locale:
"},{"location":"in-app-manual/interface/#custom-served-folders","title":"Custom served folders","text":"{\n \"actions\": {\n \"add_directory\": \"Some other description\"\n }\n}\nIt is possible to expose specific folders to the UI. This configuration is performed manually in the
config.ymlfile only.Custom served content is exposed via the
/customURL path prefix.For example, in the
config.ymlfile:custom_served_folders:\n /: D:\\stash\\static\n /foo: D:\\bar\nWith the above configuration, a request for
/custom/foo/bar.pngwould returnD:\\bar\\bar.png. The/entry matches anything that is not otherwise mapped by the other entries. For example,/custom/baz/xyz.pngwould returnD:\\stash\\static\\baz\\xyz.png.Applications for this include using static images in custom css, like the Plex theme. For example, using the following config:
custom_served_folders:\n /: <stash folder>\\custom\nThe
background.pngandnoise.pngfiles can be placed in thecustomfolder, then in the custom css, the./background.pngand./noise.pngstrings can be replaced with/custom/background.pngand/custom/noise.pngrespectively.Other applications are to add custom UIs to stash, accessible via
"},{"location":"in-app-manual/introduction/","title":"Introduction","text":""},{"location":"in-app-manual/introduction/#introduction","title":"Introduction","text":"/custom.Stash works by cataloging your media using the paths that you provide. Once you have configured the locations where your media is stored, you can click the Scan button in
Settings -> Tasksand stash will begin scanning and importing your media into its library.For the best experience, it is recommended that after a scan is finished, that video previews and sprites are generated. You can do this in
Settings -> Tasks. Note that currently it is only possible to perform one task at a time and but there is a task queue, so the generate tasks should be performed after scan is complete.Once your media is imported, you are ready to begin creating Performers, Studios and Tags, and curating your content!
"},{"location":"in-app-manual/keyboardshortcuts/","title":"Keyboard shortcuts","text":""},{"location":"in-app-manual/keyboardshortcuts/#keyboard-shortcuts","title":"Keyboard Shortcuts","text":""},{"location":"in-app-manual/keyboardshortcuts/#global-shortcuts","title":"Global shortcuts","text":"Keyboard sequence Action?Display manual"},{"location":"in-app-manual/keyboardshortcuts/#global-navigation","title":"Global Navigation","text":"Keyboard sequence Target pageg sScenesg iImagesg vGroupsg kMarkersg lGalleriesg pPerformersg uStudiosg tTagsg zSettings"},{"location":"in-app-manual/keyboardshortcuts/#query-page-shortcuts","title":"Query page shortcuts","text":"Keyboard sequence Action/Focus search field / focus query field in filter dialogfShow Add Filter dialogrReshuffle if sorted by randomv gSet view to gridv lSet view to listv wSet view to wall+Increase zoom slider-Decrease zoom slider\u2190Previous page of results\u2192Next page of resultsShift + \u2190Go to current results page -10Shift + \u2192Go to current results page +10Ctrl + HomeGo to first page of resultsCtrl + EndGo to last page of resultss aSelect all on pages nUnselect alleEdit selectedd dDelete selected"},{"location":"in-app-manual/keyboardshortcuts/#scenes-page-shortcuts","title":"Scenes page shortcuts","text":"Keyboard sequence Actionp rPlay random scene"},{"location":"in-app-manual/keyboardshortcuts/#scene-page-shortcuts","title":"Scene page shortcuts","text":"Keyboard sequence ActionaDetails tabqQueue tabkMarkers tabiFile info tabeEdit tabhHistory tab,Hide/Show sidebar.Hide/Show scene scrubberoIncrement O-Counter Ratingsr {1-5}Set rating (stars)r 0Unset rating (stars)r {0-9} {0-9}Set rating (decimal -00for10.0)r `Unset rating (decimal) Playbackp nPlay next scene in queuep pPlay previous scene in queuep rPlay random scene in queueSpacePlay/pause playerEnterPlay/pause player\u2190Seek backwards by 10 seconds\u2192Seek forwards by 10 secondsShift + \u2190Seek backwards by 5 secondsShift + \u2192Seek forwards by 5 secondsCtrl/Alt + \u2190Seek backwards by 1 minuteCtrl/Alt + \u2192Seek forwards by 1 minute{1-9}Seek to 10-90% duration[Scrub backwards 10% duration]Scrub forwards 10% duration\u2191Increase volume 10%\u2193Decrease volume 10%mToggle mutelA/B looping toggle. Press once to set start point. Press again to set end point. Press again to disable loop.Shift + lToggle looping of scene when it's over"},{"location":"in-app-manual/keyboardshortcuts/#scene-markers-tab-shortcuts","title":"Scene Markers tab shortcuts","text":"Keyboard sequence ActionnDisplay Create Markers dialog"},{"location":"in-app-manual/keyboardshortcuts/#scene-edit-tab-shortcuts","title":"Scene Edit tab shortcuts","text":"Keyboard sequence Actions sSave Scened dDelete SceneCtrl + vPaste Scene cover"},{"location":"in-app-manual/keyboardshortcuts/#image-page-shortcuts","title":"Image Page shortcuts","text":"Keyboard sequence ActioneEdit taboIncrement O-Counter Ratingsr {1-5}Set rating (stars)r 0Unset rating (stars)r {0-9} {0-9}Set rating (decimal -00for10.0)r `Unset rating (decimal)"},{"location":"in-app-manual/keyboardshortcuts/#image-edit-tab-shortcuts","title":"Image Edit tab shortcuts","text":"Keyboard sequence Actions sSave Scened dDelete Scene"},{"location":"in-app-manual/keyboardshortcuts/#groups-page-shortcuts","title":"Groups Page shortcuts","text":"Keyboard sequence ActionnNew Group"},{"location":"in-app-manual/keyboardshortcuts/#group-page-shortcuts","title":"Group Page shortcuts","text":"Keyboard sequence ActioneEdit Groups sSave Groupd dDelete Groupr `[Edit mode] Unset rating (decimal),Expand/Collapse DetailsCtrl + vPaste Group image Ratingsr {1-5}[Edit mode] Set rating (stars)r 0[Edit mode] Unset rating (stars)r {0-9} {0-9}[Edit mode] Set rating (decimal -r 0 0for10.0)"},{"location":"in-app-manual/keyboardshortcuts/#markers-page-shortcuts","title":"Markers Page shortcuts","text":"Keyboard sequence Actionp rPlay random marker"},{"location":"in-app-manual/keyboardshortcuts/#performers-page-shortcuts","title":"Performers Page shortcuts","text":"Keyboard sequence ActionnNew Performerp rOpen random Performer"},{"location":"in-app-manual/keyboardshortcuts/#performer-page-shortcuts","title":"Performer Page shortcuts","text":"Keyboard sequence ActioncScenes tabeEdit taboOperations tabfToggle favourite,Expand/Collapse Details"},{"location":"in-app-manual/keyboardshortcuts/#performer-edit-tab-shortcuts","title":"Performer Edit tab shortcuts","text":"Keyboard sequence Actions sSave Performerd dDelete PerformerCtrl + vPaste Performer image"},{"location":"in-app-manual/keyboardshortcuts/#studios-page-shortcuts","title":"Studios Page shortcuts","text":"Keyboard sequence ActionnNew Studio"},{"location":"in-app-manual/keyboardshortcuts/#studio-page-shortcuts","title":"Studio Page shortcuts","text":"Keyboard sequence ActioneEdit Studios sSave Studiod dDelete Studio,Expand/Collapse DetailsCtrl + vPaste Studio image"},{"location":"in-app-manual/keyboardshortcuts/#tags-page-shortcuts","title":"Tags Page shortcuts","text":"Keyboard sequence ActionnNew Tag"},{"location":"in-app-manual/keyboardshortcuts/#tag-page-shortcuts","title":"Tag Page shortcuts","text":"Keyboard sequence ActioneEdit Tags sSave Tagd dDelete Tag,Expand/Collapse DetailsCtrl + vPaste Tag image"},{"location":"in-app-manual/tagger/","title":"Scene tagger","text":""},{"location":"in-app-manual/tagger/#scene-tagger","title":"Scene Tagger","text":"Stash can be integrated with stash-box which acts as a centralized metadata database. This is in the early stages of development but can be used for fingerprint/keyword lookups and automated tagging of performers and scenes. The batch tagging interface can be accessed from the scene view. For more information join our Discord.
"},{"location":"in-app-manual/tagger/#searching","title":"Searching","text":"The fingerprint search matches your current selection of files against the remote stash-box instance. Any scenes with a matching fingerprint will be returned, although there is currently no validation of fingerprints so it\u2019s recommended to double-check the validity before saving.
If no fingerprint match is found it\u2019s possible to search by keywords. The search works by matching the query against a scene\u2019s title, release date, studio name, and performer names. By default the tagger uses metadata set on the file, or parses the filename, this can be changed in the config.
An important thing to note is that it only returns a match if all query terms are a match. As an example, if a scene is titled
"},{"location":"in-app-manual/tagger/#saving","title":"Saving","text":"\"A Trip to the Mall\"with the performer\"Jane Doe\", a search for\"Trip to the Mall 1080p\"will not match, however\"trip mall doe\"would. Usually a few pieces of info is enough, for instance performer name + release date or studio name. To avoid common non-related keywords you can add them to the blacklist in the tagger config. Any items in the blacklist are stripped out of the query.When a scene is matched stash will try to match the studio and performers against your local studios and performers. If you have previously matched them, they will automatically be selected. If not you either have to select the correct performer/studio from the dropdown, choose create to create a new entity, or skip to ignore it.
Once a scene is saved the scene and the matched studio/performers will have the
stash_idsaved which will then be used for future tagging.By default male performers are not shown, this can be enabled in the tagger config. Likewise scene tags are by default not saved. They can be set to either merge with existing tags on the scene, or overwrite them. It is not recommended to set tags currently since they are hard to deduplicate and can litter your data.
"},{"location":"in-app-manual/tagger/#submitting-fingerprints","title":"Submitting fingerprints","text":"After a scene is saved you will prompted to submit the fingerprint back to the stash-box instance. This is optional, but can be helpful for other users who have an identical copy who will then be able to match via the fingerprint search. No other information than the
"},{"location":"in-app-manual/plugins/","title":"Plugins","text":""},{"location":"in-app-manual/plugins/#plugins","title":"Plugins","text":"stash_idand file fingerprint is submitted.Stash supports plugins that can do the following:
- perform custom tasks when triggered by the user from the Tasks page
- perform custom tasks when triggered from specific events
- add custom CSS to the UI
- add custom JavaScript to the UI
Plugin tasks can be implemented using embedded Javascript, or by calling an external binary.
\u26a0\ufe0f Note: Plugin support is still experimental and is likely to change.
"},{"location":"in-app-manual/plugins/#managing-plugins","title":"Managing Plugins","text":"Plugins can be installed and managed from the
Settings > Pluginspage.Plugins are installed using the
Available Pluginssection. This section allows configuring sources from which to install plugins. TheCommunity (stable)source is configured by default. This source contains plugins for the current stable version of stash.These are the plugin sources maintained by the stashapp organisation:
Name Source URL Recommended Local Path Notes Community (stable)https://stashapp.github.io/CommunityScripts/stable/index.ymlstableFor the current stable version of stash. Community (develop)https://stashapp.github.io/CommunityScripts/develop/index.ymldevelopFor the develop version of stash.Installed plugins can be updated or uninstalled from the
"},{"location":"in-app-manual/plugins/#source-urls","title":"Source URLs","text":"Installed Pluginssection.The source URL must return a yaml file containing all the available packages for the source. An example source yaml file looks like the following:
- id: <package id>\n name: <package name>\n version: <version>\n date: <date>\n requires:\n - <ids of packages required by this package (optional)>\n - ...\n path: <path to package zip file>\n sha256: <sha256 of zip>\n metadata:\n <optional key/value pairs for extra information>\n- ...\nPath can be a relative path to the zip file or an external URL.
"},{"location":"in-app-manual/plugins/#adding-plugins-manually","title":"Adding plugins manually","text":"By default, Stash looks for plugin configurations in the
pluginssub-directory of the directory where the stashconfig.ymlis read. This will either be the$HOME/.stashdirectory or the current working directory.Plugins are added by adding configuration yaml files (format:
pluginName.yml) to thepluginsdirectory.Loaded plugins can be viewed in the Plugins page of the Settings. After plugins are added, removed or edited while stash is running, they can be reloaded by clicking
"},{"location":"in-app-manual/plugins/#using-plugins","title":"Using plugins","text":"Reload Pluginsbutton.Plugins provide tasks which can be run from the Tasks page.
"},{"location":"in-app-manual/plugins/#creating-plugins","title":"Creating plugins","text":""},{"location":"in-app-manual/plugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":"The basic structure of a plugin configuration file is as follows:
name: <plugin name>\ndescription: <optional description of the plugin>\nversion: <optional version tag>\nurl: <optional url>\n\nui:\n # optional list of css files to include in the UI\n css:\n - <path to css file>\n\n # optional list of js files to include in the UI\n javascript:\n - <path to javascript file>\n\n # optional list of plugin IDs to load prior to this plugin\n requires:\n - <plugin ID>\n\n # optional list of assets \n assets:\n urlPrefix: fsLocation\n ...\n\n # content-security policy overrides\n csp:\n script-src:\n - http://alloweddomain.com\n\n style-src:\n - http://alloweddomain.com\n\n connect-src:\n - http://alloweddomain.com\n\n# map of setting names to be displayed in the plugins page in the UI\nsettings:\n # internal name\n foo:\n # name to display in the UI\n displayName: Foo\n # type of the attribute to show in the UI\n # can be BOOLEAN, NUMBER, or STRING\n type: BOOLEAN\n\n# the following are used for plugin tasks only\nexec:\n - ...\ninterface: [interface type]\nerrLog: [one of none trace, debug, info, warning, error]\ntasks:\n - ...\nThe
name,description,versionandurlfields are displayed on the plugins page.The
exec,interface,errLogandtasksfields are used only for plugins with tasks.The
"},{"location":"in-app-manual/plugins/#ui-configuration","title":"UI Configuration","text":"settingsfield is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutationconfigurePlugin- the settings set this way do not need to be specified in thesettingsfield unless they are to be displayed in the stock plugin settings UI.The
cssandjavascriptfield values may be relative paths to the plugin configuration file, or may be full external URLs.The
requiresfield is a list of plugin IDs which must have their javascript/css files loaded before this plugins javascript/css files.The
assetsfield is a map of URL prefixes to filesystem paths relative to the plugin configuration file. Assets are mounted to the/plugin/{pluginID}/assetspath.As an example, for a plugin with id
foowith the followingassetsvalue:
The following URLs will be mapped to these locations:assets:\n foo: bar\n /: .\n/plugin/foo/assets/foo/file.txt->{pluginDir}/bar/file.txt/plugin/foo/assets/file.txt->{pluginDir}/file.txt/plugin/foo/assets/bar/file.txt->{pluginDir}/bar/file.txt(via the/entry)Mappings that try to go outside of the directory containing the plugin configuration file will be ignored.
The
cspfield contains overrides to the content security policies. The URLs inscript-src,style-srcandconnect-srcwill be added to the applicable content security policy.See External Plugins for details for making plugins with external tasks.
See Embedded Plugins for details for making plugins with embedded tasks.
"},{"location":"in-app-manual/plugins/#plugin-task-input","title":"Plugin task input","text":"Plugin tasks may accept an input from the stash server. This input is encoded according to the interface, and has the following structure (presented here in JSON format):
{\n \"server_connection\": {\n \"Scheme\": \"http\",\n \"Port\": 9999,\n \"SessionCookie\": {\n \"Name\":\"session\",\n \"Value\":\"cookie-value\",\n \"Path\":\"\",\n \"Domain\":\"\",\n \"Expires\":\"0001-01-01T00:00:00Z\",\n \"RawExpires\":\"\",\n \"MaxAge\":0,\n \"Secure\":false,\n \"HttpOnly\":false,\n \"SameSite\":0,\n \"Raw\":\"\",\n \"Unparsed\":null\n },\n \"Dir\": <path to stash config directory>,\n \"PluginDir\": <path to plugin config directory>,\n },\n \"args\": {\n \"argKey\": \"argValue\"\n }\n}\nThe
"},{"location":"in-app-manual/plugins/#plugin-task-output","title":"Plugin task output","text":"server_connectionfield contains all the information needed for a plugin to access the parent stash server, if necessary.Plugin task output is expected in the following structure (presented here as JSON format):
{\n \"error\": <optional error string>\n \"output\": <anything>\n}\nThe
"},{"location":"in-app-manual/plugins/#task-configuration","title":"Task configuration","text":"errorfield is logged in stash at theerrorlog level if present. Theoutputis written at thedebuglog level.Tasks are configured using the following structure:
tasks:\n - name: <operation name>\n description: <optional description>\n defaultArgs:\n argKey: argValue\nA plugin configuration may contain multiple tasks.
The
"},{"location":"in-app-manual/plugins/#hook-configuration","title":"Hook configuration","text":"defaultArgsfield is used to add inputs to the plugin input sent to the plugin.Stash supports executing plugin operations via triggering of a hook during a stash operation.
Hooks are configured using a similar structure to tasks:
hooks:\n - name: <operation name>\n description: <optional description>\n triggeredBy:\n - <trigger types>...\n defaultArgs:\n argKey: argValue\nNote: it is possible for hooks to trigger eachother or themselves if they perform mutations. For safety, hooks will not be triggered if they have already been triggered in the context of the operation. Stash uses cookies to track this context, so it's important for plugins to send cookies when performing operations.
"},{"location":"in-app-manual/plugins/#trigger-types","title":"Trigger types","text":"Trigger types use the following format:
<object type>.<operation>.<hook type>For example, a post-hook on a scene create operation will be
Scene.Create.Post.The following object types are supported:
SceneSceneMarkerImageGalleryGroupPerformerStudioTag
The following operations are supported:
CreateUpdateDestroyMerge(forTagonly)
Currently, only
"},{"location":"in-app-manual/plugins/#hook-input","title":"Hook input","text":"Posthook types are supported. These are executed after the operation has completed and the transaction is committed.Plugin tasks triggered by a hook include an argument named
hookContextin theargsobject structure. ThehookContextis structured as follows:{\n \"id\": <object id>,\n \"type\": <trigger type>,\n \"input\": <operation input>,\n \"inputFields\": <fields included in input>\n}\nThe
inputfield contains the JSON graphql input passed to the original operation. This will differ between operations. For hooks triggered by operations in a scan or clean, the input will be nil.inputFieldsis populated in update operations to indicate which fields were passed to the operation, to differentiate between missing and empty fields.For example, here is the
argsvalues for a Scene update operation:
"},{"location":"in-app-manual/plugins/embeddedplugins/","title":"Embedded plugins","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#embedded-plugin-tasks","title":"Embedded Plugin Tasks","text":"{\n \"hookContext\": {\n \"type\":\"Scene.Update.Post\",\n \"id\":45,\n \"input\":{\n \"clientMutationId\":null,\n \"id\":\"45\",\n \"title\":null,\n \"details\":null,\n \"url\":null,\n \"date\":null,\n \"rating\":null,\n \"organized\":null,\n \"studio_id\":null,\n \"gallery_ids\":null,\n \"performer_ids\":null,\n \"groups\":null,\n \"tag_ids\":[\"21\"],\n \"cover_image\":null,\n \"stash_ids\":null\n },\n \"inputFields\":[\n \"tag_ids\",\n \"id\"\n ]\n }\n}\nEmbedded plugin tasks are executed within the stash process using a scripting system.
"},{"location":"in-app-manual/plugins/embeddedplugins/#supported-script-languages","title":"Supported script languages","text":"Stash currently supports Javascript embedded plugin tasks using goja.
"},{"location":"in-app-manual/plugins/embeddedplugins/#javascript-plugins","title":"Javascript plugins","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-input","title":"Plugin input","text":"The input is provided to Javascript plugin tasks using the
"},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-output","title":"Plugin output","text":"inputglobal variable, and is an object based on the structure provided in thePlugin inputsection of the Plugins page. Note that theserver_connectionfield should not be necessary in most embedded plugins.The output of a Javascript plugin task is derived from the evaluated value of the script. The output should conform to the structure provided in the
Plugin outputsection of the Plugins page.There are a number of ways to return the plugin output:
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-1","title":"Example #1","text":"
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-2","title":"Example #2","text":"(function() {\n return {\n Output: \"ok\"\n };\n})();\n
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-3","title":"Example #3","text":"function main() {\n return {\n Output: \"ok\"\n };\n}\n\nmain();\n
"},{"location":"in-app-manual/plugins/embeddedplugins/#logging","title":"Logging","text":"var output = {\n Output: \"ok\"\n};\n\noutput;\nSee the
"},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#exec","title":"exec","text":"Javascript APIsection below on how to log with Javascript plugins.For embedded plugins, the
"},{"location":"in-app-manual/plugins/embeddedplugins/#interface","title":"interface","text":"execfield is a list with the first element being the path to the Javascript file that will be executed. It is expected that the path to the Javascript file is relative to the directory of the plugin configuration file.For embedded plugins, the
"},{"location":"in-app-manual/plugins/embeddedplugins/#javascript-api","title":"Javascript API","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#logging_1","title":"Logging","text":"interfacefield must be set to one of the following values: *jsStash provides the following API for logging in Javascript plugins:
Method Descriptionlog.Trace(<string>)Log with thetracelog level.log.Debug(<string>)Log with thedebuglog level.log.Info(<string>)Log with theinfolog level.log.Warn(<string>)Log with thewarnlog level.log.Error(<string>)Log with theerrorlog level.log.Progress(<float between 0 and 1>)Sets the progress of the plugin task, as a float, where0represents 0% and1represents 100%."},{"location":"in-app-manual/plugins/embeddedplugins/#gql","title":"GQL","text":"Stash provides the following API for communicating with stash using the graphql interface:
Method Descriptiongql.Do(<query/mutation string>, <variables object>)Executes a graphql query/mutation on the stash server. Returns an object in the same way as a graphql query does."},{"location":"in-app-manual/plugins/embeddedplugins/#example","title":"Example","text":"
"},{"location":"in-app-manual/plugins/embeddedplugins/#utility-functions","title":"Utility functions","text":"// creates a tag\nvar mutation = \"\\\nmutation tagCreate($input: TagCreateInput!) {\\\n tagCreate(input: $input) {\\\n id\\\n }\\\n}\";\n\nvar variables = {\n input: {\n 'name': tagName\n }\n};\n\nresult = gql.Do(mutation, variables);\nlog.Info(\"tag id = \" + result.tagCreate.id);\nStash provides the following API for utility functions:
Method Descriptionutil.Sleep(<milliseconds>)Suspends the current thread for the specified duration."},{"location":"in-app-manual/plugins/externalplugins/","title":"External plugins","text":""},{"location":"in-app-manual/plugins/externalplugins/#external-plugin-tasks","title":"External Plugin Tasks","text":"External plugin tasks are executed by running an external binary.
"},{"location":"in-app-manual/plugins/externalplugins/#plugin-interfaces","title":"Plugin interfaces","text":"Stash communicates with external plugin tasks using an interface. Stash currently supports RPC and raw interface types.
"},{"location":"in-app-manual/plugins/externalplugins/#rpc-interface","title":"RPC interface","text":"The RPC interface uses JSON-RPC to communicate with the plugin process. A golang plugin utilising the RPC interface is available in the stash source code under
pkg/plugin/examples/gorpc. RPC plugins are expected to provide an interface that fulfils theRPCRunnerinterface inpkg/plugin/common.RPC plugins are expected to accept requests asynchronously.
When stopping an RPC plugin task, the stash server sends a stop request to the plugin and relies on the plugin to stop itself.
"},{"location":"in-app-manual/plugins/externalplugins/#raw-interface","title":"Raw interface","text":"Raw interface plugins are not required to conform to any particular interface. The stash server will send the plugin input to the plugin process via its stdin stream, encoded as JSON. Raw interface plugins are not required to read the input.
The stash server reads stdout for the plugin's output. If the output can be decoded as a JSON representation of the plugin output data structure then it will do so. If not, it will treat the entire stdout string as the plugin's output.
When stopping a raw plugin task, the stash server kills the spawned process without warning or signals.
"},{"location":"in-app-manual/plugins/externalplugins/#logging","title":"Logging","text":"External plugins may log to the stash server by writing to stderr. By default, data written to stderr will be logged by stash at the
errorlevel. This default behaviour can be changed by setting theerrLogfield in the plugin configuration file.Plugins can log for specific levels or log progress by prefixing the output string with special control characters. See
"},{"location":"in-app-manual/plugins/externalplugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":""},{"location":"in-app-manual/plugins/externalplugins/#exec","title":"exec","text":"pkg/plugin/common/logfor how this is done in go.For external plugin tasks, the
execfield is a list with the first element being the binary that will be executed, and the subsequent elements are the arguments passed. The execution process will search the path for the binary, then will attempt to find the program in the same directory as the plugin configuration file. Theexeextension is not necessary on Windows systems.\u26a0\ufe0f Note: The plugin execution process sets the current working directory to that of the stash process.
Arguments can include the plugin's directory with the special string
{pluginDir}.For example, if the plugin executable
my_pluginis placed in thepluginssubdirectory and requires argumentsfooandbar, then theexecpart of the configuration would look like the following:exec:\n - my_plugin\n - foo\n - bar\nAnother example might use a python script to execute the plugin. Assuming the python script
foo.pyis placed in the same directory as the plugin config file, theexecfragment would look like the following:
"},{"location":"in-app-manual/plugins/externalplugins/#interface","title":"interface","text":"exec:\n - python\n - {pluginDir}/foo.py\nFor external plugin tasks, the
interfacefield must be set to one of the following values: *rpc*rawSee the
Plugin interfacessection above for details on these interface types.The
"},{"location":"in-app-manual/plugins/externalplugins/#errlog","title":"errLog","text":"interfacefield defaults torawif not provided.The
"},{"location":"in-app-manual/plugins/externalplugins/#task-configuration","title":"Task configuration","text":"errLogfield tells stash what the default log level should be when the plugin outputs to stderr without encoding a log level. It defaults to theerrorlevel if no provided. This field is not necessary if the plugin outputs logging with the appropriate encoding. See theLoggingsection above for details.In addition to the standard task configuration, external tasks may be configured with an optional
execArgsfield to add extra parameters to the execution arguments for the task.For example:
"},{"location":"in-app-manual/plugins/uipluginapi/","title":"UI plugin API","text":""},{"location":"in-app-manual/plugins/uipluginapi/#ui-plugin-api","title":"UI Plugin API","text":"tasks:\n - name: <operation name>\n description: <optional description>\n execArgs:\n - <arg to add to the exec line>\nThe
PluginApiobject is a global object in thewindowobject.PluginApiis considered experimental and is subject to change without notice. This documentation covers only the plugin-specific API. It does not necessarily cover the core UI API. Information on these methods should be referenced in the UI source code.An example using various aspects of
"},{"location":"in-app-manual/plugins/uipluginapi/#properties","title":"Properties","text":""},{"location":"in-app-manual/plugins/uipluginapi/#react","title":"PluginApimay be found in the source code underpkg/plugin/examples/react-component.React","text":"An instance of the React library.
"},{"location":"in-app-manual/plugins/uipluginapi/#reactdom","title":"ReactDOM","text":"An instance of the ReactDOM library.
"},{"location":"in-app-manual/plugins/uipluginapi/#gql","title":"GQL","text":"This namespace contains the generated graphql client interface. This is a low-level interface. In many cases,
"},{"location":"in-app-manual/plugins/uipluginapi/#libraries","title":"StashServiceshould be used instead.libraries","text":"
"},{"location":"in-app-manual/plugins/uipluginapi/#register","title":"librariesprovides access to the following UI libraries: -ReactRouterDOM-Bootstrap-Apollo-Intl-FontAwesomeRegular-FontAwesomeSolid-FontAwesomeBrands-Mousetrap-MousetrapPause-ReactSelectregister","text":"This namespace contains methods used to register page routes and components.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiregisterroute","title":"PluginApi.register.route","text":"Registers a route in the React Router.
Parameter Type DescriptionpathstringThe path to register. This should generally use the/plugin/prefix.componentReact.FCA React function component that will be rendered when the route is loaded.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiregistercomponent","title":"void.PluginApi.register.component","text":"Registers a component to be used by plugins. The component will be available in the
Parameter Type Descriptioncomponentsnamespace.namestringThe name of the component to register. This should be unique and should ideally be prefixed withplugin-.componentReact.FCA React function component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#components","title":"void.components","text":"This namespace contains all of the components available to plugins. These include a selection of core components and components registered using
"},{"location":"in-app-manual/plugins/uipluginapi/#utils","title":"PluginApi.register.component.utils","text":"This namespace provides access to the
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiutilsloadcomponents","title":"NavUtils,StashServiceandInteractiveUtilsnamespaces. It also provides access to theloadComponentsmethod.PluginApi.utils.loadComponents","text":"Due to code splitting, some components may not be loaded and available when a plugin page is rendered.
loadComponentsloads all of the components that a plugin page may require.In general,
Parameter Type DescriptionPluginApi.hooks.useLoadComponentshook should be used instead.componentsPromise[]The list of components to load. These values should come from thePluginApi.loadableComponentsnamespace.Returns a
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiutilsinteractiveutils","title":"Promise<void>that resolves when all of the components have been loaded.PluginApi.utils.InteractiveUtils","text":"This namespace provides access to
interactiveClientProviderandgetPlayer-getPlayerreturns the currentvideojsplayer object -interactiveClientProvidertakesIInteractiveClientProviderwhich allows a developer to hook into the lifecycle of funscripts.
"},{"location":"in-app-manual/plugins/uipluginapi/#example","title":"Example","text":"export interface IDeviceSettings {\n connectionKey: string;\n scriptOffset: number;\n estimatedServerTimeOffset?: number;\n useStashHostedFunscript?: boolean;\n [key: string]: unknown;\n}\n\nexport interface IInteractiveClientProviderOptions {\n handyKey: string;\n scriptOffset: number;\n defaultClientProvider?: IInteractiveClientProvider;\n stashConfig?: GQL.ConfigDataFragment;\n}\nexport interface IInteractiveClientProvider {\n (options: IInteractiveClientProviderOptions): IInteractiveClient;\n}\n\n/**\n * Interface that is used for InteractiveProvider\n */\nexport interface IInteractiveClient {\n connect(): Promise<void>;\n handyKey: string;\n uploadScript: (funscriptPath: string, apiKey?: string) => Promise<void>;\n sync(): Promise<number>;\n configure(config: Partial<IDeviceSettings>): Promise<void>;\n play(position: number): Promise<void>;\n pause(): Promise<void>;\n ensurePlaying(position: number): Promise<void>;\n setLooping(looping: boolean): Promise<void>;\n readonly connected: boolean;\n readonly playing: boolean;\n}\nFor instance say I wanted to add extra logging when
IInteractiveClient.connect()is called. In my plugin you would install your own client provider as seen below
"},{"location":"in-app-manual/plugins/uipluginapi/#hooks","title":"InteractiveUtils.interactiveClientProvider = (\n opts\n) => {\n if (!opts.defaultClientProvider) {\n throw new Error('invalid setup');\n }\n\n const client = opts.defaultClientProvider(opts);\n const connect = client.connect;\n client.connect = async () => {\n console.log('patching connect method');\n return connect.call(client);\n };\n\n return client;\n};\nhooks","text":"This namespace provides access to the following core utility hooks: -
useGalleryLightbox-useLightbox-useSpriteInfo-useToastIt also provides plugin-specific hooks.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapihooksuseloadcomponents","title":"PluginApi.hooks.useLoadComponents","text":"This is a hook used to load components, using the
Parameter Type DescriptionPluginApi.utils.loadComponentsmethod.componentsPromise[]The list of components to load. These values should come from thePluginApi.loadableComponentsnamespace.Returns a
"},{"location":"in-app-manual/plugins/uipluginapi/#loadablecomponents","title":"booleanwhich will betrueif the components are loading.loadableComponents","text":"This namespace contains all of the components that may need to be loaded using the
loadComponentsmethod. Components are added to this namespace as needed. Please make a development request if a required component is not in this namespace.This component also includes coarse-grained entries for every lazily loaded import in the stock UI. If a component is not available in
"},{"location":"in-app-manual/plugins/uipluginapi/#patch","title":"componentswhen the page loads, it can be loaded using the coarse-grained entry. For example,PerformerCardcan be loaded usingloadableComponents.Performers.patch","text":"This namespace provides methods to patch components to change their behaviour.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchbefore","title":"PluginApi.patch.before","text":"Registers a before function. A before function is called prior to calling a component's render function. It accepts the same parameters as the component's render function, and is expected to return a list of new arguments that will be passed to the render.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe before function. It accepts the same arguments as the component render function and is expected to return a list of arguments to pass to the render function.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchinstead","title":"void.PluginApi.patch.instead","text":"Registers a replacement function for a component. The provided function will be called with the arguments passed to the original render function, plus the next render function as the last argument. Replacement functions will be called in the order that they are registered. If a replacement function does not call the next render function then the following replacement functions will not be called or applied.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe replacement function. It accepts the same arguments as the original render function, plus the next render function, and is expected to return the replacement component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchafter","title":"void.PluginApi.patch.after","text":"Registers an after function. An after function is called after the render function of the component. It accepts the arguments passed to the original render function, plus the result of the original render function. It is expected to return the rendered component.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe after function. It accepts the same arguments as the original render function, plus the result of the original render function, and is expected to return the rendered component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#patchable-components-and-functions","title":"Patchable components and functions","text":"void.AlertModalAppBackgroundImageBooleanSettingChangeButtonSettingCompressedPerformerDetailsPanelConstantSettingCountrySelectCustomFieldInputCustomFieldsDateInputDetailImageExternalLinkButtonsExternalLinksButtonFolderSelectFrontPageGalleryCardGalleryCard.DetailsGalleryCard.ImageGalleryCard.OverlaysGalleryCard.PopoversGalleryIDSelectGallerySelectGallerySelect.sortGroupIDSelectGroupSelectGroupSelect.sortHeaderImageHoverPopoverIconImageDetailPanelImageInputLightboxLinkLoadingIndicatorMainNavBar.MenuItemsMainNavBar.UtilityItemsModalSettingNumberSettingPaginationPaginationIndexPerformerAppearsWithPanelPerformerCardPerformerCard.DetailsPerformerCard.ImagePerformerCard.OverlaysPerformerCard.PopoversPerformerCard.TitlePerformerDetailsPanelPerformerDetailsPanel.DetailGroupPerformerGalleriesPanelPerformerGroupsPanelPerformerHeaderImagePerformerIDSelectPerformerImagesPanelPerformerPagePerformerScenesPanelPerformerSelectPerformerSelect.sortPluginRoutesPluginSettingsRatingNumberRatingStarsRatingSystemSceneCardSceneCard.DetailsSceneCard.ImageSceneCard.OverlaysSceneCard.PopoversSceneFileInfoPanelSceneIDSelectScenePageScenePage.TabContentScenePage.TabsScenePlayerSceneSelectSceneSelect.sortSelectSettingSettingSettingGroupSettingModalStringListSettingStringSettingStudioIDSelectStudioSelectStudioSelect.sortSweatDropsTabTitleCounterTagCardTagCard.DetailsTagCard.ImageTagCard.OverlaysTagCard.PopoversTagCard.TitleTagIDSelectTagLinkTagSelectTagSelect.sortTruncatedText
PluginApi.Event","text":"Allows plugins to listen for Stash's events.
"},{"location":"in-app-manual/scraping/","title":"Metadata scraping","text":""},{"location":"in-app-manual/scraping/#metadata-scraping","title":"Metadata Scraping","text":"PluginApi.Event.addEventListener(\"stash:location\", (e) => console.log(\"Page Changed\", e.detail.data.location.pathname))\nStash supports scraping of metadata from various external sources.
"},{"location":"in-app-manual/scraping/#scraper-types","title":"Scraper Types","text":"Type Description Fragment Uses existing metadata for an Item and match it to a result from a metadata source. Search/By Name Uses a provided query string to search a metadata source for a list of matches for the user to pick from. URL Extracts metadata from a given URL."},{"location":"in-app-manual/scraping/#supported-scrapers","title":"Supported Scrapers","text":"Fragment Search URL gallery \u2714\ufe0f \u2714\ufe0f image \u2714\ufe0f \u2714\ufe0f group \u2714\ufe0f performer \u2714\ufe0f \u2714\ufe0f scene \u2714\ufe0f \u2714\ufe0f \u2714\ufe0f"},{"location":"in-app-manual/scraping/#included-scrapers","title":"Included Scrapers","text":"Stash provides the following built-in scrapers:
Scraper Description FreeonessearchPerformer scraper for freeones.xxx. Auto Tag Scenefragmentscraper that matches existing performers, studio and tags using the filename."},{"location":"in-app-manual/scraping/#managing-scrapers","title":"Managing Scrapers","text":"Scrapers can be installed and managed from the
Settings > Metadata Providerspage.Scrapers are installed using the
Available Scraperssection. This section allows configuring sources from which to install scrapers. TheCommunity (stable)source is configured by default. This source contains scrapers for the current stable version of stash.These are the scraper sources maintained by the stashapp organisation:
Name Source URL Recommended Local Path Notes Community (stable)https://stashapp.github.io/CommunityScrapers/stable/index.ymlstableFor the current stable version of stash. Community (develop)https://stashapp.github.io/CommunityScrapers/develop/index.ymldevelopFor the develop version of stash.Installed scrapers can be updated or uninstalled from the
"},{"location":"in-app-manual/scraping/#source-urls","title":"Source URLs","text":"Installed Scraperssection.The source URL must return a yaml file containing all the available packages for the source. An example source yaml file looks like the following:
- id: <package id>\n name: <package name>\n version: <version>\n date: <date>\n requires:\n - <ids of packages required by this package (optional)>\n - ...\n path: <path to package zip file>\n sha256: <sha256 of zip>\n metadata:\n <optional key/value pairs for extra information>\n- ...\nPath can be a relative path to the zip file or an external URL.
"},{"location":"in-app-manual/scraping/#adding-scrapers-manually","title":"Adding Scrapers manually","text":"By default, Stash looks for scraper configurations in the
scraperssub-directory of the directory where the stashconfig.ymlis read. This will either be the$HOME/.stashdirectory or the current working directory.Scrapers are added manually by placing yaml configuration files (format:
scrapername.yml) in thescrapersdirectory.\u26a0\ufe0f Note: Some scrapers may require more than just the yaml file, consult the individual scraper documentation
After the yaml files are added, removed or edited while stash is running, they can be reloaded going to
"},{"location":"in-app-manual/scraping/#using-scrapers","title":"Using Scrapers","text":""},{"location":"in-app-manual/scraping/#fragment-scraper","title":"Fragment Scraper","text":"Settings > Metadata Providers > Scrapersand clickingReload Scrapers.Click on the
"},{"location":"in-app-manual/scraping/#search-scraper","title":"Search Scraper","text":"Scrape With...button in theedittab of an item, then select the scraper you wish to use.Click on the \ud83d\udd0d button in the
"},{"location":"in-app-manual/scraping/#url-scraper","title":"URL Scraper","text":"edittab of an item. You will be presented with a search dialog with a pre-populated query to search for, after searching you will be presented with a list of results to pick fromEnter the URL in the
"},{"location":"in-app-manual/scraping/#tagger-view","title":"Tagger View","text":"edittab of an Item. If a scraper is installed that supports that url, then a button will appear to scrape the metadata.The Tagger view is accessed from the scenes page. It allows the user to run scrapers on all items on the current page. The Tagger presents the user with potential matches for an item from a selected stash-box instance or metadata source if supported. The user needs to select the correct metadata information to save.
When used in combination with stash-box, the user can optionally submit scene fingerprints to contribute to a stash-box instance. A scene fingerprint consists of any generated hashes (
Has Tagger Source Selection gallery group performer \u2714\ufe0f scene \u2714\ufe0f \u2714\ufe0f"},{"location":"in-app-manual/scraping/#identify-task","title":"Identify Task","text":"phash,oshash,md5) and the scene duration. Fingerprint submissions are associated with your stash-box account. Submitting fingerprints assists others in matching their files, because stash-box returns a count of matching user submitted fingerprints with every potential match.This task iterates through your Scenes and attempts to identify the scene using a selection of scraping sources. This task can be found under
"},{"location":"in-app-manual/scraping/scraperdevelopment/","title":"Contributing scrapers","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#contributing-scrapers","title":"Contributing Scrapers","text":"Settings -> Tasks -> \"Identify...\" (Button). For more information see the Tasks > Identify page.Scrapers can be contributed to the community by creating a PR in this repository.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-scraper-templates","title":"XPath scraper templates","text":"The most basic XPath scraper templates are available on CommunityScrapers repository.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scraper-configuration-file-format","title":"Scraper configuration file format","text":"name: <site>\nperformerByName:\n <single scraper config>\nperformerByFragment:\n <single scraper config>\nperformerByURL:\n <multiple scraper URL configs>\nsceneByName:\n <single scraper config>\nsceneByQueryFragment:\n <single scraper config>\nsceneByFragment:\n <single scraper config>\nsceneByURL:\n <multiple scraper URL configs>\ngroupByURL:\n <multiple scraper URL configs>\ngalleryByFragment:\n <single scraper config>\ngalleryByURL:\n <multiple scraper URL configs>\nimageByFragment:\n <single scraper config>\nimageByURL:\n <multiple scraper URL configs>\n<other configurations>\nnameis mandatory, all other top-level fields are optional. The inclusion of each top-level field determines what capabilities the scraper has.A scraper configuration in any of the top-level fields must at least have an
actionfield. The other fields are required based on the value of theactionfield.The scraping types and their required fields are outlined in the following table:
Behavior Required configuration Scraper inScrape...dropdown button in Performer Edit page ValidperformerByNameandperformerByFragmentconfigurations. Scrape performer from URL ValidperformerByURLconfiguration with matching URL. Scraper in query dropdown button in Scene Edit page ValidsceneByNameandsceneByQueryFragmentconfigurations. Scraper inScrape...dropdown button in Scene Edit page ValidsceneByFragmentconfiguration. Scrape scene from URL ValidsceneByURLconfiguration with matching URL. Scrape group from URL ValidgroupByURLconfiguration with matching URL. Note:movieByURLis also supported but is deprecated. Scraper inScrape...dropdown button in Gallery Edit page ValidgalleryByFragmentconfiguration. Scrape gallery from URL ValidgalleryByURLconfiguration with matching URL.URL-based scraping accepts multiple scrape configurations, and each configuration requires a
"},{"location":"in-app-manual/scraping/scraperdevelopment/#actions","title":"Actions","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#script","title":"Script","text":"urlfield. stash iterates through these configurations, attempting to match the entered URL against theurlfields in the configuration. It executes the first scraping configuration where the entered URL contains the value of theurlfield.Executes a script to perform the scrape. The
scriptfield is required for this action and accepts a list of string arguments. For example:action: script\nscript:\n - python\n - iafdScrape.py\n - query\nIf the script specifies the python executable, Stash will find the correct python executable for your system, either
pythonorpython3. So for example. this configuration could executepython iafdScrape.py queryorpython3 iafdScrape.py query.python3will be looked for first and if it's not found, we'll check forpython. In the case neither are found, you will get an error.Stash sends data to the script process's
stdinstream and expects the output to be streamed to thestdoutstream. Any errors and progress messages should be output tostderr.The script is sent input and expects output based on the scraping type, as detailed in the following table:
Scrape type Input OutputperformerByName{\"name\": \"<performer query string>\"}Array of JSON-encoded performer fragments (including at leastname)performerByFragmentJSON-encoded performer fragment JSON-encoded performer fragmentperformerByURL{\"url\": \"<url>\"}JSON-encoded performer fragmentsceneByName{\"name\": \"<scene query string>\"}Array of JSON-encoded scene fragmentssceneByQueryFragment,sceneByFragmentJSON-encoded scene fragment JSON-encoded scene fragmentsceneByURL{\"url\": \"<url>\"}JSON-encoded scene fragmentgroupByURL{\"url\": \"<url>\"}JSON-encoded group fragmentgalleryByFragmentJSON-encoded gallery fragment JSON-encoded gallery fragmentgalleryByURL{\"url\": \"<url>\"}JSON-encoded gallery fragmentimageByFragmentJSON-encoded image fragment JSON-encoded image fragmentimageByURL{\"url\": \"<url>\"}JSON-encoded image fragmentFor
performerByName, onlynameis required in the returned performer fragments. One entire object is sent back toperformerByFragmentto scrape a specific performer, so the other fields may be included to assist in scraping a performer. For example, theurlfield may be filled in for the specific performer page, thenperformerByFragmentcan extract by using its value.Python example of a performer Scraper:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath","title":"scrapeXPath","text":"import json\nimport sys\nimport string\n\ndef readJSONInput():\n input = sys.stdin.read()\n return json.loads(input)\n\n\ndef searchPerformer(name):\n # perform scraping here - using name for the query\n\n # fill in the output\n ret = []\n\n # example shown for a single found performer \n p = {}\n p['name'] = \"some name\"\n p['url'] = \"performer url\"\n ret.append(p)\n\n return ret\n\ndef scrapePerformer(input):\n ret = []\n # get the url from the input\n url = input['url']\n return scrapePerformerURL(url)\n\ndef debugPrint(t):\n sys.stderr.write(t + \"\\n\")\n\ndef scrapePerformerURL(url):\n debugPrint(\"Reading url...\")\n debugPrint(\"Parsing html...\")\n\n # parse html\n\n # fill in performer details - single object\n ret = {}\n\n ret['name'] = \"fred\"\n ret['aliases'] = \"freddy\"\n ret['ethnicity'] = \"\"\n # and so on\n\n return ret\n\n# read the input \ni = readJSONInput()\n\nif sys.argv[1] == \"query\":\n ret = searchPerformer(i['name'])\n print(json.dumps(ret))\nelif sys.argv[1] == \"scrape\":\n ret = scrapePerformer(i)\n print(json.dumps(ret))\nelif sys.argv[1] == \"scrapeURL\":\n ret = scrapePerformerURL(i['url'])\n print(json.dumps(ret))\nThis action scrapes a web page using an xpath configuration to parse. This action is not valid for
performerByFragment.This action requires that the top-level
xPathScrapersconfiguration is populated. Thescraperfield is required and must match the name of a scraper name configured inxPathScrapers. For example:sceneByURL:\n- action: scrapeXPath\n url: \n - pornhub.com/view_video.php\n scraper: sceneScraper\nThe above configuration requires that
sceneScraperexists in thexPathScrapersconfiguration.XPath scraping configurations specify the mapping between object fields and an xpath selector. The xpath scraper scrapes the applicable URL and uses xpath to populate the object fields.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapejson","title":"scrapeJson","text":"This action works in the same way as
scrapeXPath, but uses a mapped json configuration to parse. It uses the top-leveljsonScrapersconfiguration. This action is not valid forperformerByFragment.JSON scraping configurations specify the mapping between object fields and a GJSON selector. The JSON scraper scrapes the applicable URL and uses GJSON to parse the returned JSON object and populate the object fields.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-performerbyname","title":"scrapeXPath and scrapeJson use withperformerByName","text":"For
performerByName, thequeryURLfield must be present also. This field is used to perform a search query URL for performer names. The placeholder string sequence{}is replaced with the performer name search string. For the subsequent performer scrape to work, theURLfield must be filled in with the URL of the performer page that matches a URL given in aperformerByURLscraping configuration. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-scenebyfragment-and-scenebyqueryfragment","title":"scrapeXPath and scrapeJson use withname: Boobpedia\nperformerByName:\n action: scrapeXPath\n queryURL: http://www.boobpedia.com/wiki/index.php?title=Special%3ASearch&search={}&fulltext=Search\n scraper: performerSearch\nperformerByURL:\n - action: scrapeXPath\n url: \n - boobpedia.com/boobs/\n scraper: performerScraper\nxPathScrapers:\n performerSearch:\n performer:\n Name: # name element\n URL: # URL element that matches the boobpedia.com/boobs/ URL above\n performerScraper:\n # ... performer scraper details ...\nsceneByFragmentandsceneByQueryFragment","text":"For
sceneByFragmentandsceneByQueryFragment, thequeryURLfield must also be present. This field is used to build a query URL for scenes. ForsceneByFragment, thequeryURLfield supports the following placeholder fields:{checksum}- the MD5 checksum of the scene{oshash}- the oshash of the scene{filename}- the base filename of the scene{title}- the title of the scene{url}- the url of the scene
These placeholder field values may be manipulated with regex replacements by adding a
queryURLReplacesection, containing a map of placeholder field to regex configuration which uses the same format as thereplacepost-process action covered below.For example:
sceneByFragment:\n action: scrapeJson\n scraper: sceneQueryScraper\n queryURL: https://metadataapi.net/api/scenes?parse={filename}&limit=1\n queryURLReplace:\n filename:\n - regex: <some regex>\n with: <replacement>\nThe above configuration would scrape from the value of
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-sceneperformergallerygroupbyurl","title":"scrapeXPath and scrapeJson use withqueryURL, replacing{filename}with the base filename of the scene, after it has been manipulated by the regex replacements.<scene|performer|gallery|group>ByURL","text":"For
sceneByURL,performerByURL,galleryByURLthequeryURLcan also be present if we want to usequeryURLReplace. The functionality is the same assceneByFragment, the only placeholder field available though is theurl:{url}- the url of the scene/performer/gallery
"},{"location":"in-app-manual/scraping/scraperdevelopment/#stash","title":"Stash","text":"sceneByURL:\n - action: scrapeJson\n url:\n - metartnetwork.com\n scraper: sceneScraper\n queryURL: \"{url}\"\n queryURLReplace:\n url:\n - regex: '^(?:.+\\.)?([^.]+)\\.com/.+movie/(\\d+)/(\\w+)/?$'\n with: https://www.$1.com/api/movie?name=$3&date=$2\nA different stash server can be configured as a scraping source. This action applies only to
performerByName,performerByFragment,sceneByName,sceneByQueryFragmentandsceneByFragment, types. This action requires that the top-levelstashServerfield is configured.stashServercontains a singleurlfield for the remote stash server.- The username and password can be embedded in this string using
username:password@host. - Alternatively, the
apiKeyfield can be used to authenticate with the remote stash server.
An example stash scrape configuration is below:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-and-json-scrapers-configuration","title":"Xpath and JSON scrapers configuration","text":"name: stash\nperformerByName:\n action: stash\nperformerByFragment:\n action: stash\nsceneByFragment:\n action: stash\nsceneByName:\n action: stash\nsceneByQueryFragment:\n action: stash\nstashServer:\n apiKey: <api key>\n url: http://stashserver.com:9999\nThe top-level
xPathScrapersfield contains xpath scraping configurations, freely named. These are referenced in thescraperfield forscrapeXPathscrapers.Likewise, the top-level
jsonScrapersfield contains json scraping configurations.Collectively, these configurations are known as mapped scraping configurations.
A mapped scraping configuration may contain a
commonfield, and must containperformer,scene,grouporgallerydepending on the scraping type it is configured for.Within the
performer/scene/group/galleryfield are key/value pairs corresponding to the golang fields on the performer/scene object. These fields are case-sensitive.The values of these may be either a simple selector value, which tells the system where to get the value of the field from, or a more advanced configuration (see below). For example, for an xpath configuration:
performer:\n Name: //h1[@itemprop=\"name\"]\nThis will set the
Nameattribute of the returned performer to the text content of the element that matches<h1 itemprop=\"name\">....For a json configuration:
performer:\n Name: data.name\nThe value may also be a sub-object. If it is a sub-object, then the selector must be set to the
selectorkey of the sub-object. For example, using the same xpath as above:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#fixed-attribute-values","title":"Fixed attribute values","text":"performer:\n Name: \n selector: //h1[@itemprop=\"name\"]\n postProcess:\n # post-processing config values\nAlternatively, an attribute value may be set to a fixed value, rather than scraping it from the webpage. This can be done by replacing
selectorwithfixed. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#common-fragments","title":"Common fragments","text":"performer:\n Gender: \n fixed: Female\nThe
commonfield is used to configure selector fragments that can be referenced in the selector strings. These are key-value pairs where the key is the string to reference the fragment, and the value is the string that the fragment will be replaced with. For example:common:\n $infoPiece: //div[@class=\"infoPiece\"]/span\nperformer:\n Measurements: $infoPiece[text() = 'Measurements:']/../span[@class=\"smallInfo\"]\nThe
Measurementsxpath string will replace$infoPiecewith//div[@class=\"infoPiece\"]/span, resulting in://div[@class=\"infoPiece\"]/span[text() = 'Measurements:']/../span[@class=\"smallInfo\"].\u26a0\ufe0f Note: Recursive common fragments are not supported. Referencing a common fragment within another common fragment will cause an error. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#post-processing-options","title":"Post-processing options","text":"common:\n $info: //div[@class=\"info\"]\n # Referencing $info in $models will cause an error\n $models: $info/a[@class=\"model\"]\nscene:\n Title: $info/h1\n Performers:\n Name: $models\n URL: $models/@href\nPost-processing operations are contained in the
postProcesskey. Post-processing operations are performed in the order they are specified. The following post-processing operations are available:javascript: accepts a javascript code block, that must return a string value. The input string is declared in thevaluevariable. If an error occurs while compiling or running the script, then the original value is returned. Example:performer:\n Name:\n selector: //div[@class=\"example element\"]\n postProcess:\n - javascript: |\n // capitalise the first letter\n if (value && value.length) {\n return value[0].toUpperCase() + value.substring(1)\n }\n
We use
gojajavascript engine which is missing a few built-in methods and may not be consistent with other modern javascript implementations.feetToCm: converts a string containing feet and inches numbers into centimeters. Looks for up to two separate integers and interprets the first as the number of feet, and the second as the number of inches. The numbers can be separated by any non-numeric character including the.character. It does not handle decimal numbers. For example6.3and6ft3.3would both be interpreted as 6 feet, 3 inches before converting into centimeters.lbToKg: converts a string containing lbs to kg.-
map: contains a map of input values to output values. Where a value matches one of the input values, it is replaced with the matching output value. If no value is matched, then value is unmodified. Example:
Gets the contents of the selected div element, and sets the returned value to:performer:\n Gender:\n selector: //div[@class=\"example element\"]\n postProcess:\n - map:\n F: Female\n M: Male\n Height:\n selector: //span[@id=\"height\"]\n postProcess:\n - feetToCm: true\n Weight:\n selector: //span[@id=\"weight\"]\n postProcess:\n - lbToKg: true\nFemaleif the scraped value isF;Maleif the scraped value isM.
Height and weight are extracted from the selected spans and converted to
cmandkg. -
parseDate: if present, the value is the date format using go's reference date (2006-01-02). For example, if an example date was14-Mar-2003, then the date format would be02-Jan-2006. See the time.Parse documentation for details. When present, the scraper will convert the input string into a date, then convert it to the string format used by stash (YYYY-MM-DD). Strings \"Today\", \"Yesterday\" are matched (case insensitive) and converted by the scraper so you don't need to edit/replace them. Unix timestamps (example: 1660169451) can also be parsed by selectingunixas the date format. Example:Date:\n selector: //div[@class=\"value epoch\"]/text()\n postProcess:\n - parseDate: unix\n -
subtractDays: if set totrueit subtracts the value in days from the current date and returns the resulting date in stash's date format. Example:Date:\n selector: //strong[contains(text(),\"Added:\")]/following-sibling::text()\n postProcess:\n - replace:\n - regex: (\\d+)\\sdays\\sago.+\n with: $1\n - subtractDays: true\n -
replace: contains an array of sub-objects. Each sub-object must have aregexandwithfield. Theregexfield is the regex pattern to replace, andwithis the string to replace it with.$is used to reference capture groups -$1is the first capture group,$2the second and so on. Replacements are performed in order of the array. Example:
ReplacesCareerLength: \n selector: $infoPiece[text() = 'Career Start and End:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace:\n - regex: \\s+to\\s+\n with: \"-\"\n2001 to 2003with2001-2003. -
subScraper: if present, the sub-scraper will be executed after all other post-processes are complete and before parseDate. It then takes the value and performs an http request, using the value as the URL. Within thesubScraperconfig is a nested scraping configuration. This allows you to traverse to other webpages to get the attribute value you are after. For more info and examples have a look at #370, #606
Additionally, there are a number of fixed post-processing fields that are specified at the attribute level (not in
postProcess) that are performed after thepostProcessoperations:concat: if an xpath matches multiple elements, andconcatis present, then all of the elements will be concatenated togethersplit: the inverse ofconcat. Splits a string to more elements using the separator given. For more info and examples have a look at PR #579 Example:
Splits a comma separated list of tags located in the span and returns the tags.Tags:\n Name:\n selector: //span[@class=\"list_attributes\"]\n split: \",\"\n
For backwards compatibility,
replace,subscraperandparseDateare also allowed as keys for the attribute.Post-processing on attribute post-process is done in the following order:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-resources","title":"XPath resources:","text":"concat,replace,subscraper,parseDateand thensplit.- Test XPaths in Firefox: https://addons.mozilla.org/en-US/firefox/addon/try-xpath/
- XPath cheatsheet: https://devhints.io/xpath
- GJSON Path Syntax: https://github.com/tidwall/gjson/blob/master/SYNTAX.md
To print the received html/json from a scraper request to the log file, add the following to your scraper yml file:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cdp-support","title":"CDP support","text":"debug:\n printHTML: true\nSome websites deliver content that cannot be scraped using the raw html file alone. These websites use javascript to dynamically load the content. As such, direct xpath scraping will not work on these websites. There is an option to use Chrome DevTools Protocol to load the webpage using an instance of Chrome, then scrape the result.
Chrome CDP support can be enabled for a specific scraping configuration by adding the following to the root of the yml configuration:
driver:\n useCDP: true\nOptionally, you can add a
sleepvalue under thedriversection. This specifies the amount of time (in seconds) that the scraper should wait after loading the website to perform the scrape. This is needed as some sites need more time for loading scripts to finish. If unset, this value defaults to 2 seconds.When
useCDPis set to true, stash will execute or connect to an instance of Chrome. The behavior is dictated by theChrome CDP pathsetting in the user configuration. If left empty, stash will attempt to find the Chrome executable in the path environment, and will fail if it cannot find one.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cdp-click-support","title":"CDP Click support","text":"Chrome CDP pathcan be set to a path to the chrome executable, or an http(s) address to remote chrome instance (for example:http://localhost:9222/json/version). As remote instance a docker container can also be used with thechromedp/headless-shellimage being highly recommended.When using CDP you can use the
clickspart of thedriversection to do Mouse Clicks on elements you need to collapse or toggle. Each click element has anxpathvalue that holds the XPath for the button/element you need to click and an optionalsleepvalue that is the time in seconds to wait for after clicking. If thesleepvalue is not set it defaults to2seconds.A demo scraper using
clicksfollows.name: clickDemo # demo only for a single URL\nsceneByURL:\n - action: scrapeXPath\n url:\n - https://getbootstrap.com/docs/4.3/components/collapse/\n scraper: sceneScraper\n\nxPathScrapers:\n sceneScraper:\n scene:\n Title: //head/title\n Details: # shows the id/s of the visible div/s for the Multiple targets example of the page\n selector: //div[@class=\"bd-example\"]//div[@class=\"multi-collapse collapse show\"]/@id\n concat: \"\\n\\n\"\n\ndriver:\n useCDP: true\n sleep: 1\n clicks: # demo usage toggle on off multiple times\n - xpath: //a[@href=\"#multiCollapseExample1\"] # toggle on first element\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle on second element\n sleep: 4\n - xpath: //a[@href=\"#multiCollapseExample1\"] # toggle off fist element\n sleep: 1\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle off second element\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle on second element\n\u26a0\ufe0f Note: each
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cookie-support","title":"Cookie support","text":"clickadds an extra delay ofclicks sleepseconds, so the above adds2+4+1+2+2=11seconds to the loading time of the page.In some websites the use of cookies is needed to bypass a welcoming message or some other kind of protection. Stash supports the setting of cookies for the direct xpath scraper and the CDP based one. Due to implementation issues the usage varies a bit.
To use the cookie functionality a
cookiessub section needs to be added to thedriversection. Each cookie element can consist of aCookieURLand a number ofCookies.-
CookieURLis only needed if you are using the direct / native scraper method. It is the request url that we expect from the site we scrape. It must be in the same domain as the cookies we try to set otherwise all cookies in the same group will fail to set. If theCookieURLis not a valid URL then again the cookies of that group will fail. -
Cookiesare the actual cookies we set. When using CDP that's the only part required. They haveName,Value,Domain,Pathvalues.
In the following example we use cookies for a site using the direct / native xpath scraper. We expect requests to come from
https://www.example.comandhttps://api.somewhere.comthat look for a_warningand a_warncookie. A_test2cookie is also set just as a demo.driver:\n cookies:\n - CookieURL: \"https://www.example.com\"\n Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n Value: \"123412\"\n Domain: \".example.com\"\n Path: \"/\"\n - CookieURL: \"https://api.somewhere.com\"\n Cookies:\n - Name: \"_warn\"\n Value: \"123\"\n Domain: \".somewhere.com\"\nThe same functionality when using CDP would look like this:
driver:\n useCDP: true\n cookies:\n - Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n Value: \"123412\"\n Domain: \".example.com\"\n Path: \"/\"\n - Cookies:\n - Name: \"_warn\"\n Value: \"123\"\n Domain: \".somewhere.com\"\nFor some sites, the value of the cookie itself doesn't actually matter. In these cases, we can use the
ValueRandomproperty instead ofValue. UnlikeValue,ValueRandomrequires an integer value greater than0where the value indicates how long the cookie string should be.In the following example, we will adapt the previous cookies to use
ValueRandominstead. We set the_test2cookie to randomly generate a value with a length of 6 characters and the_warncookie to a length of 3.driver:\n cookies:\n - CookieURL: \"https://www.example.com\"\n Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n ValueRandom: 6\n Domain: \".example.com\"\n Path: \"/\"\n - CookieURL: \"https://api.somewhere.com\"\n Cookies:\n - Name: \"_warn\"\n ValueRandom: 3\n Domain: \".somewhere.com\"\nWhen developing a scraper you can have a look at the cookies set by a site by adding
-
a
CookieURLif you use the direct xpath scraper -
a
Domainif you use the CDP scraper
and having a look at the log / console in debug mode.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#headers","title":"Headers","text":"Sending request headers is possible when using a scraper. Headers can be set in the
driversection and are supported for plain, CDP enabled and JSON scrapers. They consist of a Key and a Value. If the Key is empty or not defined then the header is ignored.driver:\n headers:\n - Key: User-Agent\n Value: My Stash Scraper\n - Key: Authorization\n Value: Bearer ds3sdfcFdfY17p4qBkTVF03zscUU2glSjWF17bZyoe8\n- headers are set after stash's
User-Agentconfiguration option is applied. This means setting aUser-Agentheader from the scraper overrides the one in the configuration settings.
A performer and scene xpath scraper is shown as an example below:
name: Pornhub\nperformerByURL:\n - action: scrapeXPath\n url: \n - pornhub.com\n scraper: performerScraper\nsceneByURL:\n - action: scrapeXPath\n url: \n - pornhub.com/view_video.php\n scraper: sceneScraper\nxPathScrapers:\n performerScraper:\n common:\n $infoPiece: //div[@class=\"infoPiece\"]/span\n performer:\n Name: //h1[@itemprop=\"name\"]\n Birthdate: \n selector: //span[@itemprop=\"birthDate\"]\n parseDate: Jan 2, 2006\n Twitter: //span[text() = 'Twitter']/../@href\n Instagram: //span[text() = 'Instagram']/../@href\n Measurements: $infoPiece[text() = 'Measurements:']/../span[@class=\"smallInfo\"]\n Height: \n selector: $infoPiece[text() = 'Height:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace: \n - regex: .*\\((\\d+) cm\\)\n with: $1\n Ethnicity: $infoPiece[text() = 'Ethnicity:']/../span[@class=\"smallInfo\"]\n FakeTits: $infoPiece[text() = 'Fake Boobs:']/../span[@class=\"smallInfo\"]\n Piercings: $infoPiece[text() = 'Piercings:']/../span[@class=\"smallInfo\"]\n Tattoos: $infoPiece[text() = 'Tattoos:']/../span[@class=\"smallInfo\"]\n CareerLength: \n selector: $infoPiece[text() = 'Career Start and End:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace:\n - regex: \\s+to\\s+\n with: \"-\"\n sceneScraper:\n common:\n $performer: //div[@class=\"pornstarsWrapper\"]/a[@data-mxptype=\"Pornstar\"]\n $studio: //div[@data-type=\"channel\"]/a\n scene:\n Title: //div[@id=\"main-container\"]/@data-video-title\n Tags: \n Name: //div[@class=\"categoriesWrapper\"]//a[not(@class=\"add-btn-small \")]\n Performers:\n Name: $performer/@data-mxptext\n URL: $performer/@href\n Studio:\n Name: $studio\n URL: $studio/@href \nSee also #333 for more examples.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#json-scraper-example","title":"JSON scraper example","text":"A performer and scene scraper for ThePornDB is shown below:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#object-fields","title":"Object fields","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#gallery","title":"Gallery","text":"name: ThePornDB\nperformerByName:\n action: scrapeJson\n queryURL: https://api.metadataapi.net/performers?q={}\n scraper: performerSearch\nperformerByURL:\n - action: scrapeJson\n url:\n - https://api.metadataapi.net/performers/\n scraper: performerScraper\nsceneByURL:\n - action: scrapeJson\n url:\n - https://api.metadataapi.net/scenes/\n scraper: sceneScraper\nsceneByFragment:\n action: scrapeJson\n queryURL: https://api.metadataapi.net/scenes?parse={filename}&hash={oshash}&limit=1\n scraper: sceneQueryScraper\n queryURLReplace:\n filename:\n - regex: \"[^a-zA-Z\\\\d\\\\-._~]\" # clean filename so that it can construct a valid url\n with: \".\" # \"%20\"\n - regex: HEVC\n with:\n - regex: x265\n with:\n - regex: \\.+\n with: \".\"\njsonScrapers:\n performerSearch:\n performer:\n Name: data.#.name\n URL:\n selector: data.#.id\n postProcess:\n - replace:\n - regex: ^\n with: https://api.metadataapi.net/performers/\n\n performerScraper:\n common:\n $extras: data.extras\n performer:\n Name: data.name\n Gender: $extras.gender\n Birthdate: $extras.birthday\n Ethnicity: $extras.ethnicity\n Height:\n selector: $extras.height\n postProcess:\n - replace:\n - regex: cm\n with:\n Measurements: $extras.measurements\n Tattoos: $extras.tattoos\n Piercings: $extras.piercings\n Aliases: data.aliases\n Image: data.image\n\n sceneScraper:\n common:\n $performers: data.performers\n scene:\n Title: data.title\n Details: data.description\n Date: data.date\n URL: data.url\n Image: data.background.small\n Performers:\n Name: data.performers.#.name\n Studio:\n Name: data.site.name\n Tags:\n Name: data.tags.#.tag\n\n sceneQueryScraper:\n common:\n $data: data.0\n $performers: data.0.performers\n scene:\n Title: $data.title\n Details: $data.description\n Date: $data.date\n URL: $data.url\n Image: $data.background.small\n Performers:\n Name: $data.performers.#.name\n Studio:\n Name: $data.site.name\n Tags:\n Name: $data.tags.#.tag\ndriver:\n headers:\n - Key: User-Agent\n Value: Stash JSON Scraper\n - Key: Authorization\n Value: Bearer lPdwFdfY17p4qBkTVF03zscUU2glSjdf17bZyoe # use an actual API Key here\n# Last Updated April 7, 2021\nCode\nDate\nDetails\nPerformers (see Performer fields)\nPhotographer\nRating\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#group","title":"Group","text":"Titlefield is required.Aliases\nBackImage\nDate\nDirector\nDuration\nFrontImage\nName\nRating\nStudio (see Studio Fields)\nSynopsis\nTags (see Tag fields)\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#image","title":"Image","text":"Namefield is required.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#performer","title":"Performer","text":"Code\nDate\nDetails\nPerformers (see Performer fields)\nPhotographer\nRating\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nAliases\nBirthdate\nCareerLength\nCircumcised\nCountry\nDeathDate\nDetails\nDisambiguation\nEthnicity\nEyeColor\nFakeTits\nGender\nHairColor\nHeight\nMeasurements\nName\nPenisLength\nPiercings\nTags (see Tag fields)\nTattoos\nURLs\nWeight\nImportant:
Namefield is required.Note: -
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scene","title":"Scene","text":"Gendermust be one ofmale,female,transgender_male,transgender_female,intersex,non_binary(case insensitive).Code\nDate\nDetails\nDirector\nGroups (see Group Fields)\nImage\nPerformers (see Performer fields)\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#studio","title":"Studio","text":"Titlefield is required only if fileless.Name\nURL\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#tag","title":"Tag","text":"Namefield is required.Name\nImportant:
"},{"location":"in-app-manual/tasks/","title":"Tasks","text":""},{"location":"in-app-manual/tasks/#tasks","title":"Tasks","text":"Namefield is required.This page allows you to direct the stash server to perform a variety of tasks.
"},{"location":"in-app-manual/tasks/#scanning","title":"Scanning","text":"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* Accessible in Advanced Mode - 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."},{"location":"in-app-manual/tasks/#auto-tagging","title":"Auto Tagging","text":"See the Auto Tagging page.
"},{"location":"in-app-manual/tasks/#scene-filename-parser","title":"Scene Filename Parser","text":"See the Scene Filename Parser page.
"},{"location":"in-app-manual/tasks/#generated-content","title":"Generated Content","text":"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 Accessible in Advanced Mode - 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 Accessible in Advanced Mode - 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 Accessible in Advanced Mode - 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."},{"location":"in-app-manual/tasks/#transcodes","title":"Transcodes","text":"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.
"},{"location":"in-app-manual/tasks/#image-gallery-thumbnails","title":"Image gallery thumbnails","text":"These are generated when the gallery is first viewed, so generating them beforehand is not necessary.
"},{"location":"in-app-manual/tasks/#cleaning","title":"Cleaning","text":"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.
"},{"location":"in-app-manual/tasks/#exporting-and-importing","title":"Exporting and Importing","text":"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.
\u26a0\ufe0f Note: The full import task wipes the current database completely before importing.
See the JSON Specification page for details on the exported JSON format.
"},{"location":"in-app-manual/tasks/autotagging/","title":"Auto tagging","text":""},{"location":"in-app-manual/tasks/autotagging/#auto-tagging","title":"Auto Tagging","text":"When media filepaths or filenames contain a Performer, Studio, or Tag name, it is assigned those Performers, Studios, and Tags. It will only tag based on Performer, Studio, and Tag names that exist in your database.
When the Performer/Studio/Tag name has multiple words, the search will include paths/filenames where the Performer/Studio/Tag name is separated with
.,-,_, and whitespace characters.For example, auto tagging for performer
Jane Doewill match the following filenames:Jane.Doe.1.mp4Jane_Doe.2.mp4Jane-Doe.3.mp4Jane Doe.4.mp4
Matching is case insensitive, and should only match exact wording within word boundaries. For example, the tag
Jane Doewill not matchMaryjane-DoeorJane-Doen, but will matchMary-Jane-Doe,Jane-Doe_n, and[OF]jane doe.Auto tagging for specific Performers, Studios, and Tags can be performed from the individual Performer/Studio/Tag page.
Note: Performer autotagging does not currently match on performer aliases.
"},{"location":"in-app-manual/tasks/identify/","title":"Identify","text":""},{"location":"in-app-manual/tasks/identify/#identify","title":"Identify","text":"This task iterates through your Scenes and attempts to identify the scene using a selection of scraping sources.
This task accepts one or more scraper sources. Valid scraper sources for the Identify task are stash-box instances, and scene scrapers which support scraping via Scene Fragment. The order of the sources may be rearranged.
For each Scene, the Identify task iterates through the scraper sources, in the order provided, and tries to identify the scene using each source. If a result is found in a source, then the Scene is updated, and no further sources are checked for that scene.
"},{"location":"in-app-manual/tasks/identify/#options","title":"Options","text":"The following options can be set:
Option Description Include male performers If false, then male performers will not be created or set on scenes. Set cover images If false, then scene cover images will not be modified. Set organised flag If true, the organised flag is set to true when a scene is organised. Skip matches that have more than one result If this is not enabled and more than one result is returned, one will be randomly chosen to match Tag skipped matches with If the above option is set and a scene is skipped, this will add the tag so that you can filter for it in the Scene Tagger view and choose the correct match by hand Skip single name performers with no disambiguation If this is not enabled, performers that are often generic like Samantha or Olga will be matched Tag skipped performers with If the above options is set and a performer is skipped, this will add the tag so that you can filter for in it the Scene Tagger view and choose how you want to handle those performersField specific options may be set as well. Each field may have a Strategy. The behaviour for each strategy value is as follows:
Strategy Description Ignore Not set. Overwrite Overwrite existing value. Merge (default) For multi-value fields, adds to existing values. For single-value fields, only sets if not already set.For Studio, Performers and Tags, an option is also available to Create Missing objects. This is enabled by default. When true, if a Studio/Performer/Tag is included during the identification process and does not exist in the system, then it will be created.
Default Options are applied to all sources unless overridden in specific source options.
The result of the identification process for each scene is output to the log.
"},{"location":"in-app-manual/tasks/jsonspec/","title":"Import/export JSON specification","text":""},{"location":"in-app-manual/tasks/jsonspec/#importexport-json-specification","title":"Import/Export JSON Specification","text":"The metadata given to Stash can be exported into the JSON format. This structure can be modified, or replicated by other means. The resulting data can then be imported again, giving the possibility for automatic scraping of all kinds. The format of this metadata bulk is a folder structure, containing the following folders:
filesgalleriesimagesperformersscenesstudiosgroups
When exported, files are named with different formats depending on the object type:
Type Format Files/Folders<path depth in hex, two character width>.<basename>.<hash>.jsonGalleries<first zip filename>.<path hash>.jsonor<folder basename>.<path hash>.jsonor<title>.jsonImages<title or first file basename>.<hash>.jsonPerformers<name>.jsonScenes<title or first file basename>.<hash>.jsonStudios<name>.jsonGroups<name>.jsonNote that the file naming is not significant when importing. All json files will be read from the subdirectories.
"},{"location":"in-app-manual/tasks/jsonspec/#content-of-the-json-files","title":"Content of the json files","text":"In the following, the values of the according jsons will be shown. If the value should be a number, it is written with after comma values (like
29.98or50.0), but still as a string. The meaning from most of them should be obvious due to the previous explanation or from the possible values stash offers when editing, otherwise a short comment will be added.The json values are given as strings, if not stated otherwise. Every new line will stand for a new value in the json. If the value is a list of objects, the values of that object will be shown indented.
If a value is empty in any file, it can be left out of the file entirely. Many files have an
created_atandupdated_at, both are kept in the following format:
Example:YYYY-MM-DDThh:mm:ssTZD \n
"},{"location":"in-app-manual/tasks/jsonspec/#performer","title":"Performer","text":"\"created_at\": \"2019-05-03T21:36:58+01:00\"\n
"},{"location":"in-app-manual/tasks/jsonspec/#studio","title":"Studio","text":"name \nurl \ntwitter \ninstagram \nbirthdate \ndeath_date \nethnicity \ncountry \nhair_color \neye_color \nheight \nweight \nmeasurements \nfake_tits \ncareer_length \ntattoos \npiercings \nimage (base64 encoding of the image file) \ncreated_at \nupdated_at\nrating (integer)\ndetails\n
"},{"location":"in-app-manual/tasks/jsonspec/#scene","title":"Scene","text":"name \nurl \nimage (base64 encoding of the image file) \ncreated_at \nupdated_at\nrating (integer) \ndetails \n
"},{"location":"in-app-manual/tasks/jsonspec/#image","title":"Image","text":"title \nstudio \nurl \ndate \nrating (integer) \ndetails \nperformers (list of strings, performers name) \ntags (list of strings) \nmarkers \n title \n seconds \n primary_tag \n tags (list of strings) \n created_at \n updated_at \nfile (not a list, but a single object) \n size (in bytes, no after comma values) \n duration (in seconds) \n video_codec (example value: h264) \n audio_codec (example value: aac) \n width (integer, in pixel) \n height (integer, in pixel) \n framerate \n bitrate (integer, in Bit) \ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#gallery","title":"Gallery","text":"title \nstudio \nrating (integer) \nperformers (list of strings, performers name) \ntags (list of strings) \nfiles (list of path strings)\ngalleries\n zip_files (list of path strings)\n folder_path\n title (for user-created gallery)\ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#files","title":"Files","text":""},{"location":"in-app-manual/tasks/jsonspec/#folder","title":"Folder","text":"title \nstudio \nurl \ndate \nrating (integer) \ndetails \nperformers (list of strings, performers name) \ntags (list of strings) \nzip_files (list of path strings)\nfolder_path \ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#video-file","title":"Video file","text":"zip_file (path to containing zip file)\nmod_time\ntype (= folder)\npath\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#image-file","title":"Image file","text":"zip_file (path to containing zip file)\nmod_time\ntype (= video)\npath\nfingerprints\n type\n fingerprint\nsize\nformat\nwidth\nheight\nduration\nvideo_codec\naudio_codec\nframe\nbitrate\ninteractive (bool)\ninteractive_speed (integer)\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#other-files","title":"Other files","text":"zip_file (path to containing zip file)\nmod_time\ntype (= image)\npath\nfingerprints\n type\n fingerprint\nsize\nformat\nwidth\nheight\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#in-json-format","title":"In JSON format","text":"zip_file (path to containing zip file)\nmod_time\ntype (= file)\npath\nfingerprints\n type\n fingerprint\nsize\ncreated_at\nupdated_at\nFor those preferring the json-format, defined here, the following format may be more interesting:
"},{"location":"in-app-manual/tasks/jsonspec/#performerjson","title":"performer.json","text":"
"},{"location":"in-app-manual/tasks/jsonspec/#studiojson","title":"studio.json","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#performerjson\",\n \"title\": \"performer\",\n \"description\": \"A json file representing a performer. The file is named by a MD5 Code.\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the performer\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"URL to website of the performer\",\n \"type\": \"string\"\n },\n \"twitter\": {\n \"description\": \"Twitter name of the performer\",\n \"type\": \"string\"\n },\n \"instagram\": {\n \"description\": \"Instagram name of the performer\",\n \"type\": \"string\"\n },\n \"birthdate\": {\n \"description\": \"Birthdate of the performer. Format is YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"death_date\": {\n \"description\": \"Death date of the performer. Format is YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"ethnicity\": {\n \"description\": \"Ethnicity of the Performer. Possible values are black, white, asian or hispanic\",\n \"type\": \"string\"\n },\n \"country\": {\n \"description\": \"Country of the performer\",\n \"type\": \"string\"\n },\n \"hair_color\": {\n \"description\": \"Hair color of the performer\",\n \"type\": \"string\"\n },\n \"eye_color\": {\n \"description\": \"Eye color of the performer\",\n \"type\": \"string\"\n },\n \"height\": {\n \"description\": \"Height of the performer in centimeters\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"description\": \"Weight of the performer in kilograms\",\n \"type\": \"string\"\n },\n \"measurements\": {\n \"description\": \"Measurements of the performer\",\n \"type\": \"string\"\n },\n \"fake_tits\": {\n \"description\": \"Whether performer has fake tits. Possible are Yes or No\",\n \"type\": \"string\"\n },\n \"career_length\": {\n \"description\": \"The time the performer has been in business. In the format YYYY-YYYY\",\n \"type\": \"string\"\n },\n \"tattoos\": {\n \"description\": \"Giving a description of Tattoos of the performer if any\",\n \"type\": \"string\"\n },\n \"piercings\": {\n \"description\": \"Giving a description of Piercings of the performer if any\",\n \"type\": \"string\"\n },\n \"image\": {\n \"description\": \"Image of the performer, parsed into base64\",\n \"type\": \"string\"\n },\n \"created_at\": {\n \"description\": \"The time this performers data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this performers data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"details\": {\n \"description\": \"Description of the performer\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"name\", \"ethnicity\", \"image\", \"created_at\", \"updated_at\"]\n}\n
"},{"location":"in-app-manual/tasks/jsonspec/#scenejson","title":"scene.json","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#studiojson\",\n \"title\": \"studio\",\n \"description\": \"A json file representing a studio. The file is named by a MD5 Code.\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the studio\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"URL to the studios websites\",\n \"type\": \"string\"\n },\n \"image\": {\n \"description\": \"Logo of the studio, parsed into base64\",\n \"type\": \"string\"\n },\n \"created_at\": {\n \"description\": \"The time this studios data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this studios data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"details\": {\n \"description\": \"Description of the studio\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"name\", \"image\", \"created_at\", \"updated_at\"]\n}\n
"},{"location":"in-app-manual/tasks/scenefilenameparser/","title":"Scene filename parser","text":""},{"location":"in-app-manual/tasks/scenefilenameparser/#scene-filename-parser","title":"Scene Filename Parser","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#scenejson\",\n \"title\": \"scene\",\n \"description\": \"A json file representing a scene. The file is named by the MD5 Code of the file its data is referring to.\",\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"description\": \"Title of the scene\",\n \"type\": \"string\"\n },\n \"studio\": {\n \"description\": \"The name of the studio that produced that scene\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"The url to the scenes original source\",\n \"type\": \"string\"\n },\n \"date\": {\n \"description\": \"The release date of the scene. Its given in the format YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"rating\": {\n \"description\": \"The scenes Rating. Its given in stars, from 1 to 5\",\n \"type\": \"integer\"\n },\n \"details\": {\n \"description\": \"A description of the scene, containing things like the story arc\",\n \"type\": \"string\"\n },\n \"performers\": {\n \"description\": \"A list of names of the performers in this gallery\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"tags\": {\n \"description\": \"A list of the tags associated with this scene\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"markers\": {\n \"description\": \"Markers mark certain events in the scene, most often the change of the position. They are attributed with their own tags.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"description\": \"Searchable name of the marker\",\n \"type\": \"string\"\n },\n \"seconds\": {\n \"description\": \"At what second the marker is set. It is given with after comma values, such as 10.0 or 17.5\",\n \"type\": \"string\"\n },\n \"primary_tag\": {\n \"description\": \"A tag identifying this marker. Multiple markers from the same scene with the same primary tag are concatenated, showing them as similar in nature\",\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"A list of the tags associated with this marker\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"created_at\": {\n \"description\": \"The time this marker was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this marker was updated the last time. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n }\n\n },\n \"required\": [\"seconds\", \"primary_tag\", \"created_at\", \"updated_at\"]\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"files\": {\n \"description\": \"A list of paths of the files for this scene\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"created_at\": {\n \"description\": \"The time this studios data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this studios data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"files\", \"created_at\", \"updated_at\"]\n}\nThis tool parses the scene filenames in your library and allows setting the metadata from those filenames.
"},{"location":"in-app-manual/tasks/scenefilenameparser/#parser-options","title":"Parser Options","text":"To use this tool, a filename pattern must be entered. The pattern accepts the following fields:
Field RemarktitleText captured within is set as the title of the scene.extMatches the end of the filename. It is not captured. Does not include the last.character.dMatches delimiter characters (-_.). Not captured.iMatches any ignored word entered in theIgnored wordsfield. Ignored words are entered as space-delimited words. Not captured. Use this to match release artifacts likeDVDRipor release groups.dateMatchesyyyy-mm-ddand sets the date of the scene.ratingMatches a single digit and sets the rating of the scene.performerSets the scene performer, based on the text captured.tagSets the scene tag, based on the text captured.studioSets the studio performer, based on the text captured.{}Matches any characters. Not captured.\u26a0\ufe0f Note:
performer,tagandstudiofields will only match against Performers/Tags/Studios that already exist in the system.The
performer/tag/studiofields will remove any delimiter characters (.-_) before querying. Name matching is case-insensitive.The following partial date fields are also supported. The date will only be set on the scene if a date string can be built using the partial date components:
Field RemarkyyyyFour digit yearyyTwo digit year. Assumes the first two digits are20mmTwo digit monthmmmThree letter month, such asJan(case-insensitive)ddTwo digit dateThe following full date fields are supported, using the same partial date rules as above:
yyyymmddyymmddddmmyyyyddmmyymmddyyyymmddyy
All of these fields are available from the
Add Fieldbutton.Title generation also has the following options:
Option Remark Whitespace characters These characters are replaced with whitespace (defaults to._, to handle filenames likethree.word.title.aviCapitalize title capitalises the first letter of each wordThe fields to display can be customised with the
"},{"location":"in-app-manual/tasks/scenefilenameparser/#applying-the-results","title":"Applying the results","text":"Display Fieldsdrop-down section. By default, any field with new/different values will be displayed.Once the options are correct, click on the
Findbutton. The system will search for scenes that have filenames that match the given pattern.The results are presented in a table showing the existing and generated values of the discovered fields, along with a checkbox to determine whether or not the field will be set on each scene. These fields can also be edited manually.
The
Applybutton updates the scenes based on the set fields.\u26a0\ufe0f Note: results are paged and the
"},{"location":"installation/","title":"Installation","text":"Applybutton only applies to scenes on the current page.Stash offers native binaries for the following platforms:
- Windows
- macOS
- Linux
- FreeBSD
- Docker
All official binaries can be downloaded from our GitHub release page. Latest version is available here.
Official Docker image is hosted on Docker Hub. Latest version can be pulled from
"},{"location":"installation/docker/","title":"Docker","text":"stashapp/stash:latest.Info
Before starting make sure your system has Docker installed. You can follow the instructions on how to install Docker from Docker Docs.
Info
Official Stash image is located at
stashapp/stash.Note
Stash README on Docker installation is available here.
"},{"location":"installation/docker/#using-docker-compose","title":"Using Docker Compose","text":""},{"location":"installation/docker/#install","title":"Install","text":"- Download and save
docker-compose.ymlfile from our GitHub. - Modify the
docker-compose.ymlfile to your preferences. - Open terminal in the same directory as saved
docker-compose.ymlorcdto that directory. - Run
docker-compose up -d. - Installing this way will bound Stash to port 9999.
- If everything went well Stash will be available at http://localhost:9999 locally or on your network http://YOUR-LOCAL-IP:9999.
If you are upgrading from older than v0.20 version make sure to re-download the
docker-compose.ymlfile from our GitHub as new volume was added. Alternatively you can edit thedocker-compose.ymlto manually include new volume- ./blobs:/blobs.- Go to the directory where
docker-compose.ymlis saved. - Run
docker-compose pull. Pulls the new image. - Run
docker-compose down. Removes old container. - Run
docker-compose up -d. Creates and starts the new container. - Make sure the mount points and settings are the same as in previous
docker-compose.ymlfile.
- Go to the directory where
docker-compose.ymlis saved. - Run
docker container kill. Force stops the container. - Run
docker container rm. Removes the container. - Delete
docker-compose.ymlfile.
Info
The following step by step was tested using TrueNAS Scale Cobia (23.10.1.3).
"},{"location":"installation/freenas-truenas/#installation","title":"Installation","text":"To install the stashapp, we will use the TrueCharts app database. To install, we'll follow the official documentation at https://truecharts.org/manual/SCALE/guides/getting-started/
- Go to Apps page from the top level SCALE menu
- Click Discover Apps button on the Apps page
- Click Manage Catalogs link on the Discover Apps page
- Click Add Catalog
- After reading the iXsystems notice, click Continue and enter the required information: Name: truecharts Repository: https://github.com/truecharts/catalog Preferred Trains: enterprise, stable and operators (type each one manually) Branch: main
- Click Save and allow SCALE to refresh its catalog with TrueCharts (this may take a few minutes)
After the update is complete, use the search bar to search for \"stash\". When found, click Install.
"},{"location":"installation/freenas-truenas/#options","title":"Options","text":"The installation window will contain several customizable options, but the most important one is the storage option. Search for \"Additional App Storage\" on the page and click \"Add\".
In \"Type of Storage\", select \"Host Path\" if the desired folder is a Dataset. \"Host Path\" should be where your content will be. \"Mount Path\" is the name that appears in the stash for the selection. You can put anything here, like /stash-content for example. After that, click Install.
Installation will take a few minutes. After the stash appears as \"Running\", click \"Open\" on the right and continue with the stash configuration. When entering the folder that contains its contents, remember to search for the same name you entered previously. In the case of this guide, the name was /stash-content.
"},{"location":"installation/freenas-truenas/#truenas-core","title":"TrueNAS Core","text":"Info
We are now offering pre-compiled FreeBSD binary. You can grab it from release page.
Warning
The install guide below was reported as outdated.
"},{"location":"installation/freenas-truenas/#caveats-and-assumptions","title":"Caveats and assumptions","text":"- The method documented here has only been given cursory testing, so there may be compatibility problems.
- This method assumes that Stash will be run within a previously created iocage jail - the process to create and configure the jail is not included here.
- If the jail is in NAT mode, ensure that port 9999 is forwarded to your TrueNAS host.
- The alternative to this method is to compile from source, which is a more involved process and not documented here
In order for the
stash-linuxbinary to work in a FreeBSD system, Linux compatibility must be enabled both in the system and the jail. To enable Linux compatibility:- navigate to
System -> Tunablesin the TrueNAS Web UI - click
Addand enter the following:- Variable:
linux_enable - Value:
YES - Type:
rc.conf
- Variable:
- Click submit.
- In a shell in your iocage jail, edit
/etc/rc.confto add:enable_linux=\"YES\"\n - Reboot the system.
Go into your iocage jail and install
ffmpeg
"},{"location":"installation/freenas-truenas/#create-user-and-group","title":"Create user and group","text":"pkg install ffmpeg\nIt is recommended to not run services as root. Adjust this step to your system. in this example the user
stashwill be created and set to run the service.
"},{"location":"installation/freenas-truenas/#download-stash-linux","title":"Download stash-linux","text":"pw useradd -n stash -u 1069 -d /nonexistent -s /usr/sbin/nologin\nChoose where you would like to store the binary, in this example
/usr/local/binis selected as this is where the ffmpeg binaries also reside. Check github for latest release. Also remember to fix permissions and ownership
"},{"location":"installation/freenas-truenas/#create-configuration-directory","title":"Create configuration directory","text":"cd /usr/local/bin\nfetch https://github.com/stashapp/stash/releases/download/v0.22.1/stash-linux\nchown stash:stash stash-linux\nchmod +x stash-linux\nstash needs a directory for its config file, database and more. Remember to change ownership and permission for the folder you select. The script we will look at in the next step has this path as the default:
"},{"location":"installation/freenas-truenas/#rcd-startup-script","title":"rc.d startup script","text":"mkdir /usr/local/etc/stash\nchown stash:stash /usr/local/etc/stash\nIn order for stash to run as a daemon in the background, and also start at boot, you need a rc.d script.
Enter the following in the editor:mkdir /usr/local/etc/rc.d\nee /usr/local/etc/rc.d/stash\n
To save, press#!/bin/sh\n\n# PROVIDE: stash\n# REQUIRE: DAEMON\n# KEYWORD: shutdown\n\n\n. /etc/rc.subr\n\nname=stash\nrcvar=stash_enable\n\nload_rc_config $name\n\n: ${stash_enable:=\"NO\"}\n: ${stash_user:=\"stash\"}\n: ${stash_group:=\"stash\"}\n: ${stash_config_dir:=\"/usr/local/etc/stash/config.yml\"}\n: ${stash_exec_bin:=\"/usr/local/bin/stash-linux\"}\n\n#daemon\npidfile=\"/var/run/${name}.pid\"\ncommand=\"/usr/sbin/daemon\"\ncommand_args=\"-f -P ${pidfile} ${stash_exec_bin} --config ${stash_config_dir}\"\nstart_precmd=\"stash_precmd\"\n\nstash_precmd() {\n install -o ${stash_user} -g ${stash_group} /dev/null ${pidfile}\n}\n\nrun_rc_command $1\nESC + Enterand confirm withaand make it executable withchmod +x /usr/local/etc/rc.d/stash"},{"location":"installation/freenas-truenas/#enable-the-service-at-boot","title":"Enable the service at boot","text":"If you want Stash to run when you start the jail, run the following command:
And to start the service, reboot the jail or run this command:sysrc \"stash_enable=YES\"\n
Stash is now available at http://jail-IP:9999/service stash start\nDuring setup you can leave all the paths for config, database and etc empty to use the default. They will then be stored in the config-folder we created earlier so you can easily backup the folder. Only add your media content.
"},{"location":"installation/freenas-truenas/#optional-steps","title":"Optional steps","text":"You can change the location where stash stores the configuration files and database. Please note that the path needs to end with
config.ymleven if it does not exist yet. Stash will create it for you. Remember to fix ownership and permissions of the location you choose.sysrc \"stash_config_dir=path/to/location/config.yml\"\nYou can change the user and group that Stash runs as. Remember that the config_dir needs to be owned by the user that Stash runs as, aswell as the stash-linux binary
sysrc \"stash_user=usernamegoeshere\"\nsysrc \"stash_group=groupnamegoeshere\"\nIts also possible to change the location of the stash-linux binary ``` sysrc \"stash_exec_bin=/path/to/stash-linux\"
"},{"location":"installation/linux/","title":"Linux","text":"Info
It is recommended that you install
ffmpegfrom your distribution's package manager. In case you don't, Stash will prompt you to download a copy during setup.Note
Stash offers different binaries for different architectures. You can find your processor architecture by running a simple command
uname -pin a terminal. Replace<binary-name>in the following tutorial accordingly.
"},{"location":"installation/linux/#install","title":"Install","text":"stash-linux= amd64 (x86_64)stash-linux-arm32v6= arm32v6 (armel)stash-linux-arm32v7= arm32v7 (armhf)stash-linux-arm64v8= arm64v8 (arm64)- Download latest
<binary-name>binary from GitHub repository depending on your architecture. - Run
./<binary-name>from the terminal. - If you have trouble, try running
chmod u+x <binary-name>to make the file executable. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either by closing the terminal window or by stopping the process from task manager.
- Download latest
<binary-name>binary from GitHub repository. - Delete old
<binary-name>binary and replace it with the newly downloaded one. - Run
./<binary-name>from the terminal. - If you have trouble, try running
chmod u+x <binary-name>to make the file executable. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
<binary-name>binary file. - Delete
$HOME/.stashfolder.
On macOS, Stash can be run as either a packaged app (
"},{"location":"installation/macos/#packaged-app","title":"Packaged app","text":"Stash.app) or as a command-line app (stash-macos). Both are universal apps, and will therefore run natively on both Apple silicon and Intel-based Macs.Note
The packaged app is recommended for most users.
It supports desktop notifications, displays a menu bar icon, and does not need to be launched from the terminal.
However, due to app restrictions, it only supports setting up in
"},{"location":"installation/macos/#install","title":"Install","text":"$HOME/.stash. If you would like to use a different folder, then you will need to use the command-line app.- Download the latest
Stash.app.zipfrom GitHub repository. - Open
Stash.app.ziparchive and drag theStashapp to your Applications folder. - Open the
Stashapp. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either via icon in the menu bar or by stopping the process from Activity Monitor.
- Download latest
Stash.app.zipfrom GitHub repository. - Delete old
Stashapp. - Open newly downloaded
Stash.app.ziparchive and drag theStashapp to your Applications folder. - Open the
Stashapp. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
Stashapp. - Delete
$HOME/.stash.
Note
The command-line app is only recommended for users who are familiar with the terminal, or for those who do not want to set up in
$HOME/.stash.It does not support desktop notifications and does not display a menu bar icon. It must be launched from the terminal.
"},{"location":"installation/macos/#install_1","title":"Install","text":"- Download latest
stash-macosbinary from GitHub repository. -
Run
./stash-macosfrom the terminal.If you have trouble, try running
chmod u+x stash-macosto make the file executable. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either by closing the terminal window or by stopping the process from Activity Monitor.
- Download latest
stash-macosbinary from GitHub repository. - Delete old
stash-macosbinary and replace it with the newly downloaded one. -
Run
./stash-macosfrom the terminal.If you have trouble, try running
chmod u+x stash-macosto make the file executable. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
stash-macos. - Delete
$HOME/.stash.
Info
Written by Muldec.
"},{"location":"installation/synology/#foreword","title":"Foreword","text":"Synology devices comes in two categories: those who support containerization through Docker, and those who don't. To see in which category you stand, refer to the \"Applied Models\" section of the Docker Package page.
Now, follow the installation instructions based on whether you can use Docker or you cannot use Docker.
"},{"location":"installation/synology/#to-install-stash-with-docker","title":"To install Stash with Docker","text":"Note
Running Stash without Docker is possible even if your NAS is Docker ready. It offers more control on your Stash instance startup. As an example, it allows you to store your porn collection in an Encrypted Shared Folder, and only run Stash when the Encrypted folder is Mounted (Decrypted).
- Make sure the Docker app is installed and running correctly.
- Search the registry for stash and install.
- Create a stash image with the following set up in 'Advanced Settings':
(These will need to be the same as the Volumes you created in the \"Volume\" tab.)
variable Value PATH (keep as is) STASH_CACHE /cache STASH_METADATA /metadata STASH_GENERATED /generated STASH_STASH /data"},{"location":"installation/synology/#port-settings-section","title":"\"Port Settings\" section","text":"You will need to set a default port in the \"Port\" section, otherwise Docker will assign a different port every time Stash is launched. Leave the container port as-is.
"},{"location":"installation/synology/#network-section","title":"\"Network\" section","text":"Select the \"host\" network rather than \"bridge\".
(Thanks to backer Herelam80 for these instructions)
"},{"location":"installation/synology/#to-install-stash-without-docker","title":"To install Stash without Docker","text":"Warning
This method uses SSH to run command lines on the NAS. If you are unfamiliar with SSH or linux command lines, I suggest you not to go further, as making a mistake in the SSH session can really screw your NAS.
This is intended to work on DSM 7.0 and later. It will not work on any version prior to 7.0.
"},{"location":"installation/synology/#install-prerequisites","title":"Install Prerequisites","text":"In DSM, navigate to
Package Center > Settings. In thePackage Sourcestab, clickAdd, type SynoCommunity as Name and https://packages.synocommunity.com/ as Location and then pressOKto validate.Go back to the Package Center and look for
Python 3.11in the Community tab. Click onInstalland agree to the Third-Party Package warning.Then look for
"},{"location":"installation/synology/#enable-ssh","title":"Enable SSH","text":"Ffmpeg 6in the Community tab. Click onInstalland agree to the Third-Party Package warning.In DSM, navigate to
"},{"location":"installation/synology/#create-a-user-that-will-run-stash","title":"Create a user that will run stash","text":"Control Panel > Connectivity > Terminal & SNMPand check theEnable SSH servicebox.- In DSM, navigate to
Control Panel > File Sharing > User & Group - Click on the
Createbutton - Give it a name (eg stash) and a Password (you will need it later)
- Click
Nextuntil you are on the \"Join groups\" screen - Assign the user to the \"administrators\" group (this will be removed later, but is required by Synology to be able to use SSH (I know, it's stupid) and complete the installation properly)
- Click
Nextuntil you are on the \"Assign shared folders permissions\" screen - Assign the Read/Write permission to your porn folder (the write permission is needed to allow the deletion of clips from the stash app)
- Click
Nextuntil you are on the \"Assign application permissions\" screen - Check
Denyfor all applications - Click
Nextuntil you can click onDone
In your terminal, connect to your NAS using the newly created account that is part of the administrators group.
"},{"location":"installation/synology/#link-ffprobe-ffmpeg","title":"Link ffprobe & ffmpeg","text":"ssh stash@your_nas_hostname\nffmpeg has been installed earlier, but is missing a link to ffprobe (also installed) and the new version of ffmpeg. Run the following command.
"},{"location":"installation/synology/#download-stash","title":"Download Stash","text":"sudo ln -s /var/packages/ffmpeg6/target/bin/ffprobe /usr/local/bin/ffprobe\nsudo ln -s /var/packages/ffmpeg6/target/bin/ffmpeg /usr/local/bin/ffmpeg\nDownload the lastest version of Stash and its checksum from GitHub
# find what architecture your Synology is running on\nuname -m\n\n# depending on the architecture, you'll have to download the right version of stash\n\n# x86_64\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux\n# armv6l\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm32v6\n# armv7l\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm32v7\n# aarch64\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm64v8\n\n# Download the CHECKSUM\nwget https://github.com/stashapp/stash/releases/latest/download/CHECKSUMS_SHA1\n\n# Perform the checksum validation\nsha1sum -c --ignore-missing CHECKSUMS_SHA1\n\n# you should see a line that says `stash-linux: OK`\n# if not, something went wrong during the download\n\n# Clean up the now unnecessary file\nrm CHECKSUMS_SHA1\nDanger
DO NOT run stash yet or it will generate a bunch of files/folders where we don't want them.
"},{"location":"installation/synology/#python","title":"Python","text":"Prepare a Python environment (for scrapers and plugins)
"},{"location":"installation/synology/#configure-your-nas-to-run-stash","title":"Configure your NAS to run Stash","text":"python3.11 -m ensurepip --Update\npython3.11 -m venv stash-env\nsource stash-env/bin/activate\npip3 install pipreqs\nCreate a profile file
echo 'PATH=/usr/local/bin:$PATH' > .profile\necho 'source stash-env/bin/activate' >> .profile\nCreate the service file by running
cat > stash.service, copy/pasting the following, and hitting CTRL+D when it's done to save the file (hit again if you are not back to the prompt):[Unit]\nDescription=Run Stash at startup\nAfter=network.target\n\n[Service]\nWorkingDirectory=/var/services/homes/stash\nType=simple\nUser=stash\nExecStart=/bin/bash -c -l '\\\n exec ./stash-linux'\nRestart=on-failure\n\n[Install]\nWantedBy=multi-user.target\nNote
Change the
ExecStartline by providing the exact name of the stash executable that you downloaded previously.Start and activate the service
"},{"location":"installation/synology/#verify-that-it-is-working","title":"Verify that it is working","text":"sudo systemctl enable \"$(pwd)/stash.service\"\nsudo systemctl start stash.service\nYou can now access to stash by navigating to your NAS url on port 9999:
"},{"location":"installation/synology/#installing-scrapers-and-plugins","title":"Installing Scrapers and Plugins","text":"http://nas-hostname:9999Whenever you install a new Python scraper or plugin, do the following from the stash user home directory:
pipreqs .stash/.\npip3 install -r .stash/requirements.txt\nNote
Using pipreqs allows to scan all scrapers and plugins installed and find dependencies that they require. You can do the same thing without
"},{"location":"installation/synology/#remove-stash-user-from-administrator-group","title":"Remove stash user from administrator group","text":"pipreqsby going into each individual directory and runpip3 install -r requirements.txt- Go back to DSM, navigate to
Control Panel > File Sharing > User & Group - Click on the stash user and then on
Edit - In the
User Groupstab, uncheck \"administrators\" and click onSave
Info
Unraid app is maintained by a 3rd party. For Unraid specific support you can go to support thread by CorneliousJD.
Note
For users that want to try the development branch of Stash you can change the repository to
"},{"location":"installation/unraid/#install","title":"Install","text":"stashapp/stash:development.- Open Unraid and go to the
Appstab. - Enable apps (if disabled) and search for
Stash. - You can modify paths to your preference.
- Go to Docker tab and enable autostart for
Stash.
Info
binarygeek119/stash-cuda:latestrepository is not maintained by Stash core team.-
First off you need the unraid Nvidia plugin for this to work. On Unraid go to apps and do a search for
nvidia driverand install, this will take some time to install. When the dialog is done it is still installing in the background. When it has finshed you will get a popup saying it is safe to reboot now.Warning
Do not restart Unraid server until the plugin is done installing itself!
-
After getting the popup, reboot your server. After it back online you may continue to the next steps.
- To begin modifing start by going into edit mode by right click on stash icon on Unraid dashboard or in Docker tab.
- In edit mode go to the top and click on basic view to switch to advaced view.
"},{"location":"installation/unraid/#container-configuration","title":"Container configuration","text":"Now we can change some thing to have Stash work with a Nvidia GPU.
- Under Repository change the default Repository from
stashapp/stash:developmenttobinarygeek119/stash-cuda:latest. - Add the following under Extra Parameters:
--runtime=nvidia. - Go down to the bottom of the page and click on
Add another Path, Port, Variable, Label or Device. - Change
pathtoVariableand add the following:Name:enterNVIDIA_DRIVER_CAPABILITIESKey:enterNVIDIA_DRIVER_CAPABILITIESValue:enteralland click save.
- Go down to the bottom of the page and click on
Add another Path, Port, Variable, Label or Device. - Change
pathtoVariableand add the following:Name:enterNVIDIA_VISIBLE_DEVICESKey:enterNVIDIA_VISIBLE_DEVICESValue:enterGPU-xxxx-xxxx-xxx-xxxx-xxxx-xxx-xxxxxxxxxxxx
Where
GPU-xxxx-xxxx-xxx-xxxx-xxxx-xxx-xxxxxxxxxxxxyou must enter your own GPUID. To find it do the folowing:- On a new Unraid page click on settings.
- Go down to the bottom and click Nvidia Driver plugin.
- Copy the key and paste it under
VariablecalledValue.
- Click on save.
- Now click on apply and let the Docker download the new Nvidia version of Stash.
- Enjoy and use as before.
Note
Some Windows 11 versions might open Stash via Terminal instead of going to notification area. You can bypass that by running the program as administrator or use a shortcut to run it via conhost.exe. As a result of running as administrator Stash might fail to detect your Python installtion in PATH, so you need point it the correct way yourself after installation. In Settings > System and under Applications Paths header set Python Executable Path.
"},{"location":"installation/windows/#install","title":"Install","text":"- Download latest
stash-win.exebinary from GitHub repository. -
Run the executable (typically
stash-win.exe).Running the executable might present a security prompt since the binary isn't signed yet. Just click more info and then the
run anywaybutton. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- The program will show an icon in your notification area. You can access some quick links or quit the server from there.
- Stop Stash server. Either via icon in the notification area or by stopping the process from Task Manager.
- Download latest
stash-win.exebinary from GitHub repository. - Delete old
stash-win.exebinary and replace it with the newly downloaded one. -
Run the executable (typically
stash-win.exe).Running the executable might present a security prompt since the binary isn't signed yet. Just click more info and then the
run anywaybutton. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete the
stash-win.exebinary file. - Delete
%userprofile%/.stashfolder.
Info
Integrations are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Integrations are ways to integrate Stash into other programs.
To install follow the provided install instructions.
"},{"location":"integrations/list/","title":"Browse integrations","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Integration no longer worksIf you found that integration is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"integrations/list/#jellyfinpluginstash","title":"Jellyfin.Plugin.Stash","text":"DescriptionAuthorScreenshotsPulls data from your Stash using the filename to query on.
DirtyRacer1337
"},{"location":"integrations/list/#pluginvideostash","title":"plugin.video.stash","text":"DescriptionAuthorScreenshotsplugin.video.stash is an add-on for the Kodi home theater center software to incorporate Stash, an organizer for your porn.
gitgiggety
"},{"location":"integrations/list/#stashplexagentbundle","title":"StashPlexAgent.bundle","text":"DescriptionAuthorScreenshotsA very simplistic Plex agent to pull metadata from Stash.
Darklyter
"},{"location":"metadata-sources/","title":"Metadata sources","text":"There are several ways to get metadata into Stash.
You can configure your metadata sources under Settings > Metadata Providers. See sections below for more details.
- stash-box instances - more automatic, crowdsourced metadata
- Scrapers - more individual, can be used for different databases, official studios
Scrapers are the way to retrieve information from websites for your scenes/groups/galleries/performers. Using scrapers wisely, you can avoid typing information manually and repetitively. They can help you quickly establish links between groups/scenes and performers/studios, add relative tags, then download covers/posters for easy recognition. It's a great feature to organize your video or image collections.
"},{"location":"metadata-sources/scrapers/#managing-scrapers","title":"Managing scrapers","text":"Scrapers can be installed and managed from the Settings > Metadata Providers page.
Scrapers are installed using the Available Scrapers section. The Community (stable) source is configured by default.
Installed plugins can be updated or uninstalled from the Installed Scrapers section.
"},{"location":"metadata-sources/scrapers/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for scrapers. To add a new source go to Settings > Metadata Providers page and under Available Scrapers click Add Source.
"},{"location":"metadata-sources/scrapers/#installing-scrapers-manually","title":"Installing scrapers manually","text":"By default, Stash looks for scrapers configurations in the scrapers sub-directory of the directory where the stash
config.ymlis read. This will either be the%USERPROFILE%\\.stash\\scraperson Windows or/root/.stash/scraperson Unix systems (Mac, Linux, etc.) or the current working directory.Scrapers are added by adding configuration yaml files (format:
scraperName.yml) to thescrapersdirectory.Loaded scrapers can be viewed in the Settings > Metadata Providers page. After scrapers are added, removed or edited while Stash is running, they can be reloaded by clicking Reload scrapers button.
CommunityScrapers repository is the source for community maintained scrapers.
"},{"location":"metadata-sources/scrapers/#scraper-types","title":"Scraper types","text":""},{"location":"metadata-sources/scrapers/#by-searching-type","title":"By searching type","text":""},{"location":"metadata-sources/scrapers/#fragment","title":"Fragment","text":"This kind of scrapers will fetch the metadata from a website, by using existing data from Stash, like a scene's file name, performer's name...etc. Fragment scrapers will get all the data Stash knows about that scene/performer/gallery, so it's quite flexible when fetching information.
"},{"location":"metadata-sources/scrapers/#search-by-name","title":"Search by name","text":"A Search-By-Name scraper will get only \"name\" input from a scene or performer, then it will search a website with that name, and return a list of results.
Scrapers includes: Babepedia.yml, FreeonesCommunity.yml, IAFD.yml
"},{"location":"metadata-sources/scrapers/#search-by-url","title":"Search by URL","text":"Most scrapers fetch metadata from a given URL, either by using XPath, JSON, or scripts. For this kind of scrapers you need to know the URL for that scene/performer/gallery/group so they can extract information from it.
Scrapers includes: All other scrapers.
"},{"location":"metadata-sources/scrapers/#by-implementation","title":"By implementation","text":""},{"location":"metadata-sources/scrapers/#xpath-and-json-scrapers","title":"XPath and JSON scrapers","text":"This is the most common type of scrapers, which use either XPath parser to pin-point the information and retrieve them, or send out JSON requests to get the information. xpathScraper and jsonScraper can be mixed in the same .yml file.
"},{"location":"metadata-sources/scrapers/#cdp-scrapers","title":"CDP scrapers","text":"This type of scrapers is mostly the same as XPath/JSON scrapers, except it will launch a headless Chrome browser to retrieve the information from websites. It can also get cookies, simulate a mouse click and other actions. These scrapers have
"},{"location":"metadata-sources/scrapers/#python-ruby-scrapers","title":"Python / Ruby scrapers","text":"useCDP: truesetting in them.This type of scrapers will launch Python, Ruby to retrieve information from websites. Script scrapers are powerful, versatile and cross-platform. So they usually can do much more than regular scrapers. To install this kind of scrapers, you need to copy not only the .yml file, but also all the script files like .py, .rb that associated with it.
"},{"location":"metadata-sources/scrapers/#more-details","title":"More details","text":"You can view the detailed information about scrapers here or CommunityScrapers README.
"},{"location":"metadata-sources/scrapers/#create-your-own","title":"Create your own","text":"To create your own scraper, there is detailed information about that as well. Best way to start is to read the simple ones and understand how xpath works. The XPath Cheetsheet is quite useful in creating a .yml file. In Firefox you can use xpath search in \"Web Developer Tools (F12)\". The \"search HTML\" bar actually accepts xpath searches. You can use it to verify your xpath queries.
"},{"location":"metadata-sources/scrapers/#contribution","title":"Contribution","text":"The Scraper community always welcome new members. If you create a nice scraper and find it stable and useful, you can share it via the GitHub repository. Create a pull request, and let the mod review your work. The mods are busy, so it will probably take a few days, or a couple of weeks, but it will be a great feeling once your contribution is accepted by the community.
"},{"location":"metadata-sources/stash-box-instances/","title":"stash-box instances","text":""},{"location":"metadata-sources/stash-box-instances/#fansdb","title":"FansDB","text":"FansDB is a community-driven metadata database focused on adult content platforms (OnlyFans, Fansly, ManyVids, etc.) where the independent creators are the primary focus.
Website | Guidelines | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#javstash","title":"JAVStash","text":"https://fansdb.cc/graphql| JoinJAVStash is a metadata database focused on Japanese Adult Video (JAV) content and their original metadata in Japanese. Primarily driven by automated scrapers.
Website | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#pmv-stash","title":"PMV Stash","text":"https://javstash.org/graphql| Join1PMV Stash is a community-driven metadata database focused on remixed pornographic art such as Porn Music Videos (PMV), Cock Hero (CH), Hypno Vids, Compilations.
Website | Guidelines | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#stashdb","title":"StashDB","text":"https://pmvstash.org/graphql| JoinStashDB is a community-driven metadata database focused on digital scenes of all orientations.
Website | Guidelines | Community forum | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#theporndb","title":"ThePornDB2","text":"https://stashdb.org/graphql| JoinThePornDB is a metadata database focused on digital scenes and movies. Driven by automated scrapers.
Website | Discord | Endpoint
https://theporndb.net/graphql3 | Join4-
Link leads to a private Discord server. If you are getting that the link is invalid, make sure to join the private Discord server first!\u00a0\u21a9
-
Uses proprietary implemetation of stash-box API.\u00a0\u21a9
-
Has a different endpoint for movies and JAV. For movies use
https://theporndb.net/graphql?type=Movie, for JAV usehttps://theporndb.net/graphql?type=JAV.\u00a0\u21a9 -
Requires registration to access the site.\u00a0\u21a9
Stash data is considered private, and Stash is not designed to be publicly exposed, except to trusted confidants. Stash has a built-in protection against accidentally exposing itself publicly outside of your network. If Stash receives a request from the public internet, and you do not have a password enabled, Stash will reject the request and stop handling requests to protect your privacy.
This often happens when you use the port-forwarding feature of your router or install Stash on a publicly accessible server, such as a VPS. When you do this, anybody in the world can access your Stash instance, so we enforce a password requirement. If your Stash instance has shutdown due to an insecure configuration, it will not handle requests again until you tell it that you have fixed the problem. After setting up either authentication, firewall, or removing your port forwarding rules, you can edit
"},{"location":"networking/authentication-required-when-accessing-stash-from-the-internet/#alternative-and-safe-methods-to-access-your-stash","title":"Alternative and safe methods to access your Stash","text":".stash/config/config.ymland remove the keysecurity_tripwire_accessed_from_public_internet.You may use several methods to safely access Stash from outside of your home network. In the most basic, you can enable authentication in Stash, and re-enable port forwarding. You can also use a VPN solution that allows you to securely access your home network, such as Tailscale, Zerotier, Wireguard, or others.
"},{"location":"networking/authentication-required-when-accessing-stash-from-the-internet/#using-an-external-authentication-provider","title":"Using an external authentication provider","text":"If you are an advanced user, and have secured your Stash instance behind an authwall provided by a reverse proxy or hosting solution, you may continue to use that. You simply have to edit
"},{"location":"plugins/","title":"Plugins","text":".stash/config/config.ymland setdangerous_allow_public_without_authtotrue. If you have already tripped the security feature, you will also have to remove thesecurity_tripwire_accessed_from_public_internetkey in order to allow Stash to serve requests.Info
Plugins are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Plugins adds further features that Stash doesn't itself provide.
"},{"location":"plugins/#managing-plugins","title":"Managing plugins","text":"Plugins can be installed and managed from the Settings > Plugins page.
Plugins are installed using the Available Plugins section. The Community (stable) source is configured by default.
Installed plugins can be updated or uninstalled from the Installed Plugins section.
"},{"location":"plugins/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for plugins. To add a new source go to Settings > Plugins page and under Available Plugins click Add Source.
"},{"location":"plugins/#installing-plugins-manually","title":"Installing plugins manually","text":"By default, Stash looks for plugin configurations in the plugins sub-directory of the directory where the stash
config.ymlis read. This will either be the%USERPROFILE%\\.stash\\pluginson Windows or/root/.stash/pluginson Unix systems (Mac, Linux, etc.) or the current working directory.Plugins are added by adding configuration yaml files (format:
pluginName.yml) to thepluginsdirectory.Loaded plugins can be viewed in the Settings > Plugins page. After plugins are added, removed or edited while Stash is running, they can be reloaded by clicking Reload plugins button.
"},{"location":"plugins/list/","title":"Browse plugins","text":""},{"location":"plugins/list/#browse-plugins","title":"Browse plugins","text":""},{"location":"plugins/list/#sources","title":"Sources","text":"- https://7djx1qp.github.io/stash-plugins/main/index.yml
- https://blackstar3000.github.io/stash-plugins-blackstar/main/index.yml
- https://carrotwaxr.github.io/stash-plugins/stable/index.yml
- https://ceequester.github.io/CommunityScripts/stable/index.yml
- https://coderdudeo.github.io/CoderDudeo-Stash-Plugins/index.yml
- https://f4bio.github.io/stash-plugins/main/index.yml
- https://feederbox826.github.io/plugins/main/index.yml
- https://feederbox826.github.io/stashlist/main/index.yml
- https://jsmthy.github.io/stash-plugins/main/index.yml
- https://lurking987.github.io/stash-plugins/main/index.yml
- https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml
- https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml
- https://rosa-umineko.github.io/CommunityScripts/stable/index.yml
- https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml
- https://serechops.github.io/Serechops-Stash/index.yml
- https://sneakyninja256.github.io/stash-plugins/stable/index.yml
- https://spaceyuck.github.io/stash-plugins/index.yml
- https://stash-of-awesomeness.github.io/stash-plugins/main/index.yml
- https://stashapp.github.io/CommunityScripts/stable/index.yml
- https://stg-annon.github.io/StashScripts/stable/index.yml
- https://tetrax-10.github.io/stash-stuffs/index.yml
- https://valkyr-js.github.io/stash-plugins/index.yml
- https://voidimproper.github.io/stash-plugins/main/index.yml
- https://w0lfiew0lf.github.io/StashApp-Tools/index.yml
- https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml
- https://xiosensei.github.io/Xio-Stash/index.yml
Auto add images to tags using first found image from Google API. Requires modifying the .py file to provide your own API key and CSE ID
https://rosa-umineko.github.io/CommunityScripts/stable/index.yml\nNo README available
rosa-umineko
"},{"location":"plugins/list/#add-secondary-performer-image","title":"Add secondary performer image","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds support for a secondary perfomrer image on the perform details page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#addtional-files-deleter","title":"Addtional Files Deleter","text":"DescriptionSource URLREADMEAuthorScreenshotsDeletes addtional files assosiated with an image or scene object. Which will usually have identical PHashes for scenes or Checksum for images. Unless is a scene manually merged. Apply ignore tag to scene/image object for plugin to bypass.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#adulttime-interactive-downloader","title":"Adulttime Interactive Downloader","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload Interactive Files for Adulttime Scenes
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
tooliload
"},{"location":"plugins/list/#ai-tagger","title":"AI Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsTag videos and Images with Locally hosted AI using Skier's Free and Patreon AI models
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
skier233
"},{"location":"plugins/list/#audio-transcodes","title":"audio-transcodes","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerate a transcode video from an audio file
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#audioplayer","title":"AudioPlayer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd an audio-only toggle button and support for audio files in the Stash player through hls transcoder.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#audioplayerlite","title":"AudioPlayerLite","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin identifies files with no video codec and plays them as audio.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#audiotab","title":"audioTab","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an audio tab to the menu bar
https://sneakyninja256.github.io/stash-plugins/stable/index.yml\nView README
sneakyninja256
"},{"location":"plugins/list/#auto-select-updatable-plugins-and-scrapers","title":"Auto Select Updatable Plugins and Scrapers","text":"DescriptionSource URLREADMEAuthorScreenshotsAuto selects updatable Plugins and Scrapers when Check for Updates is clicked
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#auto-update-plugins-and-scrapers","title":"Auto Update Plugins and Scrapers","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically updates Plugins and Scrappers on website Startup
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#autovr","title":"autovr","text":"DescriptionSource URLREADMEAuthorScreenshotsautomatically toggle VR mode
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#average-rating","title":"Average Rating","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds average rating to performers and studios
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#babepedia-gallery-scraper","title":"BabePedia Gallery Scraper","text":"DescriptionSource URLREADMEAuthorScreenshotsScans your Performer Gallery for any BabePedia URLs and scrapes the related galleries for that performer.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#backup-plugins","title":"Backup Plugins","text":"DescriptionSource URLREADMEAuthorScreenshotsCreates a backup of the 'plugins' directory.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#bulk-image-scrape","title":"Bulk Image Scrape","text":"DescriptionSource URLREADMEAuthorScreenshotsApply an image scraper to all images
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
NotMyMainUser
"},{"location":"plugins/list/#bulk-import-performers","title":"Bulk Import Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsBulk Import Performers based on names from a text file.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#categorize-tags-based-on-parent","title":"Categorize Tags Based On Parent","text":"DescriptionSource URLREADMEAuthorScreenshotscolors the tag background image based on the heighest parent and sorts tag with the same heighest parent together
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#choose-your-own-adventure-player-backer","title":"Choose Your Own Adventure Player (Backer)","text":"DescriptionSource URLREADMEAuthorScreenshotsPlugin to adapt Choose Your Own Adventure Games to the VideoJS player.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
cj12312021
"},{"location":"plugins/list/#cjs-card-tweaks","title":"CJ's Card Tweaks.","text":"DescriptionSource URLREADMEAuthorScreenshotsProvides various tweaks for the Stash Cards.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
cj12312021
"},{"location":"plugins/list/#cleanupui","title":"CleanupUI","text":"DescriptionSource URLREADMEAuthorScreenshotsUI plugin to hide features you don't want
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#colorcodedtags","title":"ColorCodedTags","text":"DescriptionSource URLREADMEAuthorScreenshotsChanges the colors of tag labels based on naming convention.
https://coderdudeo.github.io/CoderDudeo-Stash-Plugins/index.yml\nView README
coderdudeo
"},{"location":"plugins/list/#comic-info-extractor","title":"Comic Info Extractor","text":"DescriptionSource URLREADMEAuthorScreenshotsExtract the metadata from cbz with the Comicrack standard (ComicInfo.xml)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
yoshnopa
"},{"location":"plugins/list/#communityscriptsuilibrary","title":"CommunityScriptsUILibrary","text":"DescriptionSource URLREADMEAuthorScreenshotsCommunityScripts UI helper library
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
No Author
"},{"location":"plugins/list/#completethestash","title":"CompleteTheStash","text":"DescriptionSource URLREADMEAuthorScreenshotsFinds missing scenes for selected performers and creates missing scene metadata to another missing Stash instance. You can use either StashDB or TPDB or both as a source for missing scenes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#cuptag","title":"cuptag","text":"DescriptionSource URLREADMEAuthorScreenshotsTag performers with cup sizes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#default-data-for-path","title":"Default Data For Path","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds configured Tags, Performers and/or Studio to all newly scanned Scenes, Images and Galleries.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
TheSinfulKing
"},{"location":"plugins/list/#discord-presence","title":"Discord Presence","text":"DescriptionSource URLREADMEAuthorScreenshotsSets currently playing scene data as your Discord status. See README for prerequisites and config options (blue hyperlink next to enable/disable button)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
NotForMyCV
"},{"location":"plugins/list/#display-tag-image-with-tag","title":"Display Tag Image With Tag","text":"DescriptionSource URLREADMEAuthorScreenshotsany page in stash that has clickable tag, instead of showing the tag name only, show the image of the tag above it.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#dupe-marker-detector","title":"Dupe Marker Detector","text":"DescriptionSource URLREADMEAuthorScreenshotsFinds and marks duplicate markers
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
feederbox826
"},{"location":"plugins/list/#dupfilemanager","title":"DupFileManager","text":"DescriptionSource URLREADMEAuthorScreenshotsManages duplicate files.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#duplicate-scene-marker-cleaner","title":"Duplicate Scene Marker Cleaner","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically detects and removes duplicate scene markers based on scene ID, seconds, and title upon scene updates or via manual trigger.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#e621_tagger","title":"e621_tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsFinding images and videos on e621 and tagging them.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#easytag","title":"EasyTag","text":"DescriptionSource URLREADMEAuthorScreenshotsUI plugin to add shortcuts for commonly used tags
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#edit-unorganized","title":"edit-unorganized","text":"DescriptionSource URLREADMEAuthorScreenshotsDefault to edit tab on unorganized scenes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#embedded-scene-player","title":"Embedded Scene Player","text":"DescriptionSource URLREADMEAuthorScreenshotsDetects embed URLs for file-less scenes and shows them in the scene player.
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#extended-stats","title":"Extended Stats","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds new stats to the stats page
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#external-links-enhanced","title":"External Links Enhanced","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds additional icons for external links.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
QxxxGit
"},{"location":"plugins/list/#extra-performer-info","title":"Extra Performer Info","text":"DescriptionSource URLREADMEAuthorScreenshotsadd award info from wikidata
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#fast-tagger","title":"Fast Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsFast tagging without searching for tags
https://spaceyuck.github.io/stash-plugins/index.yml\nView README
No Author
"},{"location":"plugins/list/#filemonitor","title":"FileMonitor","text":"DescriptionSource URLREADMEAuthorScreenshotsMonitors the Stash library folders, and updates Stash if any changes occurs in the Stash library paths.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#filename-parser","title":"Filename parser","text":"DescriptionSource URLREADMEAuthorScreenshotsParses filename into studio, date, performers and title
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
gitgiggety
"},{"location":"plugins/list/#filepath-copy","title":"filepath-copy","text":"DescriptionSource URLREADMEAuthorScreenshotsCopy file path to clipboard when selected
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#find-file-errors","title":"Find File Errors","text":"DescriptionSource URLREADMEAuthorScreenshotsfind files that stash has previously errored on from the log file
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#find-marker-for-tag-images","title":"Find Marker For Tag Images","text":"DescriptionSource URLREADMEAuthorScreenshotsScript to update tag images based on a randomly matched scene marker.
https://lurking987.github.io/stash-plugins/main/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#find-marker-tag-images","title":"Find Marker Tag Images","text":"DescriptionSource URLREADMEAuthorScreenshotsScript to update tag images based on scene markers
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#fix-the-stash","title":"Fix The Stash","text":"DescriptionSource URLREADMEAuthorScreenshotsProvides easy data fixes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#foldersort","title":"folderSort","text":"DescriptionSource URLREADMEAuthorScreenshotsOrganise your PMV folder(s) based on Stash info
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#fontawesome-js","title":"fontawesome-js","text":"DescriptionSource URLREADMEAuthorScreenshotsUse fontawesome icons from React libraries
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#funscript-markers","title":"Funscript Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate markers if there is a funscript with \"chapters\" included in the metadata of the script
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#gallery-date-parser","title":"Gallery Date Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsFind date in path or filename and add it to the gallery
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
HijackHornet
"},{"location":"plugins/list/#gallery-linker","title":"Gallery Linker","text":"DescriptionSource URLREADMEAuthorScreenshotsLinks image galleries to related scenes and performers based on file patterns, dates, and metadata.
https://voidimproper.github.io/stash-plugins/main/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#glassy-branding","title":"Glassy - Branding","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#hashthestash","title":"HashTheStash","text":"DescriptionSource URLREADMEAuthorScreenshotsCalculates additional fingerprints for scenes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#hot-cards","title":"Hot Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds custom styling to card elements that match a Tag ID or a Rating Threshold.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
HandyRandyx
"},{"location":"plugins/list/#hover-cards","title":"Hover Cards","text":"DescriptionSource URLREADMEAuthorScreenshotshttps://valkyr-js.github.io/stash-plugins/index.yml\nNo README available
Valkyr-JS
"},{"location":"plugins/list/#image-date-from-metadata","title":"Image Date From Metadata","text":"DescriptionSource URLREADMEAuthorScreenshotsFind date in image or clip metadata
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#image2scene","title":"image2Scene","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd a mechanism to link images to scenes in the Image Edit Panel.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#imagegallerynavigation","title":"imageGalleryNavigation","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin adds features for navigating between images within a Gallery from the Image details page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#lightbox-visual-novel","title":"Lightbox Visual Novel","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay the image description with Typewriter effect on the footer.
https://w0lfiew0lf.github.io/StashApp-Tools/index.yml\nNo README available
W0lfieW0lf
"},{"location":"plugins/list/#local-visage","title":"Local Visage","text":"DescriptionSource URLREADMEAuthorScreenshotsLocal Performer Recognition plugin using DeepFace
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#log-console","title":"log-console","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay log messages in the web browser console
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#log-toast","title":"log-toast","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay log messages as toasts
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#marker-delete-button","title":"Marker Delete Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a delete button to entries on the Markers page and on the Scene page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WeedLordVegeta420
"},{"location":"plugins/list/#markergen","title":"markergen","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerate markers on save
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#mcmetadata","title":"mcMetadata","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerates metadata for use with other media servers like Emby and Jellyfin, and optionally organizes/renames your tagged scenes.
https://carrotwaxr.github.io/stash-plugins/stable/index.yml\nNo README available
carrotwaxr
"},{"location":"plugins/list/#misc-tags","title":"Misc Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd extra tags for VR and other ues
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#movie-duration-from-scenes","title":"Movie Duration from Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsMore accurately reflect your movie's duration with the sum of durations of its scenes.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#movie-fy","title":"Movie-Fy","text":"DescriptionSource URLREADMEAuthorScreenshotsMovie-Fy meta-package
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-bulk-movie-scraper","title":"Movie-Fy Bulk Movie Scraper","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdate your movie metadata in bulk.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-check-and-update-scene-titles","title":"Movie-Fy Check and Update Scene Titles","text":"DescriptionSource URLREADMEAuthorScreenshotsCheck and update titles for scenes in the Movie studio
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-create-movie-studio","title":"Movie-Fy Create Movie Studio","text":"DescriptionSource URLREADMEAuthorScreenshotsCreates a new Movie Studio to be used with Mass_Movie_Create
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-scene-studio-bulk-update","title":"Movie-Fy Scene Studio Bulk Update","text":"DescriptionSource URLREADMEAuthorScreenshotsBulk update scene studios based on movie studios.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-update-movie-scene-covers","title":"Movie-Fy Update Movie Scene Covers","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdate scene cover images with movie cover images.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#nfosceneparser","title":"nfoSceneParser","text":"DescriptionSource URLREADMEAuthorScreenshotsFills scene data from NFO or filename pattern
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Gykes
"},{"location":"plugins/list/#organizer-on-update","title":"Organizer On Update","text":"DescriptionSource URLREADMEAuthorScreenshotsOrganize your tags based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#overlay-info","title":"overlay-info","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds more information to scene card overlay
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#path-parser","title":"Path Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdates scene info based on the file path.
https://ceequester.github.io/CommunityScripts/stable/index.yml\nNo README available
Ceequester
"},{"location":"plugins/list/#path-parser_1","title":"Path Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdates scene info based on the file path.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
ImJustMatt
"},{"location":"plugins/list/#performer-body-calculator","title":"Performer Body Calculator","text":"DescriptionSource URLREADMEAuthorScreenshotsTags performers based on existing metadata, with tags matching the performers body type
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#performer-details-extended","title":"Performer Details Extended","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays additional metadata on performer pages, such as their most regular scene partners, top studio, and total play duration. Requires Stash v0.27.0 or higher.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#performer-gallery-scraper-plugin","title":"Performer Gallery Scraper Plugin","text":"DescriptionSource URLREADMEAuthorScreenshotsA plugin to scrape galleries from porngals4.com for specific performers and create zip archives.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#performer-scene-compare","title":"Performer Scene Compare","text":"DescriptionSource URLREADMEAuthorScreenshotsCompares local performer scenes with StashDB and updates the local database.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#performer-stashbox-url-to-id","title":"Performer Stashbox Url to ID","text":"DescriptionSource URLREADMEAuthorScreenshotsIf the performer has a url for another stashbox add it as an id to the performer
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#performer-age","title":"performer-age","text":"DescriptionSource URLREADMEAuthorScreenshotsTag performers with age tags
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#phash-duplicate-tagger","title":"PHash Duplicate Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsPHash Duplicate Tagger (PDT) Will tag scenes based on duplicate PHashes for easier/safer removal.
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#play-video-if-preview-not-found","title":"Play Video If Preview Not Found","text":"DescriptionSource URLREADMEAuthorScreenshotsPlays video on scene card hover if preview is not found
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#plex-sync","title":"Plex Sync","text":"DescriptionSource URLREADMEAuthorScreenshotsRefresh Plex metadata when scene updated in Stash. Requires the StashPlexAgent.bundle agent.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#public-ip","title":"Public IP","text":"DescriptionSource URLREADMEAuthorScreenshotsQuery ident.me to check my current IP (ensure VPN is working)
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#python-tools-installer","title":"Python Tools Installer","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload stashapp-tools for DockerEnv
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
tooliload
"},{"location":"plugins/list/#pythondepmanager","title":"PythonDepManager","text":"DescriptionSource URLREADMEAuthorScreenshotsManage Python dependencies for CommunityScripts
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#quick-sentiment","title":"Quick Sentiment","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds favourite and watch later overlays to scene cards
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#quickrating","title":"QuickRating","text":"DescriptionSource URLREADMEAuthorScreenshotsMore rating UI options (only enable one)
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#randombutton","title":"RandomButton","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to quickly jump to a random scene, image, performer, studio, group, tag, or gallery, both on overview and internal entity pages.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#randomize-performer-images","title":"Randomize Performer Images","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay random images of performer when visiting a performer page. check README.md for set up.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#randomize-performer-images-using-gallery","title":"Randomize Performer Images Using Gallery","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay random images of performer when visiting a performer page. check README.md for set up.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#rebrand","title":"Rebrand","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a name override of your choice in Stash
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#remove-redundant-parent-tags-from-tagged-objects","title":"Remove redundant parent tags from tagged objects","text":"DescriptionSource URLREADMEAuthorScreenshotsremoves parent tags from objects if a more specific child tag is also present
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#rename-file-on-update","title":"Rename File on Update","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames files when they are updated in Stash.
https://stash-of-awesomeness.github.io/stash-plugins/main/index.yml\nNo README available
stash-of-awesomeness
"},{"location":"plugins/list/#renamefile","title":"RenameFile","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#renamer","title":"Renamer","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames scene files based on scene details and updates associated scenes with a \"Renamed\" tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#renamer-dev","title":"Renamer-Dev","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames scene files based on scene details and updates associated scenes with a \"Renamed\" tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#renameronupdate","title":"renamerOnUpdate","text":"DescriptionSource URLREADMEAuthorScreenshotsRename/move filename based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#renameronupdatedevelop","title":"renamerOnUpdateDevelop","text":"DescriptionSource URLREADMEAuthorScreenshotsRename/move filename based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#replace-thumbnails-with-high-res-images","title":"Replace Thumbnails With High-Res Images","text":"DescriptionSource URLREADMEAuthorScreenshotsReplaces thumbnails with original high res images
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#scene-cover-cropper","title":"Scene Cover Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsCrop Scene Cover Images
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#scene-marker-tags-to-scene","title":"Scene Marker Tags to Scene","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds primary tag of Scene Marker to the Scene on marker create/update.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WithoutPants
"},{"location":"plugins/list/#scene-page-remember-states","title":"Scene Page Remember States","text":"DescriptionSource URLREADMEAuthorScreenshotsUses local storage to remember the state of the scene page detail panel nav bar and activate it on page load. Remembers collapse state of the divider.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#scenehub","title":"SceneHub","text":"DescriptionSource URLREADMEAuthorScreenshotsCollects the latest scenes from popular network sites and displays them all in one page.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#serechopsscenecard","title":"SerechopsSceneCard","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom scene card via the Plugin API.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#set-performers-from-tags","title":"Set Performers From Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically sets performers in scenes and images based on tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
Torrafox
"},{"location":"plugins/list/#set-scene-cover","title":"Set Scene Cover","text":"DescriptionSource URLREADMEAuthorScreenshotssearches Stash for Scenes with a cover image in the same folder and sets the cover image in stash to that image
https://rosa-umineko.github.io/CommunityScripts/stable/index.yml\nNo README available
rosa-umineko
"},{"location":"plugins/list/#set-scene-cover_1","title":"Set Scene Cover","text":"DescriptionSource URLREADMEAuthorScreenshotssearches Stash for Scenes with a cover image in the same folder and sets the cover image in stash to that image
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#shelve","title":"shelve","text":"DescriptionSource URLREADMEAuthorScreenshots[EXPERIMENTAL - use at own risk] Moves files based on object metadata
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#shelve-ui","title":"shelve-ui","text":"DescriptionSource URLREADMEAuthorScreenshotsUI for renaming files in bulk based on metadata.
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#skip-intro","title":"skip-intro","text":"DescriptionSource URLREADMEAuthorScreenshotsSkips static duration intros
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#star-identifier","title":"Star Identifier","text":"DescriptionSource URLREADMEAuthorScreenshotsUse facial recognition to automatically identify who is in images or scene screenshots from the performers already in your Stash library.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#stash-accessibility","title":"Stash Accessibility","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an Accessibility button in the top right navbar that offers various accessibility features.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ai","title":"Stash AI","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd Tags or Markers to a video using AI
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
cc1234475
"},{"location":"plugins/list/#stash-batch-create-all","title":"Stash Batch Create All","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a 'Create All' button to the scene tagger view. It will target all 'Create' buttons and add new tags as well.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-batch-query-edit","title":"Stash Batch Query Edit","text":"DescriptionSource URLREADMEAuthorScreenshotsBatch modify scene tagger search query
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-result-toggle","title":"Stash Batch Result Toggle","text":"DescriptionSource URLREADMEAuthorScreenshotsIn Scene Tagger, adds button to toggle all stashdb scene match result fields. Saves clicks when you only want to save a few metadata fields. Instead of turning off every field, you batch toggle them off, then toggle on the ones you want
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-save","title":"Stash Batch Save","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a batch save button to scenes tagger
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-search","title":"Stash Batch Search","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a batch search button to scenes and performers tagger
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-disable-all","title":"Stash Disable All","text":"DescriptionSource URLREADMEAuthorScreenshotsDisables all UI configs and plugins. Saves the current config to a JSON file so that it can be restored to original state.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stash-download-scenes","title":"Stash Download Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAn easy method to directly download the stream of any Stash scene.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-dynamic-groups","title":"Stash Dynamic Groups","text":"DescriptionSource URLREADMEAuthorScreenshotsDesignate dynamic groups that can be populated simply by assigning a tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-enable-all","title":"Stash Enable All","text":"DescriptionSource URLREADMEAuthorScreenshotsRestores the UI to its original state via a saved JSON config.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stash-fps-overlay","title":"Stash FPS Overlay","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an FPS overlay on the scene cards.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ingest","title":"Stash Ingest","text":"DescriptionSource URLREADMEAuthorScreenshotsMoves identified scenes from the \".StashIngest\" folder to the root \"Scenes\" folder.
https://jsmthy.github.io/stash-plugins/main/index.yml\nView README
jsmthy
"},{"location":"plugins/list/#stash-jellyfin-exporter","title":"Stash Jellyfin Exporter","text":"DescriptionSource URLREADMEAuthorScreenshotsRestructures your Stash library to be Jellyfin compliant to better serve and populate metadata within your Jellyfin server.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-markdown","title":"Stash Markdown","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds markdown parsing to tag description fields
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-markers-autoscroll","title":"Stash Markers Autoscroll","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically scrolls markers page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-matched-performer-scrape","title":"Stash Matched Performer Scrape","text":"DescriptionSource URLREADMEAuthorScreenshotsScrapes performers in bulk from ThePornDB and StashDB on exact name matches only.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-mergers","title":"Stash Mergers","text":"DescriptionSource URLREADMEAuthorScreenshotsA plugin for selectively merging data between performers in Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#stash-new-performer-filter-button","title":"Stash New Performer Filter Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a customizable button to the performers page. Links to a new performers filter by default.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-new-scenes-filter-button","title":"Stash New Scenes Filter Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a filter button to the scenes page in Stash.
https://blackstar3000.github.io/stash-plugins-blackstar/main/index.yml\nNo README available
blackstar3000
"},{"location":"plugins/list/#stash-notes","title":"Stash Notes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to the navigation bar which opens a small window for writing notes to your browser's local storage.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
QxxxGit
"},{"location":"plugins/list/#stash-open-media-player","title":"Stash Open Media Player","text":"DescriptionSource URLREADMEAuthorScreenshotsOpen scene filepath links in an external media player
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-audit-task-button","title":"Stash Performer Audit Task Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to the performers page to run the audit plugin task
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-custom-fields","title":"Stash Performer Custom Fields","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds custom fields to performers that are stored in performer details as JSON.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-favicons","title":"Stash Performer Favicons","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds the performer URL favicons as a new line item in the performer details.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-performer-image-cropper","title":"Stash Performer Image Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an image cropper to performer page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-image-extractor","title":"Stash Performer Image Extractor","text":"DescriptionSource URLREADMEAuthorScreenshotsExtracts all performers from your localdb to a local directory for easy editing.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-performer-markers-tab","title":"Stash Performer Markers Tab","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a Markers link to performer pages
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-tagger-additions","title":"Stash Performer Tagger Additions","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds performer birthdate and url to tagger view. Makes clicking performer name open stash profile in new tab instead of current tab.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-url-searchbox","title":"Stash Performer URL Searchbox","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a search by performer url textbox to the performers page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-reels","title":"Stash Reels","text":"DescriptionSource URLREADMEAuthorScreenshotsTikTok for Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#stash-right-click-galleries","title":"Stash Right Click Galleries","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the gallery cards to perform various quick tasks related to galleries.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-images","title":"Stash Right Click Images","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the image cards to perform various quick tasks related to images.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-performer-merge","title":"Stash Right Click Performer Merge","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the to perform various quick tasks related to settings.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-performers","title":"Stash Right Click Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the performer cards to perform various quick tasks related to performers.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-scenes","title":"Stash Right Click Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the scene cards to perform various quick tasks related to scenes.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-settings","title":"Stash Right Click Settings","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the settings icon to perform various quick tasks related to settings.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-suite","title":"Stash Right Click Suite","text":"DescriptionSource URLREADMEAuthorScreenshotsMeta-package installer for the Stash Right-Click Suite tools.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-tags","title":"Stash Right Click Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the tag cards to perform various quick tasks related to tags.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-file-size","title":"Stash Scene File Size","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay file size on scene cards.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-specs-overlay","title":"Stash Scene Specs Overlay","text":"DescriptionSource URLREADMEAuthorScreenshotsHides all the scene specs overlay within the scene card and reveals them on hover.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-tagger-additions","title":"Stash Scene Tagger Additions","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds scene duration and filepath to tagger view.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-scene-tagger-colorizer","title":"Stash Scene Tagger Colorizer","text":"DescriptionSource URLREADMEAuthorScreenshotsColorize scene tagger match results to show matching and mismatching scene data.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-scene-tagger-draft-submit","title":"Stash Scene Tagger Draft Submit","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds button to Scene Tagger to submit draft to stashdb
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-set-stashbox-favorite-performers","title":"Stash Set Stashbox Favorite Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsSet Stashbox favorite performers according to stash favorites
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashbox-scene-count","title":"Stash Stashbox Scene Count","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds stashbox scene counts to performers and studios
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashid-icon","title":"Stash StashID Icon","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds checkmark icon to performer and studio cards that have a stashid
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashid-input","title":"Stash StashID Input","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds input for entering new stash id to performer details page and studio page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stats","title":"Stash Stats","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds stats to stats page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-studio-logo-wall-view","title":"Stash Studio Logo Wall View","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds the studio logo on the scene cards in Wall view.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-tag-custom-colors","title":"Stash Tag Custom Colors","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom button in the navbar to stylize tag chips based on CSS snippets, regex patterns, or basic color-coding.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-tag-image-cropper","title":"Stash Tag Image Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an image cropper to tag page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-timestamps","title":"Stash TimeStamps","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate timestamps from pre-existing markers within the scene's details.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-toggle-scene-sprites","title":"Stash Toggle Scene Sprites","text":"DescriptionSource URLREADMEAuthorScreenshotsToggles scene sprites to replace static preview image of all scenes on the current index page.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ui-plugin-example","title":"Stash UI Plugin Example","text":"DescriptionSource URLREADMEAuthorScreenshotsAn attempt to simplify the process of building UI plugins.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-video-player-ab-loop-time-input","title":"Stash Video Player AB Loop Time Input","text":"DescriptionSource URLREADMEAuthorScreenshotsReplaces the video player AB loop start and end buttons with time inputs
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-omnisearch","title":"stash-omnisearch","text":"DescriptionSource URLREADMEAuthorScreenshotssearch all the things on stash
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stash-open","title":"stash-open","text":"DescriptionSource URLREADMEAuthorScreenshotsOpens media files in local media player
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stash-s6-helper","title":"stash-s6 helper","text":"DescriptionSource URLREADMEAuthorScreenshotsstash-s6 helper plugin
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stashannotate","title":"stashAnnotate","text":"DescriptionSource URLREADMEAuthorScreenshotsAllows users to create a custom annotation and highlight field on images similar to popular Booru sites.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashappandroidtv-companion","title":"StashAppAndroidTV Companion","text":"DescriptionSource URLREADMEAuthorScreenshotsA companion plugin for StashAppAndroidTV
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
damontecres
"},{"location":"plugins/list/#stashaudioplayer","title":"StashAudioPlayer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd an audio-only toggle button and support for audio files in the Stash player through hls transcoder.
https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml\nView README
d0t-d0t-d0t
"},{"location":"plugins/list/#stashaudioplayerlite","title":"StashAudioPlayerLite","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin identifies files with no video codec and plays them as audio.
https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#stashdb-performer-gallery","title":"stashdb performer gallery","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically download performer images from stashdb or other stash-boxes. Add the [Stashbox Performer Gallery] tag to a performer and it will create a gallery of images from that stash-box database. Apply the tag [Set Profile Image] to an image to set it as the profile image of that performer. Note you will need to configure the download path and add this as a path under settings > library
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#stashdb-tag-import","title":"StashDB Tag Import","text":"DescriptionSource URLREADMEAuthorScreenshotsImport StashDB's list of Tags for your Stash.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashdb-fullimg","title":"stashdb-fullimg","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload full-size images from StashDB
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stashdisable","title":"stashDisable","text":"DescriptionSource URLREADMEAuthorScreenshotsstashDisable meta-package
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stashlist-sync","title":"stashlist-sync","text":"DescriptionSource URLREADMEAuthorScreenshotsSync stashIDs to stashlist history
https://feederbox826.github.io/stashlist/main/index.yml\nView README
feederbox826
"},{"location":"plugins/list/#stashnewperformerscenes","title":"stashNewPerformerScenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom icon in the performer card should they have a new scene released within the specified date range from the navbar button.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashnotifications","title":"StashNotifications","text":"DescriptionSource URLREADMEAuthorScreenshotsReceive notifications about plugin and scraper changes.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
QxxxGit
"},{"location":"plugins/list/#stashtagperformerimage","title":"stashTagPerformerImage","text":"DescriptionSource URLREADMEAuthorScreenshotsChecks parent directory of image on Image.Update.Post and compares to any existing performers in the db. Updates that image with the related performer.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#studio-background-shadow","title":"Studio background shadow","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd drop shadows to studio icons for visibility
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#studio-top-performer","title":"Studio Top Performer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a Queen icon with the top performer listed in the studio cards as determined by most scenes starred in from that particular studio.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#tag-galleries-from-images","title":"Tag galleries from images","text":"DescriptionSource URLREADMEAuthorScreenshotstags galleries with tags of contained images.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tag-graph","title":"Tag Graph","text":"DescriptionSource URLREADMEAuthorScreenshotsInteractive tag graph with vis.js, to view go to http://localhost:9999/plugin/tagGraph/assets/graph/
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#tag-images-from-performer-tags","title":"Tag Images From Performer Tags","text":"DescriptionSource URLREADMEAuthorScreenshotstags images with performer tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tag-scenes-from-performer-tags","title":"Tag Scenes From Performer Tags","text":"DescriptionSource URLREADMEAuthorScreenshotstags scenes with performer tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Dankonite
"},{"location":"plugins/list/#tag-text-to-emoji","title":"Tag Text to Emoji","text":"DescriptionSource URLREADMEAuthorScreenshotschanges text to emoji if you are using common tags from stashdb
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#tag-color-regex","title":"tag-color-regex","text":"DescriptionSource URLREADMEAuthorScreenshotsColors tags based on regex
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-filter","title":"tag-filter","text":"DescriptionSource URLREADMEAuthorScreenshotsFilter out and hide meta-tags
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-import","title":"tag-import","text":"DescriptionSource URLREADMEAuthorScreenshotsfeederbox opinionated tag import
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-link","title":"tag-link","text":"DescriptionSource URLREADMEAuthorScreenshotslink local tags to stashDB
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-video","title":"tag-video","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd <video> support to tag images
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tagcopypaste","title":"tagCopyPaste","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds Copy/Paste buttons to Tags field.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tagger-img-res","title":"tagger-img-res","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds resolutions to all tagger images
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tetrax-userscript-library","title":"Tetrax Userscript Library","text":"DescriptionSource URLREADMEAuthorScreenshotsUtility library for Tetrax userscripts
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#the-porn-db-markers","title":"The Porn DB Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsSync Markers from The Porn DB aka theporndb.net
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#theme-switch","title":"Theme Switch","text":"DescriptionSource URLREADMEAuthorScreenshotsTheme and CSS script manager located in main menu bar top right.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#thumbnail-previews","title":"Thumbnail Previews","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays preview videos on thumbnail cards.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#timestamp-trade","title":"Timestamp Trade","text":"DescriptionSource URLREADMEAuthorScreenshotsSync Markers with timestamp.trade, a new database for sharing markers.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
Tweeticoats
"},{"location":"plugins/list/#titlefromfilename","title":"titleFromFilename","text":"DescriptionSource URLREADMEAuthorScreenshotsSet a scene's title from it's filename
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
bnkai
"},{"location":"plugins/list/#titleobserver","title":"titleobserver","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an event listener for title changes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#useragent","title":"useragent","text":"DescriptionSource URLREADMEAuthorScreenshotsProgramatically set scraper User-Agent
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#valkyr-scene-cards","title":"Valkyr Scene Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsA customisable rework of the scene card component for Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#video-banner","title":"Video Banner","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays random generated preview videos in the detail page banner.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#video-chapter-markers","title":"Video Chapter Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate markers from chapter information embedded in video files
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
qxzg
"},{"location":"plugins/list/#videoscrollwheel","title":"VideoScrollWheel","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds functionality to change volume/time in scene video player by hovering over left/right side of player and scrolling with mouse scrollwheel. Scroll while hovering on left side to adjust volume, scroll on right side to skip forward/back.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WeedLordVegeta420
"},{"location":"plugins/list/#vjs-mmb-fullscreen","title":"vjs-mmb-fullscreen","text":"DescriptionSource URLREADMEAuthorScreenshotsVideoJS middle mouse button fullscreen
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#vjs-shortcut","title":"vjs-shortcut","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd YouTube keyboard shortcuts to VideoJS
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#vjs-vr-zoom","title":"vjs-vr-zoom","text":"DescriptionSource URLREADMEAuthorScreenshotsVideoJS VR zoom controls
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#watched-video-icon","title":"Watched Video Icon","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds icon and css class to watched videos
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"scripts/","title":"Scripts","text":"Info
Scripts are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Scripts are standalone programs that can interact with Stash either through GraphQL queries, custom Javascript or by directly editing Stash database or external files.
To install a script follow the script's install instructions.
"},{"location":"scripts/list/","title":"Browse scripts","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Script no longer worksIf you found that script is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"scripts/list/#addmarkerono","title":"AddMarkerOnO","text":"DescriptionAuthorScreenshotsWill auto-generate a marker when the SceneAddO event is trigger
rosa-umineko
"},{"location":"scripts/list/#blurrycardbackground","title":"blurryCardBackground","text":"DescriptionAuthorScreenshotsAdd blurry background to scene/movie/gallery/image/studio.
philpw99
"},{"location":"scripts/list/#filenameperformerstocsv","title":"FilenamePerformersToCSV","text":"DescriptionAuthorScreenshotsParse performer names from your media filenames into CSV files for batch import into Stash!
ALonelyJuicebox
"},{"location":"scripts/list/#get-profilepictures","title":"Get-ProfilePictures","text":"DescriptionAuthorScreenshotsGet-ProfilePictures
MinasukiHikimuna
"},{"location":"scripts/list/#kodi-helper","title":"Kodi helper","text":"DescriptionAuthorScreenshotsGenerates nfo and strm for use with Kodi.
WithoutPants
"},{"location":"scripts/list/#ofmetadatatostash","title":"OFMetadataToStash","text":"DescriptionAuthorScreenshotsOnlyFans metadata import tool for Stash, written in Powershell.
- Simple to use with a straightforward command line based UI!
- Script can auto-associate scenes/images with the appropriate OnlyFans performer(s) and studio, in batch!
- Built-in utility for completely scrubbing and sanitizing OnlyFans metadata databases
ALonelyJuicebox
"},{"location":"scripts/list/#plex-to-stash-ratings","title":"plex-to-stash-ratings","text":"DescriptionAuthorScreenshotsTransfer scene rating and view count from Plex to Stash.
oikmeg
"},{"location":"scripts/list/#pwplayerjs-scene-card-quick-player","title":"pwPlayer.js - Scene Card Quick Player","text":"DescriptionAuthorScreenshotsThis Javascript will create a \"Play\" button in each scene card. You can click on it and the video for that scene will be played right away. Click on the video again, then you are back to the scene list.
philpw99
"},{"location":"scripts/list/#sqlite-renamer-for-stash","title":"SQLITE Renamer for Stash","text":"DescriptionAuthorScreenshotsUsing metadata from your database (SQLITE) to rename your file.
Belleyy
"},{"location":"scripts/list/#stash-watcher","title":"Stash Watcher","text":"DescriptionAuthorScreenshotsStash Watcher is a service that watches your Stash library directories for changes and then triggers a Metadata Scan when new files are added to those directories. It then waits a period of time before triggering another scan to keep Stash from constantly scanning if you're making many changes. Note that updates are watched during that window; the update is merely delayed.
DuctTape42
"},{"location":"scripts/list/#stashapp-tag-importer","title":"stashapp-tag-importer","text":"DescriptionAuthorScreenshotsCreates tags and aliases, resolves tag conflicts, and updates tag titles and descriptions from Stashbox (StashDB) to your local Stash instance. It can be run periodically to perform a one way sync to keep your Stash instance up to date with Stashbox (StashDB).
soundchaser128
"},{"location":"scripts/list/#stashgalleryupdate","title":"StashGalleryUpdate","text":"DescriptionAuthorScreenshotsDumb little script to match and update Stash galleries from scenes
Darklyter
"},{"location":"scripts/list/#stashstudiosync","title":"StashStudioSync","text":"DescriptionAuthorScreenshotsAn easy way to query a stashbox GQL endpoint and import any unknown studio IDs.
Stash-KennyG
"},{"location":"scripts/list/#stashtagskins","title":"StashTagSkins","text":"DescriptionAuthorScreenshotsUsed to quickly apply and change themes of tags for Stash.
Stash-KennyG
"},{"location":"scripts/list/#stashvideohashernode","title":"StashVideohasherNode","text":"DescriptionAuthorScreenshotsThis is a very simple script that can be run on multiple systems to process a large Stash import of scenes. Instead of running cover and phash generation tasks on the Stash server itself, this script will allow you to do the same thing on as many computers as you would like, with all of the nodes contributing back to the Stash server.
Darklyter
"},{"location":"themes/","title":"Themes","text":"Info
Themes are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Stash supports CSS themes to adjust the look-and-feel of the interface. There are several that have been created by the maintainers and users.
Themes can be installed either via plugin or as Custom CSS.
"},{"location":"themes/#installing-via-plugin","title":"Installing via plugin","text":"Plugins can be installed and managed from the Settings > Plugins page.
Plugins are installed using the Available Plugins section. The Community (stable) source is configured by default that has several themes.
Installed plugins can be updated or uninstalled from the Installed Plugins section.
"},{"location":"themes/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for plugins. To add a new source go to Settings > Plugins page and under Available Plugins click Add Source.
"},{"location":"themes/#installing-via-custom-css","title":"Installing via Custom CSS","text":"- Find a theme from the list and copy the content of .css file.
- In Stash, go to Settings > Interface and scroll down to Custom CSS heading.
- Make sure Custom CSS enabled is checked.
- Click on Edit under Custom CSS and then paste the CSS code into the text box.
- You will need to force-reload Shift+F5 in order to see the theme.
Custom CSS allows you to modify Stash stock stylesheets.
The following is a list of some useful CSS snippets. You may use them by copying-and-pasting them into the Custom CSS editor found in the Settings > Interface panel or by navigating to
localhost:9999/settings?tab=interfaceWarning
- Future releases of Stash may break these CSS tweaks.
- CSS tweaks may not appear without flushing the Stash browser cache first on Chrome.
Reduce left and right padding on Scene and Performer grid pages allowing for more thumbnails on each row.
"},{"location":"themes/custom-css-snippets/#allow-for-longer-string-when-displaying-studio-as-text-on-scene-thumbnails","title":"Allow for longer string when displaying \"Studio as Text\" on scene thumbnails","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Fit more thumbnails on each row */\n\n.grid { padding: 0px !important; }\nAllow for longer string when displaying \"Studio as Text\" on scene thumbnails.
"},{"location":"themes/custom-css-snippets/#hide-scene-specs-resolution-duration-from-scene-card","title":"Hide scene specs (resolution, duration) from scene card","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Allow for longer string when displaying \"Studio as Text\" on scene thumbnails */\n\n.scene-studio-overlay {\n font-weight: 600 !important;\n opacity: 1 !important;\n width: 60% !important;\n text-overflow: ellipsis !important;\n}\nHide scene specs (resolution, duration) from scene card.
"},{"location":"themes/custom-css-snippets/#hide-studio-logotext-from-scene-card","title":"Hide studio logo/text from scene card","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide scene specs (resolution, duration) from scene card */\n\n.scene-specs-overlay {\ndisplay: none;\n}\nHide studio logo/text from scene card.
"},{"location":"themes/custom-css-snippets/#make-the-list-of-tags-take-up-less-width","title":"Make the list of tags take up less width","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide studio logo/text from scene card */\n\n.scene-studio-overlay {\ndisplay: none;\n}\nMake the list of tags take up less width.
"},{"location":"themes/custom-css-snippets/#swap-studio-and-resolutionduration-positions","title":"Swap studio and resolution/duration positions","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Make the list of tags take up less width */\n\n.bs-popover-bottom {\nmax-width: 500px\n}\nSwap studio and resolution/duration positions.
"},{"location":"themes/custom-css-snippets/#adjust-the-mouse-over-behaviour-in-wall-mode","title":"Adjust the mouse over behaviour in wall mode","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Swap studio and resolution/duration positions */\n\n.scene-studio-overlay {\nbottom: 1rem;\nright: 0.7rem;\nheight: inherit;\ntop: inherit;\n}\n\n.scene-specs-overlay {\nright: 0.7rem;\ntop: 0.7rem;\nbottom: inherit;\n}\nAdjust the mouse over behaviour in wall mode.
"},{"location":"themes/custom-css-snippets/#disable-zoom-on-hover-in-wall-mode","title":"Disable zoom on hover in wall mode","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Adjust the mouse over behaviour in wall mode */\n\n@media (min-width: 576px) {\n.wall-item:hover::before {\nopacity: 0; \n}\n\n.wall-item:hover .wall-item-container {\ntransform: scale(1.5);\n}\n}\nDisable zoom on hover in wall mode.
"},{"location":"themes/custom-css-snippets/#hide-the-scene-scrubber","title":"Hide the scene scrubber","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Disable zoom on hover in wall mode */\n\n.wall-item:hover .wall-item-container {\n transform: none;\n}\n.wall-item:before {\n opacity: 0 !important;\n}\nThis will hide the large scene scrubber under the video player and max out the player's height.
"},{"location":"themes/custom-css-snippets/#hide-the-truncated-text","title":"Hide the truncated text","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide the scene scrubber and max out the player's height */\n.scrubber-wrapper {\ndisplay: none;\n}\nThis will hide the truncated text that appears under the tile and date.
"},{"location":"themes/custom-css-snippets/#images","title":"Images","text":""},{"location":"themes/custom-css-snippets/#disable-lightbox-animation","title":"Disable lightbox animation","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes Tab] - Hide the truncated text on scene card */\n\n.TruncatedText.scene-card__description { \ndisplay: none;\n}\nDisable lightbox animation.
"},{"location":"themes/custom-css-snippets/#dont-crop-preview-thumbnails","title":"Don't crop preview thumbnails","text":"DescriptionAuthorScreenshotsCSS code/* [Images tab] Disable lightbox animation */\n\n.Lightbox-carousel {\ntransition: none;\n}\nDon't crop preview thumbnails.
"},{"location":"themes/custom-css-snippets/#groups","title":"Groups","text":""},{"location":"themes/custom-css-snippets/#better-group-layout-for-desktops-regular-size-poster","title":"Better Group layout for desktops, regular size poster","text":"DescriptionAuthorScreenshotsCSS code/* [Images tab] Don't crop preview thumbnails */\n\n.flexbin > * > img {\nobject-fit: inherit;\nmax-width: none;\nmin-width: initial;\n}\nMaking the front and back image much bigger. Left panel uses 70% while the right uses 30%.
"},{"location":"themes/custom-css-snippets/#better-group-layout-for-desktops-larger-size-poster","title":"Better Group layout for desktops, larger size poster","text":"DescriptionAuthorScreenshotsCSS code/* [Groups tab] Better Group layout for desktops: Regular size poster */\n\n.group-details.mb-3.col.col-xl-4.col-lg-6 {\nflex-basis: 70%\n}\n.col-xl-8.col-lg-6{\nflex-basis: 30% \n}\n.group-images{\nflex-wrap: wrap\n}\n.group-image-container {\nflex: 0 0 500px\n}\nMaking the front and back image much bigger. Left panel uses 70% while the right uses 30%.
"},{"location":"themes/custom-css-snippets/#galleries","title":"Galleries","text":""},{"location":"themes/custom-css-snippets/#grid-view-for-galleries","title":"Grid view for galleries","text":"DescriptionAuthorScreenshotsCSS code/* [Groups tab] Better Group layout for desktops: Larger size poster */\n\n.group-details.mb-3.col.col-xl-4.col-lg-6 {\nflex-basis: 70%\n}\n.col-xl-8.col-lg-6{\nflex-basis: 30% \n}\n.group-images{\nflex-direction: column;\nflex-wrap: wrap\n}\n.group-image-container {\nflex: 1 1 700px\n}\nGrid view for galleries.
"},{"location":"themes/custom-css-snippets/#disable-lightbox-image-transition","title":"Disable lightbox image transition","text":"DescriptionAuthorScreenshotsCSS code/* [Galleries tab] Grid view for galleries */\n\n.col.col-sm-6.mx-auto.table .d-none.d-sm-block {\n display: none !important;\n}\n.col.col-sm-6.mx-auto.table .w-100.w-sm-auto {\n width: 175px !important;\n background-color: rgba(0, 0, 0, .45);\n box-shadow: 0 0 2px rgba(0, 0, 0, .35);\n}\n.col.col-sm-6.mx-auto.table tr {\n display: inline-table;\n}\nDisable lightbox image transition.
"},{"location":"themes/custom-css-snippets/#hide-the-lightbox-header-and-footer","title":"Hide the lightbox header and footer","text":"DescriptionAuthorScreenshotsCSS code/* [Gallery tab] Disable lightbox image transition */\n.Lightbox-carousel {\ntransition: unset;\n}\nHides the lightbox header and footer to make the image area larger. Mouse reveals them as an overlay to the image.
peresabcod
"},{"location":"themes/custom-css-snippets/#performers","title":"Performers","text":""},{"location":"themes/custom-css-snippets/#show-entire-performer-image-in-performer-card","title":"Show entire performer image in performer card","text":"DescriptionAuthorScreenshotsCSS code/* [Gallery tab] Hides the lightbox header and footer to make the image area larger. Mouse reveals them as an overlay to the image*/\n\n.Lightbox-header,\n.Lightbox-footer{\nz-index:9999;\nposition:absolute;\nwidth:100%;\nopacity:0;\nbackground-color:#0008;\ntransition: opacity 0.5s ease;\n}\n\n.Lightbox-footer{\nbottom:0;}\n\n.Lightbox-navbutton{\nopacity:0;\ntransition: opacity 0.5s ease;\n}\n\n\n.Lightbox-navbutton:hover,\n.Lightbox-header:hover,\n.Lightbox-footer:hover{\nopacity:1;\n}\nShow entire performer image in performer card.
"},{"location":"themes/custom-css-snippets/#show-a-larger-image-in-performers-page-for-desktop","title":"Show a larger image in performer's page for desktop","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show entire performer image in performer card */\n\n.performer.image {\nbackground-size: contain !important;\n}\nShow a larger image in performer's page for desktop.
"},{"location":"themes/custom-css-snippets/#place-performer-image-in-the-background-on-performer-page","title":"Place performer image in the background on performer page","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show a larger image in performer's page for desktop */\n.performer-image-container{\nflex: 0 0 50%;\nmax-width: 50%;\n}\n/* Changing .col-md-8 settings also affects studios and tags display. 50% should be good enough. */\n.col-md-8 {\nflex: 0 0 50%;\nmax-width: 50%;\n}\nPlace performer image in the background on performer page.
"},{"location":"themes/custom-css-snippets/#show-larger-performer-images-in-performers-list","title":"Show larger performer images in performers list","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Place performer image in the background on performer page */\n\n.performer-image-container.col-md-4.text-center {\n flex: 0 0 0%;\n max-width: 0%;\n}\n\n#performer-page .performer-image-container .btn.btn-link {\n position: fixed;\n width: 100%;\n top: 0;\n left: 0;\n padding: 0;\n}\n\n#performer-page .performer-image-container .btn.btn-link:before {\n content: '';\n position:absolute;\n top:0;\n left: 0;\n right: 0;\n bottom: 0;\n background: linear-gradient(to left, rgba(0,0,0,0) 0%,rgb(0 0 0 / 75%) 100%);\n z-index: 1;\n}\n\n#performer-page .performer-image-container .performer {\n max-height: none;\n max-width: none;\n width: 100%;\n}\nShow larger performer images in performers list.
"},{"location":"themes/custom-css-snippets/#move-the-buttons-in-the-performers-edit-panel-to-the-top-instead-of-bottom","title":"Move the buttons in the Performer's edit panel to the top instead of bottom","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show larger performer images in performers list */\n/* original value: height: 30rem; min-width:13.25rem; */\n.performer-card-image{\nheight: 45rem;\nmin-width: 20rem;\n}\nMove the buttons in the Performer's edit panel to the top instead of bottom (in newer version of Stash, the buttons are already positioned both at top and bottom.
"},{"location":"themes/custom-css-snippets/#move-the-tags-row-in-the-performers-edit-panel-to-the-second-position-just-after-name","title":"Move the tags row in the Performer's edit panel to the second position (just after name)","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Move the buttons in the Performer's edit panel to the top instead of bottom (in newer version of Stash, the buttons are already positioned both at top and bottom. */\n\nform#performer-edit {\n display: flex;\n flex-direction: column;\n}\n#performer-edit > .row {\n order: 1;\n}\n#performer-edit > .row:last-child {\n order: 0;\n margin-bottom: 1rem;\n}\nMove the tags row in the Performer's edit panel to the second position (just after name).
"},{"location":"themes/custom-css-snippets/#studios","title":"Studios","text":""},{"location":"themes/custom-css-snippets/#different-studio-cards-layout","title":"Different studio cards layout","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Move the tags row in the Performer's edit panel to the second position (just after name). */\n\nform#performer-edit {\n display: flex;\n flex-direction: column;\n}\n#performer-edit > .row:nth-child(24) {\n order: -1;\n}\n#performer-edit > .row:first-child {\n order: -2;\n}\nChanges the layout of studio cards.
Qx#1573
"},{"location":"themes/custom-css-snippets/#more-studio-per-row","title":"More studio per row","text":"DescriptionAuthorScreenshotsCSS code/* [Studios tab] Changes the layout of studio cards */\n.studio-card.grid-card.card div.card-section div.rating-banner { display: none; }\n.slick-slide .studio-card-image { height: 300px; }\n\n.studio-card, .recommendation-row .studio-card {\n padding: 0;\n width: 500px;\n height: 300px;\n}\n\n.studio-card-image, .recommendation-row .studio-card .studio-card-image {\n max-height: 300px;\n width: 500px;\n}\n\n.studio-card.grid-card.card div.card-section {\n position: absolute;\n bottom: 0em;\n width: inherit;\n background-color: rgba(0, 0, 0, 0.7);\n overflow: hidden;\n height: 2.5em;\n transition: 0.5s ease-in-out;\n}\n\n.studio-card.grid-card.card div.card-section:hover {\n height: 7em;\n}\nDisplay more studio per row
hijack_hornet
"},{"location":"themes/custom-css-snippets/#tags","title":"Tags","text":""},{"location":"themes/custom-css-snippets/#different-tag-cards-layout","title":"Different tag cards layout","text":"DescriptionAuthorScreenshotsCSS code/* [Studios tab] Show more item per row */\n:not(.recommendation-row .studio-card).studio-card {\n width: 15%\n}\n:not(.recommendation-row .studio-card-image).studio-card-image {\n width: 100%\n}\n.studio-card h5 {\n text-align: center !important;\n display: block;\n}\nChanges the layout of tag cards on tags tab and when hovering on tags in different content.
Qx#1573
"},{"location":"themes/custom-css-snippets/#alternative-tag-layout","title":"Alternative tag layout","text":"DescriptionAuthorScreenshotsCSS code/* [Tags changes] changes the layout of tag cards on tags page and hover */\n.tag-parent-tags, .tag-sub-tags { display: none;}\n.tag-card.zoom-0.grid-card.card div.card-section div.card-popovers.btn-group { margin-top: 1em; }\n.tag-card.zoom-0.grid-card.card div.thumbnail-section a.tag-card-header img.tag-card-image { object-fit: cover; }\n.tag-card.zoom-0.grid-card.card div.card-section hr { display: none; }\n\n.tag-card.zoom-0.grid-card.card {\n padding: 0;\n width: 300px;\n height: 180px;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section {\n position: absolute;\n text-shadow: 2px 2px 2px #000;\n width: 100%;\n background-color: rgba(0, 0, 0, 0.3);\n height: 3em;\n overflow: hidden;\n transition: 0.8s ease-in-out;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section a {\n text-decoration: none;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section:hover {\n height: 22em;\n}\n\n.tag-card.zoom-0.grid-card.card \n div.card-section a \n h5.card-section-title.flex-aligned \n div.TruncatedText {\n white-space: nowrap;\n text-overflow: ellipsis;\n width: 300px;\n overflow: hidden;\n display: block;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section div.TruncatedText.tag-description {\n position: relative;\n top: 0.5em;\n -webkit-text-stroke-width: 1px;\n font-size: 16px;\n}\n\n.tag-card .card-popovers .btn {\n text-shadow: 1px 1px 1px #000;\n stroke: black;\n stroke-width: 15;\n}\nChanges the tags layout to show more images, and details on hover.
hijack_hornet
"},{"location":"themes/custom-css-snippets/#subtag-explorer","title":"Subtag explorer","text":"DescriptionAuthorScreenshotsCSS code/*Tag layout changes*/\n.tag-card {\n width: 16rem;\n padding: 0;\n}\n\n.tag-card .card-section {\n height: 2.5rem;\n position: absolute;\n bottom: 0;\n left: 0;\n right: 0;\n background: #0000007a;\n line-height: none;\n}\n.tag-card .card-section .TruncatedText {\n -webkit-line-clamp: 1 !important;\n}\n.tag-card h1,\nh2,\nh3,\nh4,\nh5,\nh6,\n.h1,\n.h2,\n.h3,\n.h4,\n.h5,\n.h6 {\n line-height: normal;\n}\n.tag-card hr,\n.tag-description {\n display: none;\n}\n.tag-card .btn-group {\n position: absolute;\n width: 100%;\n bottom: 2.5rem;\n margin-bottom: 0;\n opacity: 0;\n transition: ease 0.2s;\n}\n.tag-card .btn-group:hover {\n opacity: 1;\n transition: ease 0.2s;\n background: #0000007a;\n}\n\n.tag-card-image {\n object-fit: cover;\n object-position: center;\n}\n\n.zoom-0 .tag-card-image {\n max-height: none;\n height: 16rem;\n width: 12rem;\n}\n\n.zoom-1 .tag-card-image {\n max-height: none;\n height: 20rem;\n width: 15rem;\n}\n\n.zoom-2 .tag-card-image {\n max-height: none;\n height: 24rem;\n width: 18rem;\n}\n\n.zoom-3 .tag-card-image {\n max-height: none;\n height: 28rem;\n width: 21rem;\n}\n\n.zoom-0.tag-card,\n.zoom-1.tag-card,\n.zoom-2.tag-card,\n.zoom-3.tag-card {\n width: initial;\n}\n\n.tag-card .card-section > a {\n position: absolute;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 7px 14px 0px 14px;\n}\n.tag-card .card-section .tag-sub-tags {\n position: relative;\n margin-top: 2rem;\n z-index: 1;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\nThis snipset includes the above tag layout snipset with a twist. Its meant to be used for people who use subtags as a hierachy. For example Watermelon is a subtag of Fruits, so when i click Fruits i want to see both oranges and watermelons, but i might want to get into the list of fruits subtags more easily. That what this snipset is used for. Any tag that has a subtag will show a (...) icon. When clicking its name you will show all subtags of this tag. if you click its image, it will instead open the tag itself normaly. You can change '137cbd' in the icon url to any color you want to match you theme.
hijack_hornet
"},{"location":"themes/custom-css-snippets/#global","title":"Global","text":""},{"location":"themes/custom-css-snippets/#change-the-order-of-navigation-bar-buttons","title":"Change the order of navigation bar buttons","text":"DescriptionAuthorScreenshotsCSS code/*Tag layout changes*/\n.tag-card {\n width: 16rem;\n padding: 0;\n}\n\n.tag-card .card-section {\n height: 2.5rem;\n position: absolute;\n bottom: 0;\n left: 0;\n right: 0;\n background: #0000007a;\n line-height: none;\n}\n.tag-card .card-section .TruncatedText {\n -webkit-line-clamp: 1 !important;\n}\n.tag-card h1,\nh2,\nh3,\nh4,\nh5,\nh6,\n.h1,\n.h2,\n.h3,\n.h4,\n.h5,\n.h6 {\n line-height: normal;\n}\n.tag-card hr,\n.tag-description {\n display: none;\n}\n.tag-card .btn-group {\n position: absolute;\n width: 100%;\n bottom: 2.5rem;\n margin-bottom: 0;\n opacity: 0;\n transition: ease 0.2s;\n}\n.tag-card .btn-group:hover {\n opacity: 1;\n transition: ease 0.2s;\n background: #0000007a;\n}\n\n.tag-card-image {\n object-fit: cover;\n object-position: center;\n}\n\n.zoom-0 .tag-card-image {\n max-height: none;\n height: 16rem;\n width: 12rem;\n}\n\n.zoom-1 .tag-card-image {\n max-height: none;\n height: 20rem;\n width: 15rem;\n}\n\n.zoom-2 .tag-card-image {\n max-height: none;\n height: 24rem;\n width: 18rem;\n}\n\n.zoom-3 .tag-card-image {\n max-height: none;\n height: 28rem;\n width: 21rem;\n}\n\n.zoom-0.tag-card,\n.zoom-1.tag-card,\n.zoom-2.tag-card,\n.zoom-3.tag-card {\n width: initial;\n}\n\n.tag-card .card-section > a {\n position: absolute;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 7px 14px 0px 14px;\n}\n.tag-card .card-section .tag-sub-tags {\n position: relative;\n margin-top: 2rem;\n z-index: 1;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\n/*Tag subtag exploration snipset*/\n.tag-card .card-section > a {\n cursor: default;\n pointer-events: none;\n}\n.tag-card .card-section > hr {\n margin-top: 2rem;\n}\n.tag-card .card-section .tag-sub-tags {\n position: absolute !important;\n margin-top: 0 !important;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 0;\n}\n.tag-sub-tags::before {\n content: \"\";\n display: block;\n background: url(\"https://img.icons8.com/material-outlined/24/137cbd/connection-status-off.png\")\n no-repeat;\n background-size: 1.5rem 1.5rem;\n width: 1.5rem;\n height: 1.5rem;\n float: right;\n margin: 0.5rem 0.5rem 0 0;\n}\n.tag-sub-tags > a {\n width: 100%;\n height: 100%;\n display: block;\n}\n\n.tag-card .btn-group a {\n z-index: 10;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\nUse
ordervalues below 0 to move specific buttons to the left of the non-ordered buttons, and values above 1 to move them to the right of the non-ordered buttons.
"},{"location":"themes/custom-css-snippets/#hide-the-donate-button","title":"Hide the Donate button","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Change the order of navigation bar buttons */\n\nnav .navbar-nav:first-child {\ndisplay: flex;\nflex-direction: row;\n}\ndiv.nav-link[data-rb-event-key=\"/tags\"] {\norder: -2;\n}\ndiv.nav-link[data-rb-event-key=\"/groups\"] {\norder: -1;\n}\ndiv.nav-link[data-rb-event-key=\"/scenes\"] {\norder: 1;\n}\nHide the Donate button.
"},{"location":"themes/custom-css-snippets/#blur-nsfw-images","title":"Blur NSFW images","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Hide the Donate button */\n\n.btn-primary.btn.donate.minimal {\ndisplay: none;\n}\nUse for when working on stash but don't want to expose NSFW images and text. May not be exhaustive.
"},{"location":"themes/custom-css-snippets/#blur-nsfw-images-and-unblur-on-mouse-over","title":"Blur NSFW images and unblur on mouse over","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Blur NSFW images */\n\n.scene-card-preview-video,\n.scene-card-preview-image,\n.image-card-preview-image,\n.image-thumbnail,\n.gallery-card-image,\n.performer-card-image,\n.tag-card-image,\nimg.performer,\n.group-card-image,\n.gallery .flexbin img,\n.wall-item-media,\n.scene-studio-overlay .image-thumbnail,\n.image-card-preview-image,\n#scene-details-container .text-input,\n#scene-details-container .scene-header,\n#scene-details-container .react-select__single-value,\n.scene-details .pre,\n#scene-tabs-tabpane-scene-file-info-panel span.col-8.text-truncate > a,\n.gallery .flexbin img,\n.group-details .logo {\nfilter: blur(12px);\n}\n\n.scene-card-video {\nfilter: blur(13px);\n}\n\n.jw-video,\n.jw-preview,\n.jw-flag-floating,\n.image-container,\n.studio-logo,\n.scene-cover {\nfilter: blur(20px);\n}\n\n.group-card .text-truncate,\n.scene-card .card-section {\nfilter: blur(4px);\n}\nBlur NSFW images and unblur on mouse over.
fl0w#9497
"},{"location":"themes/custom-css-snippets/#hide-0-count-badges","title":"Hide 0 count badges","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Blur NSFW images and unblur on mouse over */\n/* === MORE BLUR === */\n/* scene */\n.scene-card-preview,\n.vjs-poster,\nvideo,\n.scene-cover,\n.scrubber-item,\n\n/* image */\n.image-card-preview,\n.image-image,\n.gallery-image,\n\n/* group */\n.group-card-image,\n.group-images,\n\n/* gallery */\n.gallery-card-image,\ntable > tbody > tr > td > a > img.w-100,\n\n/* performer */\n.performer-card-image,\nimg.performer,\n\n/* studio */\n.studio-card-image,\n\n/* tag */\n.tag-card-image\n\n{\nfilter: blur(30px);\n}\n\n/* === LESS BLUR === */\n/* common */\n.card-section-title,\n\n/* scene */\n.scene-studio-overlay,\n.scene-header > h3,\nh3.scene-header,\n.studio-logo,\n.image-thumbnail,\n\n/* image */\nh3.image-header,\n\n/* group */\n.group-details > div > h2,\n\n/* gallery */\nh3.gallery-header,\n\n/* studio */\n.studio-details .logo,\n.studio-details > div > h2,\n\n/* tag */\n.logo-container > .logo,\n.logo-container > h2\n\n{\nfilter: blur(2px);\n}\n\n/* === UNBLUR ON HOVER === */\n/* common */\n.thumbnail-section:hover *,\n.card:hover .card-section-title,\n\n/* scene */\n.card:hover .scene-studio-overlay,\n.video-js:hover .vjs-poster,\nvideo:hover,\n.scene-header:hover > h3,\ndiv:hover > .scene-header,\n.studio-logo:hover,\n.scene-cover:hover,\n.image-thumbnail:hover,\n.scene-card-preview:hover,\n.scrubber-item:hover,\n\n/* image */\n.image-image:hover,\ndiv:hover > .image-header,\n.gallery-image:hover,\n\n/* group */\n.group-images:hover,\n.group-details > div > h2:hover,\n\n/* gallery */\ndiv:hover > .gallery-header,\ntable > tbody > tr > td:hover > a > img.w-100,\n\n/* performer */\nimg.performer:hover,\n\n/* studio */ \n.studio-details .logo:hover,\n.studio-details:hover > div > h2,\n\n/* tag */\n.logo-container > .logo:hover,\n.logo-container:hover > h2\n{\nfilter: blur(0px);\n}\nHide 0 count badges.
echo6ix
"},{"location":"themes/custom-css-snippets/#border-around-cards-activated-with-checkbox-selection","title":"Border around cards activated with checkbox selection","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Hide 0 count badges */\nspan.badge[data-value=\"0\"] {\n display: none;\n}\nAdd a noticeable border around any cards that have been selected using the checkbox selection. Border color uses Stash's
--primarycolor variable to maintain consistency with any theme that uses Stash's color variables.echo6ix
"},{"location":"themes/list/","title":"Browse themes","text":""},{"location":"themes/list/#browse-themes","title":"Browse themes","text":""},{"location":"themes/list/#sources","title":"Sources","text":"/* [Global changes] Modify card when checkbox is selected */\n.grid-card.card:has(input:checked) {\nbox-shadow: 0 0 0 1px var(--primary,rgba(255, 255, 255, 0.30));\n}\n- https://feederbox826.github.io/themes/main/index.yml
- https://serechops.github.io/Serechops-Stash/index.yml
- https://stashapp.github.io/CommunityScripts/stable/index.yml
- https://tetrax-10.github.io/stash-stuffs/index.yml
- https://uncertainmongoose.github.io/dracula-for-stash/index.yml
Changes the tags layout to show more images, and details on hover
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#direct-stream","title":"direct-stream","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds styling to settings to indicate direct stream
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#dracula-theme","title":"Dracula Theme","text":"DescriptionSource URLREADMEAuthorScreenshotsA dark theme for Stash based on the popular Dracula theme.
https://uncertainmongoose.github.io/dracula-for-stash/index.yml\nNo README available
UncertainMongoose
"},{"location":"themes/list/#glassy-a-window-to-your-collection","title":"Glassy - A Window to Your Collection","text":"DescriptionSource URLREADMEAuthorScreenshotsA Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-font-overhaul","title":"Glassy - Font Overhaul","text":"DescriptionSource URLREADMEAuthorScreenshotsA Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-front-page-animations-and-blur","title":"Glassy - Front Page Animations and Blur","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-marker-wall-redesign","title":"Glassy - Marker Wall Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-performer-scene-card-details-redesign","title":"Glassy - Performer Scene Card Details Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-and-movie-card-redesign","title":"Glassy - Scene and Movie Card Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-and-movie-card-redesign-no-animated-titles","title":"Glassy - Scene and Movie Card Redesign - No Animated Titles","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-6040","title":"Glassy - Scene Player-Details 60/40","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-reversed","title":"Glassy - Scene Player-Details Reversed","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-reversed-6040","title":"Glassy - Scene Player-Details Reversed 60/40","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-smaller-performer-cards-on-main-page","title":"Glassy - Smaller Performer Cards on Main Page","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-smaller-performer-image-cards","title":"Glassy - Smaller Performer Image Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-video-res-icons","title":"Glassy - Video-Res Icons","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-images","title":"Glassy Images","text":"DescriptionSource URLREADMEAuthorScreenshotsImages for A Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-installer","title":"Glassy Installer","text":"DescriptionSource URLREADMEAuthorScreenshotsGlassy meta-package for requirements.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#hide-donate","title":"hide-donate","text":"DescriptionSource URLREADMEAuthorScreenshotsHide the Donate button.
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#hide-ocount","title":"hide-ocount","text":"DescriptionSource URLREADMEAuthorScreenshotsHide O-Count and O-Count trakcers
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#more-studio-row","title":"more-studio-row","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay more studio per row
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#no-autotag","title":"no-autotag","text":"DescriptionSource URLREADMEAuthorScreenshotsHide autotagger, everywhere
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#no-speed","title":"no-speed","text":"DescriptionSource URLREADMEAuthorScreenshotsHide the playback speed button
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#noto-color-emoji","title":"noto-color-emoji","text":"DescriptionSource URLREADMEAuthorScreenshotsNoto Color Emoji font
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#performer-grid","title":"performer-grid","text":"DescriptionSource URLREADMEAuthorScreenshotsAligns performer details in a grid
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#theme-blackhole","title":"Theme - BlackHole","text":"DescriptionSource URLREADMEAuthorScreenshotsBlackHole Theme for Stash by BViking78
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
BViking78
"},{"location":"themes/list/#theme-colorpalette","title":"Theme - colorPalette","text":"DescriptionSource URLREADMEAuthorScreenshotsBased on the default theme, change the overall color of the page by setting the hue value. Make minor changes to the remaining styles.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
wql219
"},{"location":"themes/list/#theme-minimal","title":"Theme - Minimal","text":"DescriptionSource URLREADMEAuthorScreenshotsMinimal Theme for Stash
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
deuulc
"},{"location":"themes/list/#theme-moderndark","title":"Theme - ModernDark","text":"DescriptionSource URLREADMEAuthorScreenshotsModernDark Theme for Stash by cj13
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
cj13
"},{"location":"themes/list/#theme-neondark","title":"Theme - NeonDark","text":"DescriptionSource URLREADMEAuthorScreenshotsNeonDark Theme for Stash by Dankonite
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Dankonite
"},{"location":"themes/list/#theme-night","title":"Theme - Night","text":"DescriptionSource URLREADMEAuthorScreenshotsNight Theme for Stash (unknown author)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"themes/list/#theme-plex","title":"Theme - Plex","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fidelio 2020
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fidelio
"},{"location":"themes/list/#theme-plex-better-styles","title":"Theme - Plex Better Styles","text":"DescriptionSource URLREADMEAuthorScreenshotsA modified version of Stash-Plex theme
https://tetrax-10.github.io/stash-stuffs/index.yml\nView README
tetrax-10
"},{"location":"themes/list/#theme-pornhub","title":"Theme - Pornhub","text":"DescriptionSource URLREADMEAuthorScreenshotsPornHub Theme for Stash by neurokinin
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
ronilaukkarinen
"},{"location":"themes/list/#theme-pulsar","title":"Theme - Pulsar","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fonzie 2020-21
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#theme-pulsarlight","title":"Theme - PulsarLight","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fonzie 2021
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#theme-rounded-yellow","title":"Theme - Rounded Yellow","text":"DescriptionSource URLREADMEAuthorScreenshotsTheme with rounded corners and yellow accents
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#wrap-subtag","title":"wrap-subtag","text":"DescriptionSource URLREADMEAuthorScreenshotsWraps detail values (subtags)
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"userscripts/","title":"Userscripts","text":"Info
Userscripts are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Userscripts are programs written in Javascript that modifies web pages to improve browsing with new features, formatting and more.
"},{"location":"userscripts/#install","title":"Install","text":"To install the userscript you will need a browser extension such as:
- Violentmonkey
- Tampermonkey
- Greasemonkey
Exhaustive list of git repositories related to Stash Google Sheets document.
Userscript no longer worksIf you found that userscript is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"userscripts/list/#stash-userscripts","title":"Stash userscripts","text":"CompatabilityMake sure your instance URL is declared in
"},{"location":"userscripts/list/#performer-image-carousel","title":"Performer Image Carousel","text":"DescriptionAuthorScreenshots@match.Displays a carousel of performer images in the header.
Serechops
"},{"location":"userscripts/list/#stash-checker","title":"stash-checker","text":"DescriptionAuthorScreenshotsStash Checker is an userscript for porn websites to check if a Scene/Performer is in your Stash instance. It shows a checkmark if an item was found in your Stash. Hovering over the checkmark gives you a tooltip with information about the item in your Stash.
timo95
"},{"location":"userscripts/list/#stashcreateall","title":"stashCreateAll","text":"DescriptionAuthorScreenshotsAutomate batch creation and tagging
Serechops
"},{"location":"userscripts/list/#stash-box-userscripts","title":"stash-box userscripts","text":"stash-box compatabilitySometimes just updating
"},{"location":"userscripts/list/#db-noto-color","title":"db-noto-color","text":"DescriptionAuthorScreenshots@matchis enough to make the userscript to work on a different stash-box instance. But it's not a guarantee.Adds Noto Color Emoji to stash-box instances
feederbox826
"},{"location":"userscripts/list/#fansdb-submission-helper","title":"FansDB Submission Helper","text":"DescriptionREADMEAuthorScreenshots- Adds button to add all unmatched aliases to performer
- Adds button to add all unmatched urls to performer
- Adds button to add all unmatched measurements to performer (if they match expected formats)
- Convert unmatched urls from regular strings to linked strings
View README
mmenanno, DogmaDragon
"},{"location":"userscripts/list/#stashdb-submission-helper","title":"StashDB Submission Helper","text":"DescriptionREADMEAuthorScreenshots- Adds button to add all unmatched aliases to performer
- Adds button to add all unmatched urls to performer
- Adds button to add all unmatched measurements to performer (if they match expected formats)
- Convert unmatched urls from regular strings to linked strings
View README
mmenanno
"},{"location":"userscripts/list/#stashdb-diff","title":"stashdb-diff","text":"DescriptionAuthorScreenshotsadd character-by-character diff for stashdb
feederbox826
"},{"location":"userscripts/list/#stashdb-link-chip","title":"stashdb-link-chip","text":"DescriptionAuthorScreenshotsadd chips to links in edit queue
feederbox826
"},{"location":"userscripts/list/#stashdb-relative-date","title":"stashdb-relative-date","text":"DescriptionAuthorScreenshotsadds relative dates to stashdb
feederbox826
"},{"location":"userscripts/list/#stashdb-rm","title":"stashdb-rm","text":"DescriptionAuthorScreenshotsRemove scenes from loaded studios on stashdb.org
feederbox826
"},{"location":"userscripts/list/#studio-image-blur-for-stashdb","title":"Studio Image Blur for StashDB","text":"DescriptionAuthorScreenshotsBlurs images from specific studios on StashDB scene cards, based on studio name and img src
Serechops
"},{"location":"userscripts/list/#utility-userscripts","title":"Utility userscripts","text":"There are some userscripts that might be useful to Stash users, but does not directly involve Stash or stash-box instances.
"},{"location":"userscripts/list/#twitter-media-unblur","title":"twitter-media-unblur","text":"DescriptionAuthorScreenshotsunblur all twitter sensitive media post
feederbox826
"},{"location":"userscripts/list/#pmvhaven-autodl","title":"PMVHaven AutoDL","text":"DescriptionAuthorScreenshotsDashboard to simplify PMV downloading on PMVHaven
S3L3CT3DLoves
"},{"location":"userscripts/list/#spankbang-autodl","title":"SpankBang AutoDL","text":"DescriptionAuthorScreenshotsDashboard to download all a user's videos on SpankBang
S3L3CT3DLoves
"},{"location":"userscripts/list/#spankbang-frontend-scraper","title":"SpankBang Frontend Scraper","text":"DescriptionAuthorScreenshotsUse in Stash to scrape Spankbang from the browser, bypassing cloudflare issues
S3L3CT3DLoves
"},{"location":"userscripts/list/#lifeselector-unblur","title":"LifeSelector unblur","text":"DescriptionAuthorScreenshotsUnblur LifeSelector website
feederbox826
"},{"location":"userscripts/list/#redgifs-autosettings","title":"redgifs autosettings","text":"DescriptionAuthorScreenshotsAuto Unmute / Play / HD redgifs
feederbox826
"},{"location":"userscripts/list/#stash-tmdb-syncscraper","title":"Stash-TMDB Sync/Scraper","text":"DescriptionAuthorScreenshotsSync Button in TMDB Site.to Create Movie/Performer in Stash and Update performer missing info.
W0lfieW0lf
"},{"location":"utilities/","title":"Utilities","text":"Info
Utilities are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Utilities are other external applications that utilise or interact with Stash in some way.
To install follow the utilities install instructions.
"},{"location":"utilities/list/","title":"Browse utilities","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Utility no longer worksIf you found that utility is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"utilities/list/#clip-mash","title":"clip-mash","text":"DescriptionAuthorScreenshotsVideo editing app that allows you to automate creating compilations from multiple videos. It runs in your browser. It's mostly made for, ahem, adult content, which is why it can connect to Stash and fetch videos and scene markers from there to guide the video creation process. You can also use local files and set the markers in ClipMash itself and then generate a compilation based on that.
soundchaser128
"},{"location":"utilities/list/#stash-app-for-android-tv","title":"Stash App for Android TV","text":"DescriptionAuthorScreenshotsA basic Android TV app for browsing and playing videos from a Stash server. Not all features of Stash are supported, but the basics for browsing, searching, and playing scenes should work. The app is not intended to perform administrative functions such as scanning, scraping, or editing details.
damontecres
"},{"location":"utilities/list/#stash-compilation-maker","title":"stash-compilation-maker","text":"DescriptionAuthorScreenshotsConnects to your Stash instance and creates simple compilation videos from scene markers. You select one or more tags, or one or more performers and it will take (currently) the first 15 seconds of video after the marker start and compile all of the markers into one video.
soundchaser128
"},{"location":"utilities/list/#stash-qmt","title":"stash-qmt","text":"DescriptionAuthorScreenshotsstash-qmt (quick manual tagger) is a simple GUI tool designed to help with cases of manually tagging multiple similar scenes (manually, as in, with having to actually watch them) in Stash.
PokerFacowaty
"},{"location":"utilities/list/#stash-vr-companion","title":"stash-vr-companion","text":"DescriptionAuthorScreenshotsSimilar to stash-deovr as above but designed as a web app that sits in a docker container next to stash to make it easier to use and add more functionality.
Tweeticoats
"},{"location":"utilities/list/#stash-vr","title":"stash-vr","text":"DescriptionAuthorScreenshotsWatch your Stash library in VR for that full immersion effect.
Stash-VR bridges your Stash instance and VR video player allowing you to browse, play and manage your scenes using the video players native VR UI.
o-fl0w
"},{"location":"utilities/list/#stash-webvr","title":"stash-webvr","text":"DescriptionAuthorScreenshotsWebVR friendly Stash client that displays only videos tagged with \"Virtual Reality\" tag.
stishadmin
"},{"location":"utilities/list/#stash_helper","title":"Stash_helper","text":"DescriptionAuthorScreenshotsAdds some helping features to Stash (Bookmarks, playlist, external player, etc). Windows only.
philpw99
"},{"location":"utilities/list/#stashbox-performer-bot","title":"StashBox Performer Bot","text":"DescriptionAuthorScreenshotsThis program is designed to help automate the creation and updating of Performers on StashBox instances. It is designed to copy Performer info from one StashBox to another, to avoid having to maintain the information in both sources manually.
S3L3CT3DLoves
"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"Stash is a web application written in Go for serving and organizing your porn collection. It is self-hosted and released under AGPL-3.0 license. Stash currently supports Windows, macOS, Linux, FreeBSD and Docker.
"},{"location":"#about-stash","title":"About Stash","text":"- Stash gathers information about videos in your collection from the internet, and is extensible through the use of community-built plugins for a large number of content producers and sites.
- Stash supports a wide variety of both video and image formats.
- You can tag videos and find them later.
- Stash provides statistics about performers, tags, studios and more.
You can learn more about the software generally via the README on the official repository or via the Stash official website.
"},{"location":"#get-started","title":"Get started","text":"To get started go to Installation and download the latest version for your operating system.
"},{"location":"#support","title":"Support","text":"-
Community forum (recommended)
Primary place for community support, feature requests and discussions.
Browse forum
-
Discord
Real-time chat and community support.
Join Discord
-
Lemmy
Community discussions.
Visit Lemmy
- Spread the word: the more people that know about Stash, the more people can help with the tasks below.
- Help other users: we got new users coming in all the time that need assistance. Stopping in help channels/rooms now and again to assist can save developers some time.
- Write documentation: help to improve the Stash documentation.
- Contribute to the website: the website could definitely use some attention.
- Find bugs: test the software for bugs and create GitHub issues for them to help developers confirm and fix them faster.
- Write scrapers: if there is a site that isn't being scraped properly or at all, head on over to scrapers channel/room and see if you can't help scrape some metadata from a site.
- Populate StashDB: StashDB is our canonical database where we store metadata and hashes. You can submit info from your Stash instance to the database or just help to improve the already existing information.
- Support financially: Stash development runs on donations. Donations are collected through OpenCollective. You can do anonymous one-time donations or recurring donations.
- Sponsor on GitHub: You can sponsor the stashapp organization on GitHub via one-time or monthly donation.
The Stash GraphQL API facilitates automated operations through a type-based schema that is both introspective and self-documenting.
Stash includes an integrated playground where users can execute queries and retrieve schema structures and documentation via a special introspection query.
- You can access the playground by navigating to
<server>:<port>/playground(default: http://localhost:9999/playground). - Click on the left to access the Documentation Explorer.
All HTTP requests should be directed to
<server>:<port>/graphql(default:http://localhost:9999/graphql).Tip
For further information, visit the official GraphQL site.
"},{"location":"api/#authentication","title":"Authentication","text":"Include the API key generated in Stash in the header of every request. For details on obtaining the API Key, refer to Stash's in-app manual.
Example using curlReplace
<your_api_key>with your API Key found under Settings > Security > Authentication.Replace
<graphql_query>with the raw query, which can be formatted using the playground.
"},{"location":"api/#legacy-cookie-authentication","title":"Legacy cookie authentication","text":"curl -X POST -H \"ApiKey: <your_api_key>\" -H \"Content-Type: application/json\" --data '{ \"query\": \"<graphql_query>\" }' localhost:9999/graphql\nFor configurations using a username/password, cookies must be used for authentication.
Example using curlcurl --verbose --cookie-jar cookie.txt --data 'username=stash&password=**' localhost:9999/login\ncurl --cookie cookie.txt -H \"Content-Type: application/json\" --data '{ \"query\": \"<graphql_query>\" }' localhost:9999/graphql\nIt is recommended to use the
"},{"location":"code-of-conduct/","title":"Code of conduct","text":""},{"location":"code-of-conduct/#our-pledge","title":"Our Pledge","text":"API Keymethod over the legacy cookie method.We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
"},{"location":"code-of-conduct/#our-standards","title":"Our Standards","text":"Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery outside of areas that explicitly allow them, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
"},{"location":"code-of-conduct/#scope","title":"Scope","text":"This Code of Conduct applies within all community spaces, community servers, code repositories, and also applies when an individual is officially representing the community in public spaces.
"},{"location":"code-of-conduct/#enforcement","title":"Enforcement","text":"Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. You can contact Admin or Org Lead members directly via Discord or using an integrated report function on other platforms. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
"},{"location":"code-of-conduct/#enforcement-guidelines","title":"Enforcement Guidelines","text":"Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
"},{"location":"code-of-conduct/#warning","title":"Warning","text":"Offense: First time offence.
Consequence: A public or private written warning depending on the space where offense happened.
"},{"location":"code-of-conduct/#temporary-or-permanent-ban","title":"Temporary or Permanent Ban","text":"Offense: Second time offense.
Consequence: Temporary or permanent ban from any sort of public interaction within the community and removal of any previously given elevated permissions.
"},{"location":"code-of-conduct/#attribution","title":"Attribution","text":"This Code of Conduct is a modified and adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
"},{"location":"beginner-guides/exclude-file-configuration/","title":"Exclude file configuration","text":""},{"location":"beginner-guides/guide-to-scraping/","title":"Guide to Scraping","text":"The following is our recommended procedure for new Stash users who want to get info for their scenes as quickly, easily, and as accurately as possible. Pulling info directly from StashDB is still the best option, but unfortunately this will not always be possible. Alternative methods are also covered for when StashDB doesn't have what you need. This is an expanded version of @Scruffy's pinned post in the #stashdb-general channel in our Discord. Go there if you'd like something more succinct and direct. Hopefully this guide will reduce the pain and frustration for those who are lost and don't know where to start.
The following sections are in this particular order for a reason, so please follow this guide from the beginning.
"},{"location":"beginner-guides/guide-to-scraping/#generate-phashes","title":"Generate pHashes","text":"-
Navigate to the Settings page (\u2699 icon in top right), make sure you're on \"Tasks\" in the sidebar to the left, then find the first heading \"Library\" in the middle of the page. Make sure \"Generate perceptual hashes\" is turned on so pHashes will be created automatically each time you run a scan to add new scenes. This will slow down the scanning process, but for most users it's worth it. pHashes are the main way to match your scenes with our data on StashDB.
-
pHash generation is not turned on by default, so you'll need to generate them manually if you haven't already. This can be done on your entire library on the same Settings --> Tasks page, scroll down to the \"Generated Content\" heading. Make sure \"Perceptual hashes (for deduplication)\" is turned on and click the \"Generate\" button at the top. As long as \"Overwrite existing generated files\" is turned off, this will only generate missing files and hashes.
If you haven't set up StashDB in your Stash settings yet, now's the time to do it. The best way to do that is to follow this guide to Accessing StashDB. It includes step-by-step instructions for both signing up to StashDB and connecting your new account to Stash.
"},{"location":"beginner-guides/guide-to-scraping/#use-the-scene-tagger","title":"Use the Scene Tagger","text":"-
Go to your Scenes page on Stash and click the double \ud83d\udd16 icon to the far right of the search bar. This is your Scene Tagger view and should be your first choice for pulling data, not Identify / Autotag / Filename Parser / URL Scrapers / etc. Always use the Scene Tagger first, the rest are for users with more specific needs who understand the strengths and weaknesses of each tool.
Important
Tags are not created automatically. You need to click
+icon near the tag name to create it for you locally and attach it to the scene. Once it's created, it will match automatically in the future. -
First, click the \"Scrape All\" button. This will use your pHashes to find matching scenes on StashDB for every scene on the current page. The \"Scrape by fragment\" buttons will do the same thing but just for one scene at a time. Also, you may want to change your Scene Tagger settings with the \u2699 icon next to \"Scrape All.\" You can tell it to Merge (keep all) tags, Overwrite (keep only new) tags, or ignore StashDB's tags entirely (leave box unchecked). If you plan on contributing to StashDB, you should have \"Show male performers\" turned on to better follow these guidelines.
-
If your fingerprint search doesn't return a correct result for your scene, you can try searching with the \"Query\" field using title, performer, release date, or studio. Try to use as little text as possible to find your scene. Otherwise, unnecessary words that do not match StashDB's info may block correct results. If you can find the matching scene on StashDB.org but can't find it using the Scene Tagger, you can use the scene's StashID as your Tagger query.
-
Be sure to double-check that each selected result matches your scene before clicking the \"Save\" button at the bottom of each card. If you're confident that all of your saved matches are accurate, you may click the \"Submit fingerprints\" button after you're done. This will add your files' hashes to StashDB to make them easier for other users to find. But again, make sure your files were matched correctly first. The button will appear right next to the \"Scrape All\" button.
- If you are absolutely sure a scene isn't on StashDB anywhere, the next easiest method is to try ThePornDB. They have significantly more scenes than StashDB thanks to their automated scrapers, but their info isn't always as complete or accurate compared to StashDB's manually curated approach. They also don't have as many pHashes so matching scenes can be trickier as well. By using their Endpoint and submitting fingerprints to them when you have a good match via searching, you make life easier for everyone else scraping there.
{:style=\"counter-reset:none\"} 1. First step is to make an account at theporndb.net. With your account created, navigate to your API Tokens page. Type \"stash\" as your token's name (or whatever you'd prefer), make sure the \"read\" permission is checked (you don't need the others), and click the \"Create\" button. A pop-up will display your newly created token. Save your API token somewhere so you can find it later!. It will not be visible on ThePornDB's website after you close the pop-up. If you lose it, you may need to create a new one and repeat this entire setup process. This can be done in a password manager, notes app, or a well-placed text file.
\n- Go to the Settings page in Stash (http://localhost:9999/settings by default), click Metadata Providers on the left side and find Stash-box Endpoints at the top.
{:style=\"counter-reset:none\"} 1. Click Add and fill out the form that pops up: paste in your API key you created earlier amd enter
ThePornDB(or anything else you'd like, like TPDB) for Name, and enterhttps://theporndb.net/graphqlas the GraphQL endpoint.-
Click Test Credentials to make sure you've entered everything correctly, then click Confirm.
-
Finally, we can use the Scene Tagger to scrape from ThePornDB. First you'll need to switch to \"ThePornDB\" as the Tagger's source. It will always default to the first Stash-Box source, so you'll need to switch it every time you need something else. Use the same process here as we used with StashDB and the Scene Tagger. The \"Scrape All\" and \"Scrape by fragment\" buttons will match by using file hashes (pHash and oshash). If these don't give you the right results, you can try the \"Search\" button and customize your search terms as needed. Remember to use as few terms as possible in your search because unneccessary words that don't match ThePornDB's info may block correct results. You can also copy-paste additional terms from TPDB's page if you need to narrow down the Tagger's results more.
For those wanting to contribute to StashDB
As noted before, ThePornDB leans heavily on automated scrapers to pull all of their info. Often that data is incomplete or inaccurate compared to what we'd want on StashDB. Before you submit your scene to StashDB, you'll need to double-check your info, clean it up a bit first, and make sure you're following these guidelines. Submitting to StashDB is discussed further in the last step of this guide.
"},{"location":"beginner-guides/guide-to-scraping/#use-site-specific-scrapers","title":"Use Site-Specific Scrapers","text":"-
If you've already tried StashDB, you've already tried ThePornDB, and you still want to scrape a site directly, you can try using a site-specific scraper. However, every scraper is going to work differently. Some will need Python installed. Others will need you to set a user agent or a Chrome CDP path. A handful will need to be edited and configured first. Only a few can search a studio's website for the right scene. The entire process is much more advanced and is different for each scraper, which is why we recommend StashDB and TPDB first for new users. They can all be found in the same repo. You can download them individually, or you can download the entire repo as a zip archive.
-
First you'll want to search this page for your website to see if we have a scraper for it and to get an idea of what its requirements are. For most of these scrapers, you'll need to find and save a studio URL to your scene first. If you've managed to set up a fragment scraper, you can click on the \"Scrape with...\" button in the scene's edit tab to select your scraper. Typically fragment scrapers are better than URL scrapers. Otherwise, you'll need to click the button at the far right end of the URL field to run a URL scraper. It should light up when the field is filled with a URL that matches one of your installed scrapers. That's about as detailed as we can get in this guide for new users. If you've tried StashDB, tried TPDB, checked the relevant documentation, checked your logs, and still can't get one of these scrapers working, you can ask for help on Discord in the #help channel. More advanced discussions might be moved to the #scrapers channel
-
If you're certain a scene isn't on StashDB and you've found the info using ThePornDB or some other scraper, please consider submitting it to StashDB yourself. That way nobody else will have to duplicate the same work you've done for that particular scene if they can match their pHash with yours. You'll need to ask for edit privileges in our Discord and follow the guidelines on this website. In particular, please note that not every scene can be added to StashDB at this time. Some studios aren't allowed and full movies likely won't be eligible either.
-
Also, please don't blindly resubmit data gotten from ThePornDB. You should verify the data is correct and complete first, make sure the URL is right, check for any missing performers, and look up any relevant guidelines if something else seems funky to you. You should update your data within Stash before submitting a draft or you can edit the draft on StashDB itself before creating the edit. You should also have the studio URL now, so you should also compare with that page manually or even scrape again with a site-specific scraper as explained in the previous step of this guide. Also please note in your edit comment where your data is coming from.
Stash data is considered private, and Stash is not designed to be publicly exposed, except to trusted confidants. Stash has a built-in protection against accidentally exposing itself publicly outside of your network. If Stash receives a request from the public internet, and you do not have a password enabled, Stash will reject the request and stop handling requests to protect your privacy.
This often happens when you use the port-forwarding feature of your router or install Stash on a publicly accessible server, such as a VPS. When you do this, anybody in the world can access your Stash instance, so we enforce a password requirement. If your Stash instance has shutdown due to an insecure configuration, it will not handle requests again until you tell it that you have fixed the problem. After setting up either authentication, firewall, or removing your port forwarding rules, you can edit
"},{"location":"faq/setup/#alternative-and-safe-methods-to-access-your-stash","title":"Alternative and safe methods to access your Stash","text":".stash/config/config.ymland remove the keysecurity_tripwire_accessed_from_public_internet.You may use several methods to safely access Stash from outside of your home network. In the most basic, you can enable authentication in Stash, and re-enable port forwarding. You can also use a VPN solution that allows you to securely access your home network, such as Tailscale, Zerotier, Wireguard, or others.
"},{"location":"faq/setup/#using-an-external-authentication-provider","title":"Using an external authentication provider","text":"If you are an advanced user, and have secured your Stash instance behind an authwall provided by a reverse proxy or hosting solution, you may continue to use that. You simply have to edit
.stash/config/config.ymland setdangerous_allow_public_without_authtotrue. If you have already tripped the security feature, you will also have to remove thesecurity_tripwire_accessed_from_public_internetkey in order to allow Stash to serve requests.You will also have to disable Stash built-in authentication by clearing the username/password values in Security > Authentication > Credentials.
"},{"location":"getting-started/first-steps/","title":"First steps","text":""},{"location":"getting-started/first-steps/#setting-up-content-libraries","title":"Setting up content libraries","text":"- Go to Settings > Library and click Add Directory.
- To change the drive letter/volume, just type it in the field.
- Select the folder containing the content you want to add. It will select the folder and all sub-folders.
- Click Confirm.
- Go to Settings > Tasks.
- Select options you want based on your preferences, but keep in mind that every option increases time the scan will take.
- You can stop and re-scan it will ignore the files that are already scanned and just scan new or missing files.
- Go to Settings > Tasks.
- Click Scan to start scanning for the content from your setup libraries or Selective Scan... if you want to scan a specific location.
Info
If you decide to cancel the task in the queue, next time you will start the task, it will skip the files that were already scanned.
"},{"location":"guides/","title":"Guides","text":"In this section the community written guides will be published. You can submit your own via Stash-Docs repository.
If you find the guide has a typo or is outdated you can submit a pull request to fix it or make an issue on the GitHub. Thank you!
"},{"location":"guides/advanced-configuration-options/","title":"Advanced configuration options","text":"Some configuration options can not be edited through the UI and should only be used if needed.
Depending on the option they can be configured either by editing the
config.ymlconfiguration file or by using an enviroment variable or in a few cases by using flags when running stash.As an example the
portoption can be changed from the default9999to1234by one of the below methods:- adding
port: 1234to the config.yml file - setting the ENV variable STASH_PORT to 1234 eg
STASH_PORT=1234 ./stash - using the flag --port when running stash
./stash --port 1234
Always use the UI to create a backup of the database. As with all live databases DO NOT copy manually the database file as a means of backup.
Stash uses an sqlite database with
WALmode enabled. This practically means that along with the main db filestash.go-sqlitethere can be a-shmand a-walfile present (more info). Even stopping Stash might leave some of these index files present so again DO NOT manually copy the database file.The Backup or Download Backup tasks are the proper way to create a backup file.
- Go to Settings > System.
- Under Application Paths heading scroll down to Backup Directory Path.
- Set directory to store your backups.
- Go to Settings > Tasks.
- Under Backup heading you will find 2 tasks.
- Select either Backup or Download Backup task.
Assuming you have properly created a backup file you can use it to restore your database if needed.
Info
The restore procedure uses the default
stash-go.sqlitefilename, if you changed that when configuring Stash adjust accordingly.The following steps are recommended when restoring a database file:
- Go to Settings > System, scroll down to Database heading and check your Database Path location.
- Create a backup of the current database. (optional)
- Stop Stash.
- In your file browser, go to the location of your database path.
- Move or delete the
stash-go.sqlitedatabase file (along with the-shm-wal.journalfiles if present). - Copy the backup file that you want to restore to
stash-go.sqlite. - Make sure that you now have a
stash-go.sqlitefile and that no-shm-wal.journalfiles are present. - Start Stash.
You should now have Stash running with a working and restored database.
"},{"location":"guides/backup-and-restore-database/#advanced-troubleshooting","title":"Advanced troubleshooting","text":"If you get a database malformed message during upgrade or backup that probably means that the database is already corrupt. One way to get past that is to do a full export and check the error log. If there are not a lot of errors you can then try to do a full import and get a working db with minimal losses. As the full import is destructive proceed with caution. For cases like this it is better to ask for support.
"},{"location":"guides/importing-via-csv-using-gql-iterate/","title":"Bulk importing via CSV using gql-iterate","text":"If you want to add a collection of performers, tags, studios, etc, and you have a text/spreadsheet list of them, here's the walkthrough of how to do it via a simple CLI method.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-1-install-gql-iterate","title":"Step 1: Install gql-iterate","text":"gql-iterate repository
npm install @efstajas/gql-iterate -goryarn add @efstajas/gql-iterate -gFor latest versions of NodeJS (14>) you need to go where you globally install your npm modules (AppData/Roaming/npm/node_modules/@efstajas/gql-iterate/bin) and add the following to the first line of the cli.js file.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-2-prepare-your-gqlfile-if-needed","title":"Step 2: Prepare your gql.file if needed","text":"import { createRequire } from 'module'; const require = createRequire(import.meta.url);See below for example versions of performers.gql and tags.gql samples that should work for you. Others can be figured out (with minor changes needeed) from stash/graphql/documents/mutations
These are NOT identical to the original files found above. Compare you'll see how they differ. This is very specific to be used for gql-iterate.
tags.gqlperformers.gqlmutation TagCreate( \n $name: String!,\n $image: String) {\n tagCreate(input: { \n name: $name, \n image: $image \n }) {\n id\n }\n }\nmutation PerformerCreate( \n $name: String!, \n $url: String, \n $gender: GenderEnum, \n $birthdate: String, \n $ethnicity: String, \n $country: String, \n $eye_color: String, \n $height: String, \n $measurements: String, \n $fake_tits: String, \n $career_length: String, \n $tattoos: String, \n $piercings: String, \n $aliases: String, \n $twitter: String, \n $instagram: String, \n $favorite: Boolean, \n $image: String) {\n performerCreate(input: { \n name: $name, \n url: $url, \n gender: $gender, \n birthdate: $birthdate, \n ethnicity: $ethnicity, \n country: $country, \n eye_color: $eye_color, \n height: $height, \n measurements: $measurements, \n fake_tits: $fake_tits, \n career_length: $career_length, \n tattoos: $tattoos,\n piercings: $piercings, \n aliases: $aliases, \n twitter: $twitter, \n instagram: $instagram, \n favorite: $favorite, \n image: $image }\n ) \n { id } \n }\nIf you have a suggested change, please add it below.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-3-prepare-your-textfile-or-spreadsheet-into-a-csv","title":"Step 3: Prepare your textfile or spreadsheet into a CSV","text":"let's say you have a textfile with these performers (just names and eyecolors for a simple example) If you have a spreadsheet, add a first line with the column headers, you HAVE to provide all fields listed above in the first line, but you don't have to actually have data in them.
name,url,gender,birthdate,ethnicity,country,eye_color,height,measurements,fake_tits,career_length,tattoos,piercings,aliases,twitter,instagram,favorite,imagethen add your data if text, or export as CSV if it's a spreadsheet (gender is not a string, see documentation in code, and favorite is a boolean, if you want to add those)
Alice,,,,,,blue\nBetty,,,,,,green\nCarter,,,,,,brown\nthe above lines all go into a file, like performerdata.csv
Gender is complicated due to Stash using GenderEnum.
For tags, you only need the tag title, and if desired, a url to a image
If you're unable to get this to work, then omit the favorite and image property from your CSV header, and from the performers.gql file.
"},{"location":"guides/importing-via-csv-using-gql-iterate/#step-4","title":"Step 4","text":"Note
Must use numerical IP instead of localhost.
Run this CLI command (assumes your files are in current directory and location for gql-interate is in your path)
gql-iterate --host http://_yourserverIP:portgoeshere_/graphql --input ./performerdata.csv --query ./performers.gqlIt will run and add performers, it won't duplicate existing names, so you can run it multiple times if you want to add more names. Or delete something and readd it, if need be.
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/","title":"Manually editing the Stash sqlite3 database","text":""},{"location":"guides/manually-editing-the-stash-sqlite3-database/#location","title":"Location","text":"The Stash Sqlite3 database file is located at
~/.stash/stash-go.sqlite.Before making changes to the Stash sqlite3 database - please make a backup first!
You can use the
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/#opening-the-database-file","title":"Opening the database file","text":"sqlite3client to directly edit this file.
"},{"location":"guides/manually-editing-the-stash-sqlite3-database/#examples","title":"Examples","text":""},{"location":"guides/manually-editing-the-stash-sqlite3-database/#deleting-all-tags","title":"Deleting all tags","text":"cd ~/.stash\nsqlite3 stash-go.sqlite\nIf you need to delete all tags, you can use the following commands:
sqlite> DELETE FROM scenes_tags;\nsqlite> DELETE FROM tags;\nNote
This will not work if you have Scene marker tags.
"},{"location":"guides/reverse-proxy/","title":"Reverse proxy","text":"The use of a reverse proxy for Stash is possible.
"},{"location":"guides/reverse-proxy/#general","title":"General","text":"Generally, the following headers will need to be set (check your proxy's documentation for how to configure).
- Host (http host)
- X-Real-IP
- X-Forwarded-For
- X-Forwarded-Proto
See issue 134 for more information.
"},{"location":"guides/reverse-proxy/#using-a-url-prefix","title":"Using a URL prefix","text":"Stash also supports running under a URL prefix, in which case the the
"},{"location":"guides/reverse-proxy/#setting-external-url","title":"Setting External URL","text":"X-Forwarded-Prefixheader must also be set. The proxy also needs to remove the prefix from the requested URLs. For example, if you want your homepage to be accessible athttp://example.domain.com/stash, then you need to setX-Forwarded-Prefix: /stash.You can also set the host that will be served by Stash manually by adding an
external_host:setting in your Stash config.yml and assigning it the publicly accessible hostname, including thehttp://orhttps://.X-Forwarded-Prefixwill still need to be set if using a prefix.
"},{"location":"guides/reverse-proxy/#server-configuration-examples","title":"Server Configuration Examples","text":""},{"location":"guides/reverse-proxy/#nginx","title":"Nginx","text":"external_host: http://example.domain.com\n
"},{"location":"guides/reverse-proxy/#nginx-docker-linuxserver-letsencrypt","title":"Nginx + Docker (Linuxserver Letsencrypt)","text":"location / {\n proxy_pass http://127.0.0.1:9999;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_read_timeout 60000s;\n}\nIf you are using the linuxserver letencrypt docker you can use create a
stash.subdomain.conffile in yourproxy-confsfolder and use this as the config:
"},{"location":"guides/reverse-proxy/#nginx-with-prefix","title":"Nginx with prefix","text":"# make sure that your dns has a cname set for stash\n\nserver {\n listen 443 ssl;\n listen [::]:443 ssl;\n\n server_name stash.*;\n\n include /config/nginx/ssl.conf;\n\n client_max_body_size 0;\n\n # enable for ldap auth, fill in ldap details in ldap.conf\n #include /config/nginx/ldap.conf;\n\n location / {\n # enable the next two lines for http auth\n #auth_basic \"Restricted\";\n #auth_basic_user_file /config/nginx/.htpasswd;\n\n # enable the next two lines for ldap auth\n #auth_request /auth;\n #error_page 401 =200 /login;\n\n include /config/nginx/proxy.conf;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n resolver 127.0.0.11 valid=30s;\n set $upstream_app stash;\n set $upstream_port 9999;\n set $upstream_proto http;\n proxy_pass $upstream_proto://$upstream_app:$upstream_port;\n proxy_set_header Host $http_host;\n proxy_read_timeout 60000s;\n }\n}\nAn example for
nginxusing the prefix/stash:
"},{"location":"guides/reverse-proxy/#nginx-with-external_host","title":"Nginx with external_host","text":"location /stash/ {\n # Notice the trailing slash - this causes nginx to remove the /stash prefix from requested URLs\n proxy_pass http://192.168.0.1:9999/;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"Upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Port $server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header X-Forwarded-Prefix /stash;\n proxy_read_timeout 60000s;\n}\nAnother example for
nginx:In this case we are using
stash.homeas our domain and192.168.0.1is stash's ip so edit acccordingly.The
external_hostconfiguration option should also be set, in this caseexternal_host: http://stash.home. Refer to external_host for more details.
"},{"location":"guides/reverse-proxy/#apache","title":"Apache","text":"server {\n listen 80;\n listen [::]:80;\n\n server_name stash.home;\n client_max_body_size 0;\n\n location / {\n proxy_pass http://192.168.0.1:9999;\n\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"Upgrade\";\n proxy_set_header Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Port $server_port;\n proxy_set_header X-Forwarded-Proto $scheme;\n }\n}\n
"},{"location":"guides/reverse-proxy/#prerequisites","title":"Prerequisites","text":"# if using apache < 2.4.47, remove upgrade=websocket\nProxyPass \"/stash\" \"http://127.0.0.1:9999\" upgrade=websocket\nProxyPassReverse \"/stash\" \"http://127.0.0.1:9999\"\nRequestHeader setIfEmpty X-Forwarded-Prefix \"/stash\"\nProxyPreserveHost on\n\n# for name resolution\nServerAdmin admin@example.com\nServerName example.com\nServerAlias stash.example.com\n\n# to enable websockets for apache < 2.4.47\n#RewriteEngine on\n#RewriteCond %{HTTP:Upgrade} websocket [NC]\n#RewriteCond %{HTTP:Connection} upgrade [NC]\n#RewriteRule ^/?stash/(.*) \"ws://127.0.0.1:9999/$1\" [P,L]\n\n# to add SSL\nSSLEngine on\nSSLCertificateFile /path/to/cert.pem\nSSLCertificateKeyFile /path/to/cert.key\n
"},{"location":"guides/reverse-proxy/#caddy-v2","title":"Caddy v2","text":"sudo a2enmod proxy\nsudo a2enmod proxy_http\nsudo a2enmod proxy_balancer\nsudo a2enmod lbmethod_byrequests\n\nsudo a2enmod rewrite\nsudo a2enmod headers\n\n# for SSL\nsudo a2enmod ssl\nstash.example.com {\n reverse_proxy 127.0.0.1:9999 {\n header_up Host {host}\n header_up X-Real-IP {remote_host}\n header_up X-Forwarded-Port {server_port}\n }\n}\nThe
"},{"location":"guides/reverse-proxy/#troubleshooting","title":"Troubleshooting","text":""},{"location":"guides/reverse-proxy/#504-errors","title":"504 Errors","text":"external_hostconfiguration option should also be set, in this caseexternal_host: http://stash.home. Refer to external_host for more details.- In some cases with big database files you might encounter
504errors during stash db migration due to timeout. Adjusting theproxy_read_timeoutvalue (proxy.conffile in Letencrypt/Swag docker container)
- In order for the websocket to work, you may need to also add these lines to your server block (
proxy.conffile in the Letencrypt Unraid docker container for instance) as mentioned here should fix the issue.
"},{"location":"guides/reverse-proxy/#cloudflare-tunnel","title":"Cloudflare Tunnel","text":"proxy_http_version 1.1;\nproxy_set_header Upgrade $http_upgrade;\nproxy_set_header Connection \"upgrade\";\nCloudflare Tunnels are not recommended since they throttle non-HTML traffic (which video falls under).
See Cloudflare blog post for more details.
"},{"location":"guides/run-cdp-on-truenas-scale/","title":"Run CDP on TrueNAS Scale","text":"Info
Written by WiiGe. Originally posted on stashapp/stash discussions1.
A way to use CDP scraper on TrueNAS Scale and install chromedp/headless-shell on TrueNAS Scale.
People using stash-app on TrueNAS Scale like me may face the problem that no supported CDP app by truecharts or truenas , and now I found a way to properly run chromedp/headless-shell.
This can be done by custom-app.
According to docker hub page of chromedp/headless-shell, we start container with
docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell, but this's not enough for TrueNAS Scale which run everything with K3s.In order to run a docker image on K3s, we need to warp docker image with custom-app, fill the Container Repository with
chromedp/headless-shelland Container Tag withlatestso that TrueNAS can pull the image for you.As for the docker args
docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell, we need to translate the args and env parameter into custom-app configuration. Under the Workload Settings section of custom-app configuration page, there will be a list of Extra Args, we put--name headless-shell --shm-size 2Ghere in custom-app way.But due to this issue, K3s will report an error of zygote:
ERROR:zygote_host_impl_linux.cc(262)] Failed to adjust OOM score of renderer with pid 28: Permission denied (13), solution is simple - just offer extra args to disable it :--headless --disable-gpu --no-sandbox --no-zygote --disable-software-rasterizer --disable-dev-shm-usage.--remote-debugging-address=0.0.0.0 --remote-debugging-port=9222is not needed because we will set port and ip on Networking and Services section for LoadBalancer (I am using 192.168.1.45 and 9222, change it for your own scenario).The Networking section and the final Extra Args page should be like this:
and click Install button then your headless-shell will be good to go.
The last step: just fill stash's CDP setting with
http://192.168.1.45:9222/json/version(still, change ip:port for your own scenario), and now cdp should be running for you.An extra note is Ingress section of custom-app, you may want to use chromedp/headless-shell remotely (e.g. accessing cdp by https://cdp.example.com/json/version), you need to modify the header of request with SetHeader function, see Host header is specified and is not an IP address or localhost. Obviously stash scraper do not support such operation, write your own scraper in this circumstances.
I just put the info I found together and share here, hope this page help more people who try to use CDP scraper on K3s-based OS.
-
https://github.com/stashapp/stash/discussions/4719 \u21a9
A regular scraper can only scrape information from webpages that are open to the public access. If you want to scrape a webpage that requires login or behind a paywall, you need to use the \"Visible CDP\" technique.
Normal CDP scraping will launch a headless chrome browser, which will not show up for any user interactions. \"Visible CDP\" turns the \"headless chrome\" into a \"visible\" instance.
- Prepare your scraper's .yml file and make sure it's valid and working. Your scraper should have the following setting inside:
driver:\n useCDP: true\n - Run a command console. Go to the Chrome's binary directory and run
chrome.exe --remote-debugging-port=9222. This will launch a special Chrome instance that Stash Scrapers can control later on. - In Stash, make sure that the Settings > Metadata Providers > Scraping > Chrome CDP Path is set to
http://localhost:9222/json/version. - Use the special Chrome instance you launched earlier, go to the webpage you want to scrape, type in your user/pass or pass any other human tests, until you see the page with desired content.
- Paste the webpage's URL in your Stash scene and start scraping. It should get the information correctly.
stash-box is an open-source video indexing and metadata API server for porn developed by Stash team. It provides a crowdsourced database of metadata for adult performers, studios and scenes.
Stash has several ways to scrape from stash-box instances. From automatic to manual. Each has its own advantages and disadvantages.
- Tagger (recommended) - partially automatic, great accuracy
- Identify - fully automatic, mediocre accuracy
- Scrape with... - fully manual, great accuracy
- Go to Settings > Tasks.
- Under Library header you will find configuration options for Scan task and Generate task.
- Enable Generate perceptual hashes under Scan header.
- Enable Perceptual hashes under Generate header.
Scan task and its options are applied when the content is being added to the database the first time.
Generate task and its options are applied when you want to generate additional things for content that is already in your database.
"},{"location":"guides/scraping-scenes-via-stash-box/#configure-stash-box-endpoint","title":"Configure stash-box endpoint","text":"Known stash-box instances
A list of public stash-box instances is available here.
- Go to Settings > Metadata Providers.
- Under Stash-box Endpoints header click Add and include the details of the stash-box instance you want to add.
- Click Test Credentials to make sure everything is correct.
Recommended to people that value accuracy the most. It can automatically go through scenes and match them based on perceptual hash, but object creation and verification is left to you and nothing is saved until you click Save.
- Open Scenes page.
- Click on display mode selector in the toolbar.
- Set it to Tagger.
- Under Source select a stash-box instance you want to use.
-
Opposite the Source click on the to open configuration.
- You can enable Show male performers if you want them to be scraped for you locally.
- You can disable Set scene cover image if you prefer to keep your existing cover.
- You can enable Set tags if you want to be shown all the crowdsourced tags the scene has on the stash-box instance.
-
You can enable Mark as Organized on save which will apply Organized flag.
Organized flagOrganized flag has a technical purpose in addition to being able to be used in a filter. All objects marked as organized will be ignored by automatic tasks like Identify and Auto Tag.
-
Click on Scrape All and look through the results. Add missing objects and click Save.
- If you got returned No results found, you can try using query method. You can enter title, performer, release date, or studio and click Search. Keep in mind that sometimes fewer details, are better.
- If you know the scene exists on that stash-box instance, but it wasn't found, you can input the exact StashID in the Query field, click Search and it will return that exact scene.
-
For scenes that you clicked Save on, you can submit your file fingerprints (hashes) back to the instance to help improve the accuracy. Scroll to the top and click Submit x fingerprints.
FingerprintsAll fingerprints are tied to the user API key, no other information is sent to the stash-box instance. Privacy is paramount.
For people that want fully automatic option and don't mind some potential inaccuracies. The task will automatically go through all scenes and match them based on perceptual hash. You can also create all missing objects automatically. No manual verification is possible.
Warning
Task is irreversible, so it's a good idea to make a backup before running it.
- Go to Settings and enable Advanced Mode.
- Go to Settings > Tasks.
- Under Library header click on Identify....
-
Under Sources select a stash-box instance(s) you want to match against.
Info
Identify task iterates through sources until it finds a match, once it finds a match, it will ignore all other sources for that scene.
-
Configure default options that will apply to all sources (they can be overwritten for individual sources by clicking next to each source).
- You can disable Show male performers if you don't want them to be scraped for you locally.
- You can disable Set scene cover image if you prefer to keep your existing cover.
- You can enable Set organized flag which will apply Organized flag.
- You can disable Skip matches that have more than one result if you don't mind potentially getting more mismatched results. If enabled, it can also be tagged with a custom tag to let you know which scenes were skipped.
- You can disable Skip single name performers with no disambiguation if you don't mind potentially getting more mismatched results. If enabled, it can also be tagged with a custom tag to let you know which scenes were skipped.
- Click Set as default to save your configuration.
- Configure default field options that will apply to all sources (they can be overwritten for individual sources by clicking next to each source).
- Click Set as default to save your configuration.
- Click Identify to start the task.
In addition to previous methods, there is also a completely manual way to match scenes individually.
- Go to a scene you want to match.
- Click on the Edit tab.
- Click Scrape with... and select a stash-box instance you want to match against.
- Check the return results, create missing objects and click Apply.
- Click Save.
You can use the ffprobe command to gather useful information about a video file:
ffprobe -show_format -show_streams big_buck_bunny.mkv\nThis can be useful for example, when filing bug reports, or discussing in chat.
"},{"location":"guides/troubleshooting-video-playback/#remuxing-files","title":"Remuxing files","text":"Another good test, is to see if remuxing the file into a new video file helps:
"},{"location":"guides/troubleshooting-video-playback/#extracting-a-sample-of-a-video","title":"Extracting a sample of a video","text":"ffmpeg -i big_buck_bunny.mkv -c:v copy -c:a copy remuxed_file.mkv\nIf you are asked for a sample of a video (e.g. for developers to analyse), you can use
ffmpeg -ss 120 -i big_buck_bunny.mkv -t 30 -c:v copy -c:a copy 30_second_sample.mkv\nThe above command starts at the 120-second marker, and takes a 30-second sample of the video file.
"},{"location":"in-app-manual/","title":"In-app manual","text":"Info
Stash internal help manual, mirrored from stashapp/stash/ui/v2.5/src/docs/en/Manual.
Internal links will be broken as a result, but will work correctly when browsing the Help section inside Stash.
"},{"location":"in-app-manual/browsing/","title":"Browsing","text":""},{"location":"in-app-manual/browsing/#browsing","title":"Browsing","text":""},{"location":"in-app-manual/browsing/#querying-and-filtering","title":"Querying and Filtering","text":""},{"location":"in-app-manual/browsing/#keyword-searching","title":"Keyword searching","text":"The text field allows you to search using keywords. Keyword searching matches on different fields depending on the object type:
Type Fields searched Scene Title, Details, Path, OSHash, Checksum, Marker titles Image Title, Path, Checksum Group Title Marker Title, Scene title Gallery Title, Path, Checksum Performer Name, Aliases Studio Name, Aliases Tag Name, AliasesKeyword matching uses the following rules:
- all words are required in the matching field. For example,
foo barmatches scenes with bothfooandbarin the title. - the
orkeyword or symbol (|) is used to match either fields. For example,foo or bar(orfoo | bar) matches scenes withfooorbarin the title. Or sets can be combined. For example,foo or bar or baz xyz or zyxmatches scenes with one offoo,barandbaz, andxyzorzyx. - the not symbol (
-) is used to exclude terms. For example,foo -barmatches scenes withfooand excludes those withbar. The not symbol cannot be combined with an or operand. That is,-foo or barwill be interpreted to match-fooorbar. On the other hand,foo or bar -bazwill matchfooorbarand excludebaz. - surrounding a phrase in quotes (
\") matches on that exact phrase. For example,\"foo bar\"matches scenes withfoo barin the title. Quotes may also be used to escape the keywords and symbols. For example,foo \"-bar\"will match scenes withfooand-bar. - quoted phrases may be used with the or and not operators. For example,
\"foo bar\" or baz -\"xyz zyx\"will match scenes withfoo barorbaz, and exclude those withxyz zyx. orkeywords or symbols at the start or end of a line will be treated literally. That is,or foowill match scenes withorandfoo.- all keyword matching is case-insensitive
Filters can be accessed by clicking the filter button on the right side of the query text field.
Note that only one filter criterion per criterion type may be assigned.
"},{"location":"in-app-manual/browsing/#regex-modifiers","title":"Regex modifiers","text":"Some filters have regex modifier as an option. Regex modifiers are case-sensitive by default.
"},{"location":"in-app-manual/browsing/#sorting-and-page-size","title":"Sorting and page size","text":"The current sorting field is shown next to the query text field, indicating the current sort field and order. The page size dropdown allows selecting from a standard set of objects per page, and allows setting a custom page size.
"},{"location":"in-app-manual/browsing/#saved-filters","title":"Saved filters","text":"Saved filters can be accessed with the bookmark button on the left of the query text field. The current filter can be saved by entering a filter name and clicking on the save button. Existing saved filters may be overwritten with the current filter by clicking on the save button next to the filter name. Saved filters may also be deleted by pressing the delete button next to the filter name.
Saved filters are sorted alphabetically by title with capitalized titles sorted first.
"},{"location":"in-app-manual/browsing/#default-filter","title":"Default filter","text":"The default filter for the top-level pages may be set to the current filter by clicking the
"},{"location":"in-app-manual/captions/","title":"Captions","text":""},{"location":"in-app-manual/captions/#captions","title":"Captions","text":"Set as defaultbutton in the saved filter menu.Stash supports captioning with SRT and VTT files.
Captions will only be detected if they are located in the same folder as the corresponding scene file.
Ensure the caption files follow these naming conventions:
"},{"location":"in-app-manual/captions/#scene","title":"Scene","text":"- {scene_file_name}.{language_code}.ext
- {scene_file_name}.ext
Where
{language_code}is defined by the ISO-6399-1 (2 letters) standard andextis the file extension. Captions files without a language code will be labeled as Unknown in the video player but will work fine.Scenes with captions can be filtered with the
captionscriterion.Note: If the caption file was added after the scene was initially added during scan, you will need to run a Selective Scan task for it to show up.
"},{"location":"in-app-manual/configuration/","title":"Configuration","text":""},{"location":"in-app-manual/configuration/#configuration","title":"Configuration","text":""},{"location":"in-app-manual/configuration/#library","title":"Library","text":"This section allows you to add and remove directories from your library list. Files in these directories will be included when scanning. Files that are outside of these directories will be removed when running the Clean task.
\u26a0\ufe0f Note: Don't forget to click
"},{"location":"in-app-manual/configuration/#excluded-patterns","title":"Excluded patterns","text":"Saveafter updating these directories!Given a valid regex, files that match even partially are excluded during the Scan process and are not entered in the database. Also during the Clean task if these files exist in the DB they are removed from it and their generated files get deleted. Prior to matching both the filenames and patterns are converted to lower case so the match is case insensitive.
Regex patterns can be added in the config file or from the UI. If you add manually to the config file a restart is needed while from the UI you just need to click the Save button. When added through the config file directly special care must be given to double escape the
\\character.There are 2 separate exclusion settings. One is for videos, another is for images/galleries.
Some examples:
\"sample\\.mp4$\"will exclude all files ending insample.mp4.\"/\\.[[:word:]]+/\"will exclude all hidden directories like/.directoryname/.\"c:\\\\stash\\\\videos\\\\exclude\"will exclude specific Windows directoryc:\\stash\\videos\\exclude.\"^/stash/videos/exclude/\"will exclude all directories that match/stash/videos/exclude/pattern.\"\\\\\\\\stash\\\\network\\\\share\\\\excl\\\\\"will exclude specific Windows network path\\\\stash\\network\\share\\excl\\.
Note: If a directory is excluded for images and videos, then the directory will be excluded from scans completely.
There is a useful regex101 site that can help test and experiment with regexps.
"},{"location":"in-app-manual/configuration/#gallery-creation-from-folders","title":"Gallery creation from folders","text":"In the Library section you can find an option to create a gallery from each folder containing images. This will be applied on all libraries when activated, including the base folder of a library.
If you wish to apply this on a per folder basis, you can create a file called .nogallery or .forcegallery in a folder that should act different than this global setting.
This will either exclude the folder from becoming a gallery even if the setting is set, or create a gallery from the folder even if the setting is not set.
The file will only be recognized if written in lower case letters.
Files with a dot in front are handled as hidden in the Linux OS and Mac OS, so you will not see those files after creation on your system without setting your file manager accordingly.
"},{"location":"in-app-manual/configuration/#hashing-algorithms","title":"Hashing algorithms","text":"Stash identifies video files by calculating a hash of the file. There are two algorithms available for hashing:
oshashandMD5.MD5requires reading the entire file, and can therefore be slow, particularly when reading files over a network.oshash(which uses OpenSubtitle's hashing algorithm) only reads 64k from each end of the file.The hash is used to name the generated files such as preview images and videos, and sprite images.
By default, new systems have MD5 calculation disabled for optimal performance. Existing systems that are upgraded will have the oshash populated for each scene on the next scan.
"},{"location":"in-app-manual/configuration/#changing-the-hashing-algorithm","title":"Changing the hashing algorithm","text":"To change the file naming hash to oshash, all scenes must have their oshash values populated. oshash population is done automatically when scanning.
To change the file naming hash to
MD5, the MD5 must be populated for all scenes. To do this,Calculate MD5for videos must be enabled and the library must be rescanned.MD5 calculation may only be disabled if the file naming hash is set to
oshash.After changing the file naming hash, any existing generated files will now be named incorrectly. This means that stash will not find them and may regenerate them if the
"},{"location":"in-app-manual/configuration/#step-by-step-instructions-to-migrate-to-oshash-for-existing-users","title":"Step-by-step instructions to migrate to oshash for existing users","text":"Generate taskis used. To remedy this, run theRename generated filestask, which will rename existing generated files to their correct names.These instructions are for existing users whose systems will be defaulted to use and calculate MD5 checksums. Once completed, MD5 checksums will no longer be calculated when scanning, and oshash will be used for generated file naming. Existing calculated MD5 checksums will remain on scenes, but checksums will not be calculated for new scenes.
- Scan the library (to populate oshash for all existing scenes).
- In Settings -> System page, untick
Calculate MD5and selectoshashas file naming hash. Save the configuration. - In Settings -> Tasks page, click on the
Rename generated filesmigration button.
This setting controls how many sub-tasks will be run in parallel during scanning and generation tasks. (See Tasks)
Auto-detection can be enabled by setting this to zero. This will calculate the number of parallel tasks to be logical cores/4 + 1.
This setting can be used to increase/decrease overall CPU utilisation in two scenarios:
- High performance 4+ core cpus.
- Media files stored on remote/cloud filesystem.
Note: If this is set too high it will decrease overall performance and causes failures (out of memory).
"},{"location":"in-app-manual/configuration/#hardware-accelerated-live-transcoding","title":"Hardware accelerated live transcoding","text":"Hardware accelerated live transcoding can be enabled by setting the
"},{"location":"in-app-manual/configuration/#hlsdash-streaming","title":"HLS/DASH streaming","text":"FFmpeg hardware encodingsetting. Stash outputs the supported hardware encoders to the log file on startup at the Info log level. If a given hardware encoder is not supported, it's error message is logged to the Debug log level for debugging purposes.To stream using HLS (such as on Apple devices) or DASH, the Cache path must be set. This directory is used to store temporary files during the live-transcoding process. The Cache path can be set in the System settings page.
"},{"location":"in-app-manual/configuration/#ffmpeg-arguments","title":"ffmpeg arguments","text":"Additional arguments can be injected into ffmpeg when generating previews and sprites, and when live-transcoding videos.
The ffmpeg arguments configuration is split into
InputandOutputarguments. Input arguments are injected before the input file argument, and output arguments are injected before the output file argument.Arguments are accepted as a list of strings. Each string is a separate argument. For example, a single argument of
"},{"location":"in-app-manual/configuration/#scraping","title":"Scraping","text":""},{"location":"in-app-manual/configuration/#user-agent-string","title":"User Agent string","text":"-foo barwould be treated as a single argument\"-foo bar\". The correct way to pass this argument would be to split it into two separate arguments:\"-foo\", \"bar\".Some websites require a legitimate User-Agent string when receiving requests, or they will be rejected. If entered, this string will be applied as the
"},{"location":"in-app-manual/configuration/#chrome-cdp-path","title":"Chrome CDP path","text":"User-Agentheader value in http scrape requests.Some scrapers require a Chrome instance to function correctly. If left empty, stash will attempt to find the Chrome executable in the path environment, and will fail if it cannot find one.
Chrome CDP pathcan be set to a path to the chrome executable, or an http(s) address to remote chrome instance (for example:http://localhost:9222/json/version).Important: As of Chrome 136 you need to specify
"},{"location":"in-app-manual/configuration/#authentication","title":"Authentication","text":"--user-data-diralongside--remote-debugging-port. Read more on their official post.By default, stash is not configured with any sort of password protection. To enable password protection, both
"},{"location":"in-app-manual/configuration/#api-key","title":"API key","text":"UsernameandPasswordmust be populated. Note that when entering a new username and password where none was set previously, the system will immediately request these credentials to log you in.If password protection is enabled, you may also generate an API key. An API key is used by external systems to access your stash system without needing to login first.
External systems using the API key must set the
"},{"location":"in-app-manual/configuration/#logging-out","title":"Logging out","text":"ApiKeyheader value to the configured API key in order to bypass the login requirement.The logout button is situated in the upper-right part of the screen when you are logged in.
"},{"location":"in-app-manual/configuration/#recovering-from-a-forgotten-username-or-password","title":"Recovering from a forgotten username or password","text":"Stash saves login credentials in the config.yml file. You must reset both login and password if you have forgotten your password by doing the following:
- Close your Stash process
- Open the
config.ymlfile found in your Stash directory with a text editor - Delete the
usernameandpasswordlines from the file and save
Stash authentication should now be reset with no authentication credentials.
"},{"location":"in-app-manual/configuration/#advanced-configuration-options","title":"Advanced configuration options","text":"These options are typically not exposed in the UI and must be changed manually in the
Field Remarksconfig.ymlfile.custom_served_foldersA map of URLs to file system folders. See below.custom_ui_locationThe file system folder where the UI files will be served from, instead of using the embedded UI. Empty to disable. Stash must be restarted to take effect.developer_options.extra_blob_pathsA list of alternative blob paths. These paths will be read for blob files. Blobs will not be written or deleted from these paths. Intended for developer use only.max_upload_sizeMaximum file upload size for import files. Defaults to 1GB.theme_colorSets thetheme-colorproperty in the UI.gallery_cover_regexThe regex responsible for selecting images as gallery coversproxyThe url of a HTTP(S) proxy to be used when stash makes calls to online services. Example: https://user:password@my.proxy:8080. Note: SOCKS5 proxies are unsupported.no_proxyA list of domains for which the proxy must not be used. Default is all local LAN: localhost,127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12sequential_scanningModifies behaviour of the scanning functionality to generate support files (previews/sprites/phash) at the same time as fingerprinting/screenshotting. Useful when scanning cached remote files.The following environment variables are also supported:
Environment variable RemarksSTASH_SQLITE_CACHE_SIZESets the SQLite cache size. See https://www.sqlite.org/pragma.html#pragma_cache_size. Default is-2000which is 2MB."},{"location":"in-app-manual/configuration/#custom-served-folders","title":"Custom served folders","text":"Custom served folders are served when the server handles a request with the
/customURL prefix. The following is an example configuration:custom_served_folders:\n /: D:\\stash\\static\n /foo: D:\\bar\nWith the above configuration, a request for
/custom/foo/bar.pngwould serveD:\\bar\\bar.png.The
"},{"location":"in-app-manual/contributing/","title":"Ways to contribute","text":""},{"location":"in-app-manual/contributing/#ways-to-contribute","title":"Ways to contribute","text":""},{"location":"in-app-manual/contributing/#financial","title":"Financial","text":"/entry matches anything that is not otherwise mapped by the other entries. For example,/custom/baz/xyz.pngwould serveD:\\stash\\static\\baz\\xyz.png.Financial contributions are welcomed and are accepted using Open Collective.
"},{"location":"in-app-manual/contributing/#development-related","title":"Development-related","text":"The Stash backend is written in Go, using a SQLite database. The UI is written in Typescript, using React. Bug fixes, improvements and new features are welcomed. Please see the DEVELOPMENT.md file for details on how to get started. Assistance is available via our Discord.
"},{"location":"in-app-manual/contributing/#documentation","title":"Documentation","text":"Efforts to improve documentation in Stash helps new users and reduces the number of questions we have to field in Discord. Contributions to documentation are welcomed. While submitting documentation changes via GitHub pull requests is ideal, we will gladly accept submissions via GitHub issues or on Discord.
For those with web page experience, we also welcome contributions to our website (which as of writing is very undeveloped).
"},{"location":"in-app-manual/contributing/#testing-features-improvements-and-bug-fixes","title":"Testing features, improvements and bug fixes","text":"Testing is currently covered by a very small group, so new testers are welcomed. Being able to build Stash locally is ideal, but binaries for pull requests are also available.
First, you will need to be signed in to GitHub. Find and open the relevant pull request, and then click on the
"},{"location":"in-app-manual/contributing/#submitting-and-contributing-to-bug-reports-improvements-and-new-features","title":"Submitting and contributing to bug reports, improvements and new features","text":"Checkstab. On the right, there should be a button titledArtifacts- click that, and you should get a dropdown with links to download binaries built from that pull request for Linux, Windows and macOS.We welcome ideas for future improvements and features, and bug reports help everyone. These can all be found on GitHub.
"},{"location":"in-app-manual/contributing/#providing-support","title":"Providing support","text":"Offering support for new users on our Community forum and Discord is also welcomed.
"},{"location":"in-app-manual/deduplication/","title":"Dupe checker","text":""},{"location":"in-app-manual/deduplication/#dupe-checker","title":"Dupe Checker","text":"The dupe checker searches your collection for scenes that are perceptually similar. This means that the files don't need to be identical, and will be identified even with different bitrates, resolutions, and intros/outros.
To achieve this stash needs to generate what's called a phash, or perceptual hash. Similar to sprite generation stash will generate a set of 25 images from fixed points in the scene. These images will be stitched together, and then hashed using the phash algorithm. The phash can then be used to find scenes that are the same or similar to others in the database. Phash generation can be run during scan, or as a separate task. Note that generation can take a while due to the work involved with extracting screenshots.
The dupe checker can be run with four different levels of accuracy.
Exactlooks for scenes that have exactly the same phash. This is a fast and accurate operation that should not yield any false positives except in very rare cases. The other accuracy levels look for duplicate files within a set distance of each other. This means the scenes don't have exactly the same phash, but are very similar.HighandMediumshould still yield very good results with few or no false positives.Lowis likely to produce some false positives, but might still be useful for finding dupes.Note that to generate a phash stash requires an uncorrupted file. If any errors are encountered during sprite generation the phash will not be generated. This is to prevent false positives.
"},{"location":"in-app-manual/images/","title":"Images and galleries","text":""},{"location":"in-app-manual/images/#images-and-galleries","title":"Images and Galleries","text":"Images are the parts which make up galleries, but you can also have them be scanned independently. To declare an image part of a gallery, there are four ways:
- Group them in a folder together and activate the Create galleries from folders containing images option in the library section of your settings. The gallery will get the name of the folder.
- Group them in a folder together and create a file in the folder called .forcegallery. The gallery will get the name of the folder.
- Group them into a zip archive together. The gallery will get the name of the archive.
- You can simply create a gallery in stash itself by clicking on New in the Galleries tab.
You can add images to every gallery manually in the gallery detail page. Deleting can be done by selecting the according images in the same view and clicking on the minus next to the edit button.
For best results, images in zip file should be stored without compression (copy, store or no compression options depending on the software you use. Eg on linux:
zip -0 -r gallery.zip foldertozip/). This impacts heavily on the zip read performance.If a filename of an image in the gallery zip file ends with
cover.jpg, it will be treated like a cover and presented first in the gallery view page and as a gallery cover in the gallery list view. If more than one images match the name the first one found in natural sort order is selected.You can also manually select any image from a gallery as its cover. On the gallery details page, select the desired cover image, and then select Set as Cover in the \u22ef menu.
"},{"location":"in-app-manual/images/#image-clipsgifs","title":"Image clips/gifs","text":"Images can also be clips/gifs. These are meant to be short video loops. Right now they are not possible in zipfiles. To declare video files to be images, there are two ways:
- Deactivate video scanning for all libraries that contain clips/gifs, but keep image scanning active. Set the Scan Video Extensions as Image Clip option in the library section of your settings.
- Make sure none of the file endings used by your clips/gifs are present in the Video Extensions and add them to the Image Extensions in the library section of your settings.
A clip/gif will be a stillframe in the wall and grid view by default. To view the loop, you can go into the Lightbox Carousel (e.g. by clicking on an image in the wall view) or the image detail page.
If you want the loop to be used as a preview on the wall and grid view, you will have to generate them. You can do this as you scan for the new clip file by activating Generate previews for image clips on the scan settings, or do it after by going to the Generated Content section in the task section of your settings, activating Image Clip Previews and clicking generate. This takes a while, as the files are transcoded.
"},{"location":"in-app-manual/interactive/","title":"Interactivity","text":""},{"location":"in-app-manual/interactive/#interactivity","title":"Interactivity","text":"Stash currently supports syncing with Handy devices, using funscript files.
In order for stash to connect to your Handy device, the Handy Connection Key must be entered in Settings -> Interface.
Funscript files must be in the same directory as the matching video file and must have the same base name. For example, a funscript file for
video.mp4must be namedvideo.funscript. A scan must be run to update scenes with matching funscript files.Scenes with funscript files can be filtered with the
"},{"location":"in-app-manual/interface/","title":"Interface options","text":""},{"location":"in-app-manual/interface/#interface-options","title":"Interface Options","text":""},{"location":"in-app-manual/interface/#language","title":"Language","text":"interactivecriterion.Setting the language affects the formatting of numbers and dates.
"},{"location":"in-app-manual/interface/#scenemarker-wall-preview-type","title":"Scene/Marker Wall Preview Type","text":"The Scene Wall and Marker pages display scene preview videos (mp4) by default. This can be changed to animated image (webp) or static image.
\u26a0\ufe0f Note: scene/marker preview videos must be generated to see them in the applicable wall page if Video preview type is selected. Likewise, if Animated Image is selected, then Image Previews must be generated.
"},{"location":"in-app-manual/interface/#show-studios-as-text","title":"Show Studios as text","text":"By default, a scene's studio will be shown as an image overlay. Checking this option changes this to display studios as a text name instead.
"},{"location":"in-app-manual/interface/#scene-player-options","title":"Scene Player options","text":"By default, scene videos do not automatically start when navigating to the scenes page. Checking the \"Auto-start video\" option changes this to auto play scene videos.
The maximum loop duration option allows looping of shorter videos. Set this value to the maximum scene duration that scene videos should loop. Setting this to 0 disables this functionality.
"},{"location":"in-app-manual/interface/#activity-tracking","title":"Activity tracking","text":"The \"Track Activity\" option allows tracking of scene play count and duration, and sets the resume point when a scene video is not finished.
The \"Minimum Play Percent\" gives the minimum proportion of a video that must be played before the play count of the scene is incremented.
By default, when a scene has a resume point, the scene player will automatically seek to this point when the scene is played. Setting \"Always start video from beginning\" to true disables this behaviour.
"},{"location":"in-app-manual/interface/#custom-css","title":"Custom CSS","text":"The stash UI can be customised using custom CSS. See here for a community-curated set of CSS snippets to customise your UI.
There is also a collection of community-created themes available.
"},{"location":"in-app-manual/interface/#custom-javascript","title":"Custom Javascript","text":"Stash supports the injection of custom javascript to assist with theming or adding additional functionality. Be aware that bad Javascript could break the UI or worse.
"},{"location":"in-app-manual/interface/#custom-locales","title":"Custom Locales","text":"The localisation strings can be customised. The master list of default (en-GB) locale strings can be found here. The custom locale format is the same as this json file.
For example, to override the
actions.add_directorylabel (which isAdd Directoryby default), you would have the following in the custom locale:
"},{"location":"in-app-manual/interface/#custom-served-folders","title":"Custom served folders","text":"{\n \"actions\": {\n \"add_directory\": \"Some other description\"\n }\n}\nIt is possible to expose specific folders to the UI. This configuration is performed manually in the
config.ymlfile only.Custom served content is exposed via the
/customURL path prefix.For example, in the
config.ymlfile:custom_served_folders:\n /: D:\\stash\\static\n /foo: D:\\bar\nWith the above configuration, a request for
/custom/foo/bar.pngwould returnD:\\bar\\bar.png. The/entry matches anything that is not otherwise mapped by the other entries. For example,/custom/baz/xyz.pngwould returnD:\\stash\\static\\baz\\xyz.png.Applications for this include using static images in custom css, like the Plex theme. For example, using the following config:
custom_served_folders:\n /: <stash folder>\\custom\nThe
background.pngandnoise.pngfiles can be placed in thecustomfolder, then in the custom css, the./background.pngand./noise.pngstrings can be replaced with/custom/background.pngand/custom/noise.pngrespectively.Other applications are to add custom UIs to stash, accessible via
"},{"location":"in-app-manual/introduction/","title":"Introduction","text":""},{"location":"in-app-manual/introduction/#introduction","title":"Introduction","text":"/custom.Stash works by cataloging your media using the paths that you provide. Once you have configured the locations where your media is stored, you can click the Scan button in
Settings -> Tasksand stash will begin scanning and importing your media into its library.For the best experience, it is recommended that after a scan is finished, that video previews and sprites are generated. You can do this in
Settings -> Tasks. Note that currently it is only possible to perform one task at a time and but there is a task queue, so the generate tasks should be performed after scan is complete.Once your media is imported, you are ready to begin creating Performers, Studios and Tags, and curating your content!
"},{"location":"in-app-manual/keyboardshortcuts/","title":"Keyboard shortcuts","text":""},{"location":"in-app-manual/keyboardshortcuts/#keyboard-shortcuts","title":"Keyboard Shortcuts","text":""},{"location":"in-app-manual/keyboardshortcuts/#global-shortcuts","title":"Global shortcuts","text":"Keyboard sequence Action?Display manual"},{"location":"in-app-manual/keyboardshortcuts/#global-navigation","title":"Global Navigation","text":"Keyboard sequence Target pageg sScenesg iImagesg vGroupsg kMarkersg lGalleriesg pPerformersg uStudiosg tTagsg zSettings"},{"location":"in-app-manual/keyboardshortcuts/#query-page-shortcuts","title":"Query page shortcuts","text":"Keyboard sequence Action/Focus search field / focus query field in filter dialogfShow Add Filter dialogrReshuffle if sorted by randomv gSet view to gridv lSet view to listv wSet view to wall+Increase zoom slider-Decrease zoom slider\u2190Previous page of results\u2192Next page of resultsShift + \u2190Go to current results page -10Shift + \u2192Go to current results page +10Ctrl + HomeGo to first page of resultsCtrl + EndGo to last page of resultss aSelect all on pages nUnselect alleEdit selectedd dDelete selected"},{"location":"in-app-manual/keyboardshortcuts/#scenes-page-shortcuts","title":"Scenes page shortcuts","text":"Keyboard sequence Actionp rPlay random scene"},{"location":"in-app-manual/keyboardshortcuts/#scene-page-shortcuts","title":"Scene page shortcuts","text":"Keyboard sequence ActionaDetails tabqQueue tabkMarkers tabiFile info tabeEdit tabhHistory tab,Hide/Show sidebar.Hide/Show scene scrubberoIncrement O-Counter Ratingsr {1-5}Set rating (stars)r 0Unset rating (stars)r {0-9} {0-9}Set rating (decimal -00for10.0)r `Unset rating (decimal) Playbackp nPlay next scene in queuep pPlay previous scene in queuep rPlay random scene in queueSpacePlay/pause playerEnterPlay/pause player\u2190Seek backwards by 10 seconds\u2192Seek forwards by 10 secondsShift + \u2190Seek backwards by 5 secondsShift + \u2192Seek forwards by 5 secondsCtrl/Alt + \u2190Seek backwards by 1 minuteCtrl/Alt + \u2192Seek forwards by 1 minute{1-9}Seek to 10-90% duration[Scrub backwards 10% duration]Scrub forwards 10% duration\u2191Increase volume 10%\u2193Decrease volume 10%mToggle mutelA/B looping toggle. Press once to set start point. Press again to set end point. Press again to disable loop.Shift + lToggle looping of scene when it's over"},{"location":"in-app-manual/keyboardshortcuts/#scene-markers-tab-shortcuts","title":"Scene Markers tab shortcuts","text":"Keyboard sequence ActionnDisplay Create Markers dialog"},{"location":"in-app-manual/keyboardshortcuts/#scene-edit-tab-shortcuts","title":"Scene Edit tab shortcuts","text":"Keyboard sequence Actions sSave Scened dDelete SceneCtrl + vPaste Scene cover"},{"location":"in-app-manual/keyboardshortcuts/#image-page-shortcuts","title":"Image Page shortcuts","text":"Keyboard sequence ActioneEdit taboIncrement O-Counter Ratingsr {1-5}Set rating (stars)r 0Unset rating (stars)r {0-9} {0-9}Set rating (decimal -00for10.0)r `Unset rating (decimal)"},{"location":"in-app-manual/keyboardshortcuts/#image-edit-tab-shortcuts","title":"Image Edit tab shortcuts","text":"Keyboard sequence Actions sSave Scened dDelete Scene"},{"location":"in-app-manual/keyboardshortcuts/#groups-page-shortcuts","title":"Groups Page shortcuts","text":"Keyboard sequence ActionnNew Group"},{"location":"in-app-manual/keyboardshortcuts/#group-page-shortcuts","title":"Group Page shortcuts","text":"Keyboard sequence ActioneEdit Groups sSave Groupd dDelete Groupr `[Edit mode] Unset rating (decimal),Expand/Collapse DetailsCtrl + vPaste Group image Ratingsr {1-5}[Edit mode] Set rating (stars)r 0[Edit mode] Unset rating (stars)r {0-9} {0-9}[Edit mode] Set rating (decimal -r 0 0for10.0)"},{"location":"in-app-manual/keyboardshortcuts/#markers-page-shortcuts","title":"Markers Page shortcuts","text":"Keyboard sequence Actionp rPlay random marker"},{"location":"in-app-manual/keyboardshortcuts/#performers-page-shortcuts","title":"Performers Page shortcuts","text":"Keyboard sequence ActionnNew Performerp rOpen random Performer"},{"location":"in-app-manual/keyboardshortcuts/#performer-page-shortcuts","title":"Performer Page shortcuts","text":"Keyboard sequence ActioncScenes tabeEdit taboOperations tabfToggle favourite,Expand/Collapse Details"},{"location":"in-app-manual/keyboardshortcuts/#performer-edit-tab-shortcuts","title":"Performer Edit tab shortcuts","text":"Keyboard sequence Actions sSave Performerd dDelete PerformerCtrl + vPaste Performer image"},{"location":"in-app-manual/keyboardshortcuts/#studios-page-shortcuts","title":"Studios Page shortcuts","text":"Keyboard sequence ActionnNew Studio"},{"location":"in-app-manual/keyboardshortcuts/#studio-page-shortcuts","title":"Studio Page shortcuts","text":"Keyboard sequence ActioneEdit Studios sSave Studiod dDelete Studio,Expand/Collapse DetailsCtrl + vPaste Studio image"},{"location":"in-app-manual/keyboardshortcuts/#tags-page-shortcuts","title":"Tags Page shortcuts","text":"Keyboard sequence ActionnNew Tag"},{"location":"in-app-manual/keyboardshortcuts/#tag-page-shortcuts","title":"Tag Page shortcuts","text":"Keyboard sequence ActioneEdit Tags sSave Tagd dDelete Tag,Expand/Collapse DetailsCtrl + vPaste Tag image"},{"location":"in-app-manual/tagger/","title":"Scene tagger","text":""},{"location":"in-app-manual/tagger/#scene-tagger","title":"Scene Tagger","text":"Stash can be integrated with stash-box which acts as a centralized metadata database. This is in the early stages of development but can be used for fingerprint/keyword lookups and automated tagging of performers and scenes. The batch tagging interface can be accessed from the scene view. For more information join our Discord.
"},{"location":"in-app-manual/tagger/#searching","title":"Searching","text":"The fingerprint search matches your current selection of files against the remote stash-box instance. Any scenes with a matching fingerprint will be returned, although there is currently no validation of fingerprints so it\u2019s recommended to double-check the validity before saving.
If no fingerprint match is found it\u2019s possible to search by keywords. The search works by matching the query against a scene\u2019s title, release date, studio name, and performer names. By default the tagger uses metadata set on the file, or parses the filename, this can be changed in the config.
An important thing to note is that it only returns a match if all query terms are a match. As an example, if a scene is titled
"},{"location":"in-app-manual/tagger/#saving","title":"Saving","text":"\"A Trip to the Mall\"with the performer\"Jane Doe\", a search for\"Trip to the Mall 1080p\"will not match, however\"trip mall doe\"would. Usually a few pieces of info is enough, for instance performer name + release date or studio name. To avoid common non-related keywords you can add them to the blacklist in the tagger config. Any items in the blacklist are stripped out of the query.When a scene is matched stash will try to match the studio and performers against your local studios and performers. If you have previously matched them, they will automatically be selected. If not you either have to select the correct performer/studio from the dropdown, choose create to create a new entity, or skip to ignore it.
Once a scene is saved the scene and the matched studio/performers will have the
stash_idsaved which will then be used for future tagging.By default male performers are not shown, this can be enabled in the tagger config. Likewise scene tags are by default not saved. They can be set to either merge with existing tags on the scene, or overwrite them. It is not recommended to set tags currently since they are hard to deduplicate and can litter your data.
"},{"location":"in-app-manual/tagger/#submitting-fingerprints","title":"Submitting fingerprints","text":"After a scene is saved you will prompted to submit the fingerprint back to the stash-box instance. This is optional, but can be helpful for other users who have an identical copy who will then be able to match via the fingerprint search. No other information than the
"},{"location":"in-app-manual/plugins/","title":"Plugins","text":""},{"location":"in-app-manual/plugins/#plugins","title":"Plugins","text":"stash_idand file fingerprint is submitted.Stash supports plugins that can do the following:
- perform custom tasks when triggered by the user from the Tasks page
- perform custom tasks when triggered from specific events
- add custom CSS to the UI
- add custom JavaScript to the UI
Plugin tasks can be implemented using embedded Javascript, or by calling an external binary.
\u26a0\ufe0f Note: Plugin support is still experimental and is likely to change.
"},{"location":"in-app-manual/plugins/#managing-plugins","title":"Managing Plugins","text":"Plugins can be installed and managed from the
Settings > Pluginspage.Plugins are installed using the
Available Pluginssection. This section allows configuring sources from which to install plugins. TheCommunity (stable)source is configured by default. This source contains plugins for the current stable version of stash.These are the plugin sources maintained by the stashapp organisation:
Name Source URL Recommended Local Path Notes Community (stable)https://stashapp.github.io/CommunityScripts/stable/index.ymlstableFor the current stable version of stash. Community (develop)https://stashapp.github.io/CommunityScripts/develop/index.ymldevelopFor the develop version of stash.Installed plugins can be updated or uninstalled from the
"},{"location":"in-app-manual/plugins/#source-urls","title":"Source URLs","text":"Installed Pluginssection.The source URL must return a yaml file containing all the available packages for the source. An example source yaml file looks like the following:
- id: <package id>\n name: <package name>\n version: <version>\n date: <date>\n requires:\n - <ids of packages required by this package (optional)>\n - ...\n path: <path to package zip file>\n sha256: <sha256 of zip>\n metadata:\n <optional key/value pairs for extra information>\n- ...\nPath can be a relative path to the zip file or an external URL.
"},{"location":"in-app-manual/plugins/#adding-plugins-manually","title":"Adding plugins manually","text":"By default, Stash looks for plugin configurations in the
pluginssub-directory of the directory where the stashconfig.ymlis read. This will either be the$HOME/.stashdirectory or the current working directory.Plugins are added by adding configuration yaml files (format:
pluginName.yml) to thepluginsdirectory.Loaded plugins can be viewed in the Plugins page of the Settings. After plugins are added, removed or edited while stash is running, they can be reloaded by clicking
"},{"location":"in-app-manual/plugins/#using-plugins","title":"Using plugins","text":"Reload Pluginsbutton.Plugins provide tasks which can be run from the Tasks page.
"},{"location":"in-app-manual/plugins/#creating-plugins","title":"Creating plugins","text":""},{"location":"in-app-manual/plugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":"The basic structure of a plugin configuration file is as follows:
name: <plugin name>\ndescription: <optional description of the plugin>\nversion: <optional version tag>\nurl: <optional url>\n\nui:\n # optional list of css files to include in the UI\n css:\n - <path to css file>\n\n # optional list of js files to include in the UI\n javascript:\n - <path to javascript file>\n\n # optional list of plugin IDs to load prior to this plugin\n requires:\n - <plugin ID>\n\n # optional list of assets \n assets:\n urlPrefix: fsLocation\n ...\n\n # content-security policy overrides\n csp:\n script-src:\n - http://alloweddomain.com\n\n style-src:\n - http://alloweddomain.com\n\n connect-src:\n - http://alloweddomain.com\n\n# map of setting names to be displayed in the plugins page in the UI\nsettings:\n # internal name\n foo:\n # name to display in the UI\n displayName: Foo\n # type of the attribute to show in the UI\n # can be BOOLEAN, NUMBER, or STRING\n type: BOOLEAN\n\n# the following are used for plugin tasks only\nexec:\n - ...\ninterface: [interface type]\nerrLog: [one of none trace, debug, info, warning, error]\ntasks:\n - ...\nThe
name,description,versionandurlfields are displayed on the plugins page.The
exec,interface,errLogandtasksfields are used only for plugins with tasks.The
"},{"location":"in-app-manual/plugins/#ui-configuration","title":"UI Configuration","text":"settingsfield is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutationconfigurePlugin- the settings set this way do not need to be specified in thesettingsfield unless they are to be displayed in the stock plugin settings UI.The
cssandjavascriptfield values may be relative paths to the plugin configuration file, or may be full external URLs.The
requiresfield is a list of plugin IDs which must have their javascript/css files loaded before this plugins javascript/css files.The
assetsfield is a map of URL prefixes to filesystem paths relative to the plugin configuration file. Assets are mounted to the/plugin/{pluginID}/assetspath.As an example, for a plugin with id
foowith the followingassetsvalue:
The following URLs will be mapped to these locations:assets:\n foo: bar\n /: .\n/plugin/foo/assets/foo/file.txt->{pluginDir}/bar/file.txt/plugin/foo/assets/file.txt->{pluginDir}/file.txt/plugin/foo/assets/bar/file.txt->{pluginDir}/bar/file.txt(via the/entry)Mappings that try to go outside of the directory containing the plugin configuration file will be ignored.
The
cspfield contains overrides to the content security policies. The URLs inscript-src,style-srcandconnect-srcwill be added to the applicable content security policy.See External Plugins for details for making plugins with external tasks.
See Embedded Plugins for details for making plugins with embedded tasks.
"},{"location":"in-app-manual/plugins/#plugin-task-input","title":"Plugin task input","text":"Plugin tasks may accept an input from the stash server. This input is encoded according to the interface, and has the following structure (presented here in JSON format):
{\n \"server_connection\": {\n \"Scheme\": \"http\",\n \"Port\": 9999,\n \"SessionCookie\": {\n \"Name\":\"session\",\n \"Value\":\"cookie-value\",\n \"Path\":\"\",\n \"Domain\":\"\",\n \"Expires\":\"0001-01-01T00:00:00Z\",\n \"RawExpires\":\"\",\n \"MaxAge\":0,\n \"Secure\":false,\n \"HttpOnly\":false,\n \"SameSite\":0,\n \"Raw\":\"\",\n \"Unparsed\":null\n },\n \"Dir\": <path to stash config directory>,\n \"PluginDir\": <path to plugin config directory>,\n },\n \"args\": {\n \"argKey\": \"argValue\"\n }\n}\nThe
"},{"location":"in-app-manual/plugins/#plugin-task-output","title":"Plugin task output","text":"server_connectionfield contains all the information needed for a plugin to access the parent stash server, if necessary.Plugin task output is expected in the following structure (presented here as JSON format):
{\n \"error\": <optional error string>\n \"output\": <anything>\n}\nThe
"},{"location":"in-app-manual/plugins/#task-configuration","title":"Task configuration","text":"errorfield is logged in stash at theerrorlog level if present. Theoutputis written at thedebuglog level.Tasks are configured using the following structure:
tasks:\n - name: <operation name>\n description: <optional description>\n defaultArgs:\n argKey: argValue\nA plugin configuration may contain multiple tasks.
The
"},{"location":"in-app-manual/plugins/#hook-configuration","title":"Hook configuration","text":"defaultArgsfield is used to add inputs to the plugin input sent to the plugin.Stash supports executing plugin operations via triggering of a hook during a stash operation.
Hooks are configured using a similar structure to tasks:
hooks:\n - name: <operation name>\n description: <optional description>\n triggeredBy:\n - <trigger types>...\n defaultArgs:\n argKey: argValue\nNote: it is possible for hooks to trigger eachother or themselves if they perform mutations. For safety, hooks will not be triggered if they have already been triggered in the context of the operation. Stash uses cookies to track this context, so it's important for plugins to send cookies when performing operations.
"},{"location":"in-app-manual/plugins/#trigger-types","title":"Trigger types","text":"Trigger types use the following format:
<object type>.<operation>.<hook type>For example, a post-hook on a scene create operation will be
Scene.Create.Post.The following object types are supported:
SceneSceneMarkerImageGalleryGroupPerformerStudioTag
The following operations are supported:
CreateUpdateDestroyMerge(forTagonly)
Currently, only
"},{"location":"in-app-manual/plugins/#hook-input","title":"Hook input","text":"Posthook types are supported. These are executed after the operation has completed and the transaction is committed.Plugin tasks triggered by a hook include an argument named
hookContextin theargsobject structure. ThehookContextis structured as follows:{\n \"id\": <object id>,\n \"type\": <trigger type>,\n \"input\": <operation input>,\n \"inputFields\": <fields included in input>\n}\nThe
inputfield contains the JSON graphql input passed to the original operation. This will differ between operations. For hooks triggered by operations in a scan or clean, the input will be nil.inputFieldsis populated in update operations to indicate which fields were passed to the operation, to differentiate between missing and empty fields.For example, here is the
argsvalues for a Scene update operation:
"},{"location":"in-app-manual/plugins/embeddedplugins/","title":"Embedded plugins","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#embedded-plugin-tasks","title":"Embedded Plugin Tasks","text":"{\n \"hookContext\": {\n \"type\":\"Scene.Update.Post\",\n \"id\":45,\n \"input\":{\n \"clientMutationId\":null,\n \"id\":\"45\",\n \"title\":null,\n \"details\":null,\n \"url\":null,\n \"date\":null,\n \"rating\":null,\n \"organized\":null,\n \"studio_id\":null,\n \"gallery_ids\":null,\n \"performer_ids\":null,\n \"groups\":null,\n \"tag_ids\":[\"21\"],\n \"cover_image\":null,\n \"stash_ids\":null\n },\n \"inputFields\":[\n \"tag_ids\",\n \"id\"\n ]\n }\n}\nEmbedded plugin tasks are executed within the stash process using a scripting system.
"},{"location":"in-app-manual/plugins/embeddedplugins/#supported-script-languages","title":"Supported script languages","text":"Stash currently supports Javascript embedded plugin tasks using goja.
"},{"location":"in-app-manual/plugins/embeddedplugins/#javascript-plugins","title":"Javascript plugins","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-input","title":"Plugin input","text":"The input is provided to Javascript plugin tasks using the
"},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-output","title":"Plugin output","text":"inputglobal variable, and is an object based on the structure provided in thePlugin inputsection of the Plugins page. Note that theserver_connectionfield should not be necessary in most embedded plugins.The output of a Javascript plugin task is derived from the evaluated value of the script. The output should conform to the structure provided in the
Plugin outputsection of the Plugins page.There are a number of ways to return the plugin output:
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-1","title":"Example #1","text":"
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-2","title":"Example #2","text":"(function() {\n return {\n Output: \"ok\"\n };\n})();\n
"},{"location":"in-app-manual/plugins/embeddedplugins/#example-3","title":"Example #3","text":"function main() {\n return {\n Output: \"ok\"\n };\n}\n\nmain();\n
"},{"location":"in-app-manual/plugins/embeddedplugins/#logging","title":"Logging","text":"var output = {\n Output: \"ok\"\n};\n\noutput;\nSee the
"},{"location":"in-app-manual/plugins/embeddedplugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#exec","title":"exec","text":"Javascript APIsection below on how to log with Javascript plugins.For embedded plugins, the
"},{"location":"in-app-manual/plugins/embeddedplugins/#interface","title":"interface","text":"execfield is a list with the first element being the path to the Javascript file that will be executed. It is expected that the path to the Javascript file is relative to the directory of the plugin configuration file.For embedded plugins, the
"},{"location":"in-app-manual/plugins/embeddedplugins/#javascript-api","title":"Javascript API","text":""},{"location":"in-app-manual/plugins/embeddedplugins/#logging_1","title":"Logging","text":"interfacefield must be set to one of the following values: *jsStash provides the following API for logging in Javascript plugins:
Method Descriptionlog.Trace(<string>)Log with thetracelog level.log.Debug(<string>)Log with thedebuglog level.log.Info(<string>)Log with theinfolog level.log.Warn(<string>)Log with thewarnlog level.log.Error(<string>)Log with theerrorlog level.log.Progress(<float between 0 and 1>)Sets the progress of the plugin task, as a float, where0represents 0% and1represents 100%."},{"location":"in-app-manual/plugins/embeddedplugins/#gql","title":"GQL","text":"Stash provides the following API for communicating with stash using the graphql interface:
Method Descriptiongql.Do(<query/mutation string>, <variables object>)Executes a graphql query/mutation on the stash server. Returns an object in the same way as a graphql query does."},{"location":"in-app-manual/plugins/embeddedplugins/#example","title":"Example","text":"
"},{"location":"in-app-manual/plugins/embeddedplugins/#utility-functions","title":"Utility functions","text":"// creates a tag\nvar mutation = \"\\\nmutation tagCreate($input: TagCreateInput!) {\\\n tagCreate(input: $input) {\\\n id\\\n }\\\n}\";\n\nvar variables = {\n input: {\n 'name': tagName\n }\n};\n\nresult = gql.Do(mutation, variables);\nlog.Info(\"tag id = \" + result.tagCreate.id);\nStash provides the following API for utility functions:
Method Descriptionutil.Sleep(<milliseconds>)Suspends the current thread for the specified duration."},{"location":"in-app-manual/plugins/externalplugins/","title":"External plugins","text":""},{"location":"in-app-manual/plugins/externalplugins/#external-plugin-tasks","title":"External Plugin Tasks","text":"External plugin tasks are executed by running an external binary.
"},{"location":"in-app-manual/plugins/externalplugins/#plugin-interfaces","title":"Plugin interfaces","text":"Stash communicates with external plugin tasks using an interface. Stash currently supports RPC and raw interface types.
"},{"location":"in-app-manual/plugins/externalplugins/#rpc-interface","title":"RPC interface","text":"The RPC interface uses JSON-RPC to communicate with the plugin process. A golang plugin utilising the RPC interface is available in the stash source code under
pkg/plugin/examples/gorpc. RPC plugins are expected to provide an interface that fulfils theRPCRunnerinterface inpkg/plugin/common.RPC plugins are expected to accept requests asynchronously.
When stopping an RPC plugin task, the stash server sends a stop request to the plugin and relies on the plugin to stop itself.
"},{"location":"in-app-manual/plugins/externalplugins/#raw-interface","title":"Raw interface","text":"Raw interface plugins are not required to conform to any particular interface. The stash server will send the plugin input to the plugin process via its stdin stream, encoded as JSON. Raw interface plugins are not required to read the input.
The stash server reads stdout for the plugin's output. If the output can be decoded as a JSON representation of the plugin output data structure then it will do so. If not, it will treat the entire stdout string as the plugin's output.
When stopping a raw plugin task, the stash server kills the spawned process without warning or signals.
"},{"location":"in-app-manual/plugins/externalplugins/#logging","title":"Logging","text":"External plugins may log to the stash server by writing to stderr. By default, data written to stderr will be logged by stash at the
errorlevel. This default behaviour can be changed by setting theerrLogfield in the plugin configuration file.Plugins can log for specific levels or log progress by prefixing the output string with special control characters. See
"},{"location":"in-app-manual/plugins/externalplugins/#plugin-configuration-file-format","title":"Plugin configuration file format","text":""},{"location":"in-app-manual/plugins/externalplugins/#exec","title":"exec","text":"pkg/plugin/common/logfor how this is done in go.For external plugin tasks, the
execfield is a list with the first element being the binary that will be executed, and the subsequent elements are the arguments passed. The execution process will search the path for the binary, then will attempt to find the program in the same directory as the plugin configuration file. Theexeextension is not necessary on Windows systems.\u26a0\ufe0f Note: The plugin execution process sets the current working directory to that of the stash process.
Arguments can include the plugin's directory with the special string
{pluginDir}.For example, if the plugin executable
my_pluginis placed in thepluginssubdirectory and requires argumentsfooandbar, then theexecpart of the configuration would look like the following:exec:\n - my_plugin\n - foo\n - bar\nAnother example might use a python script to execute the plugin. Assuming the python script
foo.pyis placed in the same directory as the plugin config file, theexecfragment would look like the following:
"},{"location":"in-app-manual/plugins/externalplugins/#interface","title":"interface","text":"exec:\n - python\n - {pluginDir}/foo.py\nFor external plugin tasks, the
interfacefield must be set to one of the following values: *rpc*rawSee the
Plugin interfacessection above for details on these interface types.The
"},{"location":"in-app-manual/plugins/externalplugins/#errlog","title":"errLog","text":"interfacefield defaults torawif not provided.The
"},{"location":"in-app-manual/plugins/externalplugins/#task-configuration","title":"Task configuration","text":"errLogfield tells stash what the default log level should be when the plugin outputs to stderr without encoding a log level. It defaults to theerrorlevel if no provided. This field is not necessary if the plugin outputs logging with the appropriate encoding. See theLoggingsection above for details.In addition to the standard task configuration, external tasks may be configured with an optional
execArgsfield to add extra parameters to the execution arguments for the task.For example:
"},{"location":"in-app-manual/plugins/uipluginapi/","title":"UI plugin API","text":""},{"location":"in-app-manual/plugins/uipluginapi/#ui-plugin-api","title":"UI Plugin API","text":"tasks:\n - name: <operation name>\n description: <optional description>\n execArgs:\n - <arg to add to the exec line>\nThe
PluginApiobject is a global object in thewindowobject.PluginApiis considered experimental and is subject to change without notice. This documentation covers only the plugin-specific API. It does not necessarily cover the core UI API. Information on these methods should be referenced in the UI source code.An example using various aspects of
"},{"location":"in-app-manual/plugins/uipluginapi/#properties","title":"Properties","text":""},{"location":"in-app-manual/plugins/uipluginapi/#react","title":"PluginApimay be found in the source code underpkg/plugin/examples/react-component.React","text":"An instance of the React library.
"},{"location":"in-app-manual/plugins/uipluginapi/#reactdom","title":"ReactDOM","text":"An instance of the ReactDOM library.
"},{"location":"in-app-manual/plugins/uipluginapi/#gql","title":"GQL","text":"This namespace contains the generated graphql client interface. This is a low-level interface. In many cases,
"},{"location":"in-app-manual/plugins/uipluginapi/#libraries","title":"StashServiceshould be used instead.libraries","text":"
"},{"location":"in-app-manual/plugins/uipluginapi/#register","title":"librariesprovides access to the following UI libraries: -ReactRouterDOM-Bootstrap-Apollo-Intl-FontAwesomeRegular-FontAwesomeSolid-FontAwesomeBrands-Mousetrap-MousetrapPause-ReactSelectregister","text":"This namespace contains methods used to register page routes and components.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiregisterroute","title":"PluginApi.register.route","text":"Registers a route in the React Router.
Parameter Type DescriptionpathstringThe path to register. This should generally use the/plugin/prefix.componentReact.FCA React function component that will be rendered when the route is loaded.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiregistercomponent","title":"void.PluginApi.register.component","text":"Registers a component to be used by plugins. The component will be available in the
Parameter Type Descriptioncomponentsnamespace.namestringThe name of the component to register. This should be unique and should ideally be prefixed withplugin-.componentReact.FCA React function component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#components","title":"void.components","text":"This namespace contains all of the components available to plugins. These include a selection of core components and components registered using
"},{"location":"in-app-manual/plugins/uipluginapi/#utils","title":"PluginApi.register.component.utils","text":"This namespace provides access to the
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiutilsloadcomponents","title":"NavUtils,StashServiceandInteractiveUtilsnamespaces. It also provides access to theloadComponentsmethod.PluginApi.utils.loadComponents","text":"Due to code splitting, some components may not be loaded and available when a plugin page is rendered.
loadComponentsloads all of the components that a plugin page may require.In general,
Parameter Type DescriptionPluginApi.hooks.useLoadComponentshook should be used instead.componentsPromise[]The list of components to load. These values should come from thePluginApi.loadableComponentsnamespace.Returns a
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapiutilsinteractiveutils","title":"Promise<void>that resolves when all of the components have been loaded.PluginApi.utils.InteractiveUtils","text":"This namespace provides access to
interactiveClientProviderandgetPlayer-getPlayerreturns the currentvideojsplayer object -interactiveClientProvidertakesIInteractiveClientProviderwhich allows a developer to hook into the lifecycle of funscripts.
"},{"location":"in-app-manual/plugins/uipluginapi/#example","title":"Example","text":"export interface IDeviceSettings {\n connectionKey: string;\n scriptOffset: number;\n estimatedServerTimeOffset?: number;\n useStashHostedFunscript?: boolean;\n [key: string]: unknown;\n}\n\nexport interface IInteractiveClientProviderOptions {\n handyKey: string;\n scriptOffset: number;\n defaultClientProvider?: IInteractiveClientProvider;\n stashConfig?: GQL.ConfigDataFragment;\n}\nexport interface IInteractiveClientProvider {\n (options: IInteractiveClientProviderOptions): IInteractiveClient;\n}\n\n/**\n * Interface that is used for InteractiveProvider\n */\nexport interface IInteractiveClient {\n connect(): Promise<void>;\n handyKey: string;\n uploadScript: (funscriptPath: string, apiKey?: string) => Promise<void>;\n sync(): Promise<number>;\n configure(config: Partial<IDeviceSettings>): Promise<void>;\n play(position: number): Promise<void>;\n pause(): Promise<void>;\n ensurePlaying(position: number): Promise<void>;\n setLooping(looping: boolean): Promise<void>;\n readonly connected: boolean;\n readonly playing: boolean;\n}\nFor instance say I wanted to add extra logging when
IInteractiveClient.connect()is called. In my plugin you would install your own client provider as seen below
"},{"location":"in-app-manual/plugins/uipluginapi/#hooks","title":"InteractiveUtils.interactiveClientProvider = (\n opts\n) => {\n if (!opts.defaultClientProvider) {\n throw new Error('invalid setup');\n }\n\n const client = opts.defaultClientProvider(opts);\n const connect = client.connect;\n client.connect = async () => {\n console.log('patching connect method');\n return connect.call(client);\n };\n\n return client;\n};\nhooks","text":"This namespace provides access to the following core utility hooks: -
useGalleryLightbox-useLightbox-useSpriteInfo-useToastIt also provides plugin-specific hooks.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapihooksuseloadcomponents","title":"PluginApi.hooks.useLoadComponents","text":"This is a hook used to load components, using the
Parameter Type DescriptionPluginApi.utils.loadComponentsmethod.componentsPromise[]The list of components to load. These values should come from thePluginApi.loadableComponentsnamespace.Returns a
"},{"location":"in-app-manual/plugins/uipluginapi/#loadablecomponents","title":"booleanwhich will betrueif the components are loading.loadableComponents","text":"This namespace contains all of the components that may need to be loaded using the
loadComponentsmethod. Components are added to this namespace as needed. Please make a development request if a required component is not in this namespace.This component also includes coarse-grained entries for every lazily loaded import in the stock UI. If a component is not available in
"},{"location":"in-app-manual/plugins/uipluginapi/#patch","title":"componentswhen the page loads, it can be loaded using the coarse-grained entry. For example,PerformerCardcan be loaded usingloadableComponents.Performers.patch","text":"This namespace provides methods to patch components to change their behaviour.
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchbefore","title":"PluginApi.patch.before","text":"Registers a before function. A before function is called prior to calling a component's render function. It accepts the same parameters as the component's render function, and is expected to return a list of new arguments that will be passed to the render.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe before function. It accepts the same arguments as the component render function and is expected to return a list of arguments to pass to the render function.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchinstead","title":"void.PluginApi.patch.instead","text":"Registers a replacement function for a component. The provided function will be called with the arguments passed to the original render function, plus the next render function as the last argument. Replacement functions will be called in the order that they are registered. If a replacement function does not call the next render function then the following replacement functions will not be called or applied.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe replacement function. It accepts the same arguments as the original render function, plus the next render function, and is expected to return the replacement component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#pluginapipatchafter","title":"void.PluginApi.patch.after","text":"Registers an after function. An after function is called after the render function of the component. It accepts the arguments passed to the original render function, plus the result of the original render function. It is expected to return the rendered component.
Parameter Type DescriptioncomponentstringThe name of the component to patch.fnFunctionThe after function. It accepts the same arguments as the original render function, plus the result of the original render function, and is expected to return the rendered component.Returns
"},{"location":"in-app-manual/plugins/uipluginapi/#patchable-components-and-functions","title":"Patchable components and functions","text":"void.AlertModalAppBackgroundImageBooleanSettingChangeButtonSettingCompressedPerformerDetailsPanelConstantSettingCountrySelectCustomFieldInputCustomFieldsDateInputDetailImageExternalLinkButtonsExternalLinksButtonFolderSelectFrontPageGalleryCardGalleryCard.DetailsGalleryCard.ImageGalleryCard.OverlaysGalleryCard.PopoversGalleryIDSelectGallerySelectGallerySelect.sortGroupIDSelectGroupSelectGroupSelect.sortHeaderImageHoverPopoverIconImageDetailPanelImageInputLightboxLinkLoadingIndicatorMainNavBar.MenuItemsMainNavBar.UtilityItemsModalSettingNumberSettingPaginationPaginationIndexPerformerAppearsWithPanelPerformerCardPerformerCard.DetailsPerformerCard.ImagePerformerCard.OverlaysPerformerCard.PopoversPerformerCard.TitlePerformerDetailsPanelPerformerDetailsPanel.DetailGroupPerformerGalleriesPanelPerformerGroupsPanelPerformerHeaderImagePerformerIDSelectPerformerImagesPanelPerformerPagePerformerScenesPanelPerformerSelectPerformerSelect.sortPluginRoutesPluginSettingsRatingNumberRatingStarsRatingSystemSceneCardSceneCard.DetailsSceneCard.ImageSceneCard.OverlaysSceneCard.PopoversSceneFileInfoPanelSceneIDSelectScenePageScenePage.TabContentScenePage.TabsScenePlayerSceneSelectSceneSelect.sortSelectSettingSettingSettingGroupSettingModalStringListSettingStringSettingStudioIDSelectStudioSelectStudioSelect.sortSweatDropsTabTitleCounterTagCardTagCard.DetailsTagCard.ImageTagCard.OverlaysTagCard.PopoversTagCard.TitleTagIDSelectTagLinkTagSelectTagSelect.sortTruncatedText
PluginApi.Event","text":"Allows plugins to listen for Stash's events.
"},{"location":"in-app-manual/scraping/","title":"Metadata scraping","text":""},{"location":"in-app-manual/scraping/#metadata-scraping","title":"Metadata Scraping","text":"PluginApi.Event.addEventListener(\"stash:location\", (e) => console.log(\"Page Changed\", e.detail.data.location.pathname))\nStash supports scraping of metadata from various external sources.
"},{"location":"in-app-manual/scraping/#scraper-types","title":"Scraper Types","text":"Type Description Fragment Uses existing metadata for an Item and match it to a result from a metadata source. Search/By Name Uses a provided query string to search a metadata source for a list of matches for the user to pick from. URL Extracts metadata from a given URL."},{"location":"in-app-manual/scraping/#supported-scrapers","title":"Supported Scrapers","text":"Fragment Search URL gallery \u2714\ufe0f \u2714\ufe0f image \u2714\ufe0f \u2714\ufe0f group \u2714\ufe0f performer \u2714\ufe0f \u2714\ufe0f scene \u2714\ufe0f \u2714\ufe0f \u2714\ufe0f"},{"location":"in-app-manual/scraping/#included-scrapers","title":"Included Scrapers","text":"Stash provides the following built-in scrapers:
Scraper Description FreeonessearchPerformer scraper for freeones.xxx. Auto Tag Scenefragmentscraper that matches existing performers, studio and tags using the filename."},{"location":"in-app-manual/scraping/#managing-scrapers","title":"Managing Scrapers","text":"Scrapers can be installed and managed from the
Settings > Metadata Providerspage.Scrapers are installed using the
Available Scraperssection. This section allows configuring sources from which to install scrapers. TheCommunity (stable)source is configured by default. This source contains scrapers for the current stable version of stash.These are the scraper sources maintained by the stashapp organisation:
Name Source URL Recommended Local Path Notes Community (stable)https://stashapp.github.io/CommunityScrapers/stable/index.ymlstableFor the current stable version of stash. Community (develop)https://stashapp.github.io/CommunityScrapers/develop/index.ymldevelopFor the develop version of stash.Installed scrapers can be updated or uninstalled from the
"},{"location":"in-app-manual/scraping/#source-urls","title":"Source URLs","text":"Installed Scraperssection.The source URL must return a yaml file containing all the available packages for the source. An example source yaml file looks like the following:
- id: <package id>\n name: <package name>\n version: <version>\n date: <date>\n requires:\n - <ids of packages required by this package (optional)>\n - ...\n path: <path to package zip file>\n sha256: <sha256 of zip>\n metadata:\n <optional key/value pairs for extra information>\n- ...\nPath can be a relative path to the zip file or an external URL.
"},{"location":"in-app-manual/scraping/#adding-scrapers-manually","title":"Adding Scrapers manually","text":"By default, Stash looks for scraper configurations in the
scraperssub-directory of the directory where the stashconfig.ymlis read. This will either be the$HOME/.stashdirectory or the current working directory.Scrapers are added manually by placing yaml configuration files (format:
scrapername.yml) in thescrapersdirectory.\u26a0\ufe0f Note: Some scrapers may require more than just the yaml file, consult the individual scraper documentation
After the yaml files are added, removed or edited while stash is running, they can be reloaded going to
"},{"location":"in-app-manual/scraping/#using-scrapers","title":"Using Scrapers","text":""},{"location":"in-app-manual/scraping/#fragment-scraper","title":"Fragment Scraper","text":"Settings > Metadata Providers > Scrapersand clickingReload Scrapers.Click on the
"},{"location":"in-app-manual/scraping/#search-scraper","title":"Search Scraper","text":"Scrape With...button in theedittab of an item, then select the scraper you wish to use.Click on the \ud83d\udd0d button in the
"},{"location":"in-app-manual/scraping/#url-scraper","title":"URL Scraper","text":"edittab of an item. You will be presented with a search dialog with a pre-populated query to search for, after searching you will be presented with a list of results to pick fromEnter the URL in the
"},{"location":"in-app-manual/scraping/#tagger-view","title":"Tagger View","text":"edittab of an Item. If a scraper is installed that supports that url, then a button will appear to scrape the metadata.The Tagger view is accessed from the scenes page. It allows the user to run scrapers on all items on the current page. The Tagger presents the user with potential matches for an item from a selected stash-box instance or metadata source if supported. The user needs to select the correct metadata information to save.
When used in combination with stash-box, the user can optionally submit scene fingerprints to contribute to a stash-box instance. A scene fingerprint consists of any generated hashes (
Has Tagger Source Selection gallery group performer \u2714\ufe0f scene \u2714\ufe0f \u2714\ufe0f"},{"location":"in-app-manual/scraping/#identify-task","title":"Identify Task","text":"phash,oshash,md5) and the scene duration. Fingerprint submissions are associated with your stash-box account. Submitting fingerprints assists others in matching their files, because stash-box returns a count of matching user submitted fingerprints with every potential match.This task iterates through your Scenes and attempts to identify the scene using a selection of scraping sources. This task can be found under
"},{"location":"in-app-manual/scraping/scraperdevelopment/","title":"Contributing scrapers","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#contributing-scrapers","title":"Contributing Scrapers","text":"Settings -> Tasks -> \"Identify...\" (Button). For more information see the Tasks > Identify page.Scrapers can be contributed to the community by creating a PR in this repository.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-scraper-templates","title":"XPath scraper templates","text":"The most basic XPath scraper templates are available on CommunityScrapers repository.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scraper-configuration-file-format","title":"Scraper configuration file format","text":"name: <site>\nperformerByName:\n <single scraper config>\nperformerByFragment:\n <single scraper config>\nperformerByURL:\n <multiple scraper URL configs>\nsceneByName:\n <single scraper config>\nsceneByQueryFragment:\n <single scraper config>\nsceneByFragment:\n <single scraper config>\nsceneByURL:\n <multiple scraper URL configs>\ngroupByURL:\n <multiple scraper URL configs>\ngalleryByFragment:\n <single scraper config>\ngalleryByURL:\n <multiple scraper URL configs>\nimageByFragment:\n <single scraper config>\nimageByURL:\n <multiple scraper URL configs>\n<other configurations>\nnameis mandatory, all other top-level fields are optional. The inclusion of each top-level field determines what capabilities the scraper has.A scraper configuration in any of the top-level fields must at least have an
actionfield. The other fields are required based on the value of theactionfield.The scraping types and their required fields are outlined in the following table:
Behavior Required configuration Scraper inScrape...dropdown button in Performer Edit page ValidperformerByNameandperformerByFragmentconfigurations. Scrape performer from URL ValidperformerByURLconfiguration with matching URL. Scraper in query dropdown button in Scene Edit page ValidsceneByNameandsceneByQueryFragmentconfigurations. Scraper inScrape...dropdown button in Scene Edit page ValidsceneByFragmentconfiguration. Scrape scene from URL ValidsceneByURLconfiguration with matching URL. Scrape group from URL ValidgroupByURLconfiguration with matching URL. Note:movieByURLis also supported but is deprecated. Scraper inScrape...dropdown button in Gallery Edit page ValidgalleryByFragmentconfiguration. Scrape gallery from URL ValidgalleryByURLconfiguration with matching URL.URL-based scraping accepts multiple scrape configurations, and each configuration requires a
"},{"location":"in-app-manual/scraping/scraperdevelopment/#actions","title":"Actions","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#script","title":"Script","text":"urlfield. stash iterates through these configurations, attempting to match the entered URL against theurlfields in the configuration. It executes the first scraping configuration where the entered URL contains the value of theurlfield.Executes a script to perform the scrape. The
scriptfield is required for this action and accepts a list of string arguments. For example:action: script\nscript:\n - python\n - iafdScrape.py\n - query\nIf the script specifies the python executable, Stash will find the correct python executable for your system, either
pythonorpython3. So for example. this configuration could executepython iafdScrape.py queryorpython3 iafdScrape.py query.python3will be looked for first and if it's not found, we'll check forpython. In the case neither are found, you will get an error.Stash sends data to the script process's
stdinstream and expects the output to be streamed to thestdoutstream. Any errors and progress messages should be output tostderr.The script is sent input and expects output based on the scraping type, as detailed in the following table:
Scrape type Input OutputperformerByName{\"name\": \"<performer query string>\"}Array of JSON-encoded performer fragments (including at leastname)performerByFragmentJSON-encoded performer fragment JSON-encoded performer fragmentperformerByURL{\"url\": \"<url>\"}JSON-encoded performer fragmentsceneByName{\"name\": \"<scene query string>\"}Array of JSON-encoded scene fragmentssceneByQueryFragment,sceneByFragmentJSON-encoded scene fragment JSON-encoded scene fragmentsceneByURL{\"url\": \"<url>\"}JSON-encoded scene fragmentgroupByURL{\"url\": \"<url>\"}JSON-encoded group fragmentgalleryByFragmentJSON-encoded gallery fragment JSON-encoded gallery fragmentgalleryByURL{\"url\": \"<url>\"}JSON-encoded gallery fragmentimageByFragmentJSON-encoded image fragment JSON-encoded image fragmentimageByURL{\"url\": \"<url>\"}JSON-encoded image fragmentFor
performerByName, onlynameis required in the returned performer fragments. One entire object is sent back toperformerByFragmentto scrape a specific performer, so the other fields may be included to assist in scraping a performer. For example, theurlfield may be filled in for the specific performer page, thenperformerByFragmentcan extract by using its value.Python example of a performer Scraper:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath","title":"scrapeXPath","text":"import json\nimport sys\nimport string\n\ndef readJSONInput():\n input = sys.stdin.read()\n return json.loads(input)\n\n\ndef searchPerformer(name):\n # perform scraping here - using name for the query\n\n # fill in the output\n ret = []\n\n # example shown for a single found performer \n p = {}\n p['name'] = \"some name\"\n p['url'] = \"performer url\"\n ret.append(p)\n\n return ret\n\ndef scrapePerformer(input):\n ret = []\n # get the url from the input\n url = input['url']\n return scrapePerformerURL(url)\n\ndef debugPrint(t):\n sys.stderr.write(t + \"\\n\")\n\ndef scrapePerformerURL(url):\n debugPrint(\"Reading url...\")\n debugPrint(\"Parsing html...\")\n\n # parse html\n\n # fill in performer details - single object\n ret = {}\n\n ret['name'] = \"fred\"\n ret['aliases'] = \"freddy\"\n ret['ethnicity'] = \"\"\n # and so on\n\n return ret\n\n# read the input \ni = readJSONInput()\n\nif sys.argv[1] == \"query\":\n ret = searchPerformer(i['name'])\n print(json.dumps(ret))\nelif sys.argv[1] == \"scrape\":\n ret = scrapePerformer(i)\n print(json.dumps(ret))\nelif sys.argv[1] == \"scrapeURL\":\n ret = scrapePerformerURL(i['url'])\n print(json.dumps(ret))\nThis action scrapes a web page using an xpath configuration to parse. This action is not valid for
performerByFragment.This action requires that the top-level
xPathScrapersconfiguration is populated. Thescraperfield is required and must match the name of a scraper name configured inxPathScrapers. For example:sceneByURL:\n- action: scrapeXPath\n url: \n - pornhub.com/view_video.php\n scraper: sceneScraper\nThe above configuration requires that
sceneScraperexists in thexPathScrapersconfiguration.XPath scraping configurations specify the mapping between object fields and an xpath selector. The xpath scraper scrapes the applicable URL and uses xpath to populate the object fields.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapejson","title":"scrapeJson","text":"This action works in the same way as
scrapeXPath, but uses a mapped json configuration to parse. It uses the top-leveljsonScrapersconfiguration. This action is not valid forperformerByFragment.JSON scraping configurations specify the mapping between object fields and a GJSON selector. The JSON scraper scrapes the applicable URL and uses GJSON to parse the returned JSON object and populate the object fields.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-performerbyname","title":"scrapeXPath and scrapeJson use withperformerByName","text":"For
performerByName, thequeryURLfield must be present also. This field is used to perform a search query URL for performer names. The placeholder string sequence{}is replaced with the performer name search string. For the subsequent performer scrape to work, theURLfield must be filled in with the URL of the performer page that matches a URL given in aperformerByURLscraping configuration. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-scenebyfragment-and-scenebyqueryfragment","title":"scrapeXPath and scrapeJson use withname: Boobpedia\nperformerByName:\n action: scrapeXPath\n queryURL: http://www.boobpedia.com/wiki/index.php?title=Special%3ASearch&search={}&fulltext=Search\n scraper: performerSearch\nperformerByURL:\n - action: scrapeXPath\n url: \n - boobpedia.com/boobs/\n scraper: performerScraper\nxPathScrapers:\n performerSearch:\n performer:\n Name: # name element\n URL: # URL element that matches the boobpedia.com/boobs/ URL above\n performerScraper:\n # ... performer scraper details ...\nsceneByFragmentandsceneByQueryFragment","text":"For
sceneByFragmentandsceneByQueryFragment, thequeryURLfield must also be present. This field is used to build a query URL for scenes. ForsceneByFragment, thequeryURLfield supports the following placeholder fields:{checksum}- the MD5 checksum of the scene{oshash}- the oshash of the scene{filename}- the base filename of the scene{title}- the title of the scene{url}- the url of the scene
These placeholder field values may be manipulated with regex replacements by adding a
queryURLReplacesection, containing a map of placeholder field to regex configuration which uses the same format as thereplacepost-process action covered below.For example:
sceneByFragment:\n action: scrapeJson\n scraper: sceneQueryScraper\n queryURL: https://metadataapi.net/api/scenes?parse={filename}&limit=1\n queryURLReplace:\n filename:\n - regex: <some regex>\n with: <replacement>\nThe above configuration would scrape from the value of
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scrapexpath-and-scrapejson-use-with-sceneperformergallerygroupbyurl","title":"scrapeXPath and scrapeJson use withqueryURL, replacing{filename}with the base filename of the scene, after it has been manipulated by the regex replacements.<scene|performer|gallery|group>ByURL","text":"For
sceneByURL,performerByURL,galleryByURLthequeryURLcan also be present if we want to usequeryURLReplace. The functionality is the same assceneByFragment, the only placeholder field available though is theurl:{url}- the url of the scene/performer/gallery
"},{"location":"in-app-manual/scraping/scraperdevelopment/#stash","title":"Stash","text":"sceneByURL:\n - action: scrapeJson\n url:\n - metartnetwork.com\n scraper: sceneScraper\n queryURL: \"{url}\"\n queryURLReplace:\n url:\n - regex: '^(?:.+\\.)?([^.]+)\\.com/.+movie/(\\d+)/(\\w+)/?$'\n with: https://www.$1.com/api/movie?name=$3&date=$2\nA different stash server can be configured as a scraping source. This action applies only to
performerByName,performerByFragment,sceneByName,sceneByQueryFragmentandsceneByFragment, types. This action requires that the top-levelstashServerfield is configured.stashServercontains a singleurlfield for the remote stash server.- The username and password can be embedded in this string using
username:password@host. - Alternatively, the
apiKeyfield can be used to authenticate with the remote stash server.
An example stash scrape configuration is below:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-and-json-scrapers-configuration","title":"Xpath and JSON scrapers configuration","text":"name: stash\nperformerByName:\n action: stash\nperformerByFragment:\n action: stash\nsceneByFragment:\n action: stash\nsceneByName:\n action: stash\nsceneByQueryFragment:\n action: stash\nstashServer:\n apiKey: <api key>\n url: http://stashserver.com:9999\nThe top-level
xPathScrapersfield contains xpath scraping configurations, freely named. These are referenced in thescraperfield forscrapeXPathscrapers.Likewise, the top-level
jsonScrapersfield contains json scraping configurations.Collectively, these configurations are known as mapped scraping configurations.
A mapped scraping configuration may contain a
commonfield, and must containperformer,scene,grouporgallerydepending on the scraping type it is configured for.Within the
performer/scene/group/galleryfield are key/value pairs corresponding to the golang fields on the performer/scene object. These fields are case-sensitive.The values of these may be either a simple selector value, which tells the system where to get the value of the field from, or a more advanced configuration (see below). For example, for an xpath configuration:
performer:\n Name: //h1[@itemprop=\"name\"]\nThis will set the
Nameattribute of the returned performer to the text content of the element that matches<h1 itemprop=\"name\">....For a json configuration:
performer:\n Name: data.name\nThe value may also be a sub-object. If it is a sub-object, then the selector must be set to the
selectorkey of the sub-object. For example, using the same xpath as above:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#fixed-attribute-values","title":"Fixed attribute values","text":"performer:\n Name: \n selector: //h1[@itemprop=\"name\"]\n postProcess:\n # post-processing config values\nAlternatively, an attribute value may be set to a fixed value, rather than scraping it from the webpage. This can be done by replacing
selectorwithfixed. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#common-fragments","title":"Common fragments","text":"performer:\n Gender: \n fixed: Female\nThe
commonfield is used to configure selector fragments that can be referenced in the selector strings. These are key-value pairs where the key is the string to reference the fragment, and the value is the string that the fragment will be replaced with. For example:common:\n $infoPiece: //div[@class=\"infoPiece\"]/span\nperformer:\n Measurements: $infoPiece[text() = 'Measurements:']/../span[@class=\"smallInfo\"]\nThe
Measurementsxpath string will replace$infoPiecewith//div[@class=\"infoPiece\"]/span, resulting in://div[@class=\"infoPiece\"]/span[text() = 'Measurements:']/../span[@class=\"smallInfo\"].\u26a0\ufe0f Note: Recursive common fragments are not supported. Referencing a common fragment within another common fragment will cause an error. For example:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#post-processing-options","title":"Post-processing options","text":"common:\n $info: //div[@class=\"info\"]\n # Referencing $info in $models will cause an error\n $models: $info/a[@class=\"model\"]\nscene:\n Title: $info/h1\n Performers:\n Name: $models\n URL: $models/@href\nPost-processing operations are contained in the
postProcesskey. Post-processing operations are performed in the order they are specified. The following post-processing operations are available:javascript: accepts a javascript code block, that must return a string value. The input string is declared in thevaluevariable. If an error occurs while compiling or running the script, then the original value is returned. Example:performer:\n Name:\n selector: //div[@class=\"example element\"]\n postProcess:\n - javascript: |\n // capitalise the first letter\n if (value && value.length) {\n return value[0].toUpperCase() + value.substring(1)\n }\n
We use
gojajavascript engine which is missing a few built-in methods and may not be consistent with other modern javascript implementations.feetToCm: converts a string containing feet and inches numbers into centimeters. Looks for up to two separate integers and interprets the first as the number of feet, and the second as the number of inches. The numbers can be separated by any non-numeric character including the.character. It does not handle decimal numbers. For example6.3and6ft3.3would both be interpreted as 6 feet, 3 inches before converting into centimeters.lbToKg: converts a string containing lbs to kg.-
map: contains a map of input values to output values. Where a value matches one of the input values, it is replaced with the matching output value. If no value is matched, then value is unmodified. Example:
Gets the contents of the selected div element, and sets the returned value to:performer:\n Gender:\n selector: //div[@class=\"example element\"]\n postProcess:\n - map:\n F: Female\n M: Male\n Height:\n selector: //span[@id=\"height\"]\n postProcess:\n - feetToCm: true\n Weight:\n selector: //span[@id=\"weight\"]\n postProcess:\n - lbToKg: true\nFemaleif the scraped value isF;Maleif the scraped value isM.
Height and weight are extracted from the selected spans and converted to
cmandkg. -
parseDate: if present, the value is the date format using go's reference date (2006-01-02). For example, if an example date was14-Mar-2003, then the date format would be02-Jan-2006. See the time.Parse documentation for details. When present, the scraper will convert the input string into a date, then convert it to the string format used by stash (YYYY-MM-DD). Strings \"Today\", \"Yesterday\" are matched (case insensitive) and converted by the scraper so you don't need to edit/replace them. Unix timestamps (example: 1660169451) can also be parsed by selectingunixas the date format. Example:Date:\n selector: //div[@class=\"value epoch\"]/text()\n postProcess:\n - parseDate: unix\n -
subtractDays: if set totrueit subtracts the value in days from the current date and returns the resulting date in stash's date format. Example:Date:\n selector: //strong[contains(text(),\"Added:\")]/following-sibling::text()\n postProcess:\n - replace:\n - regex: (\\d+)\\sdays\\sago.+\n with: $1\n - subtractDays: true\n -
replace: contains an array of sub-objects. Each sub-object must have aregexandwithfield. Theregexfield is the regex pattern to replace, andwithis the string to replace it with.$is used to reference capture groups -$1is the first capture group,$2the second and so on. Replacements are performed in order of the array. Example:
ReplacesCareerLength: \n selector: $infoPiece[text() = 'Career Start and End:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace:\n - regex: \\s+to\\s+\n with: \"-\"\n2001 to 2003with2001-2003. -
subScraper: if present, the sub-scraper will be executed after all other post-processes are complete and before parseDate. It then takes the value and performs an http request, using the value as the URL. Within thesubScraperconfig is a nested scraping configuration. This allows you to traverse to other webpages to get the attribute value you are after. For more info and examples have a look at #370, #606
Additionally, there are a number of fixed post-processing fields that are specified at the attribute level (not in
postProcess) that are performed after thepostProcessoperations:concat: if an xpath matches multiple elements, andconcatis present, then all of the elements will be concatenated togethersplit: the inverse ofconcat. Splits a string to more elements using the separator given. For more info and examples have a look at PR #579 Example:
Splits a comma separated list of tags located in the span and returns the tags.Tags:\n Name:\n selector: //span[@class=\"list_attributes\"]\n split: \",\"\n
For backwards compatibility,
replace,subscraperandparseDateare also allowed as keys for the attribute.Post-processing on attribute post-process is done in the following order:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#xpath-resources","title":"XPath resources:","text":"concat,replace,subscraper,parseDateand thensplit.- Test XPaths in Firefox: https://addons.mozilla.org/en-US/firefox/addon/try-xpath/
- XPath cheatsheet: https://devhints.io/xpath
- GJSON Path Syntax: https://github.com/tidwall/gjson/blob/master/SYNTAX.md
To print the received html/json from a scraper request to the log file, add the following to your scraper yml file:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cdp-support","title":"CDP support","text":"debug:\n printHTML: true\nSome websites deliver content that cannot be scraped using the raw html file alone. These websites use javascript to dynamically load the content. As such, direct xpath scraping will not work on these websites. There is an option to use Chrome DevTools Protocol to load the webpage using an instance of Chrome, then scrape the result.
Chrome CDP support can be enabled for a specific scraping configuration by adding the following to the root of the yml configuration:
driver:\n useCDP: true\nOptionally, you can add a
sleepvalue under thedriversection. This specifies the amount of time (in seconds) that the scraper should wait after loading the website to perform the scrape. This is needed as some sites need more time for loading scripts to finish. If unset, this value defaults to 2 seconds.When
useCDPis set to true, stash will execute or connect to an instance of Chrome. The behavior is dictated by theChrome CDP pathsetting in the user configuration. If left empty, stash will attempt to find the Chrome executable in the path environment, and will fail if it cannot find one.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cdp-click-support","title":"CDP Click support","text":"Chrome CDP pathcan be set to a path to the chrome executable, or an http(s) address to remote chrome instance (for example:http://localhost:9222/json/version). As remote instance a docker container can also be used with thechromedp/headless-shellimage being highly recommended.When using CDP you can use the
clickspart of thedriversection to do Mouse Clicks on elements you need to collapse or toggle. Each click element has anxpathvalue that holds the XPath for the button/element you need to click and an optionalsleepvalue that is the time in seconds to wait for after clicking. If thesleepvalue is not set it defaults to2seconds.A demo scraper using
clicksfollows.name: clickDemo # demo only for a single URL\nsceneByURL:\n - action: scrapeXPath\n url:\n - https://getbootstrap.com/docs/4.3/components/collapse/\n scraper: sceneScraper\n\nxPathScrapers:\n sceneScraper:\n scene:\n Title: //head/title\n Details: # shows the id/s of the visible div/s for the Multiple targets example of the page\n selector: //div[@class=\"bd-example\"]//div[@class=\"multi-collapse collapse show\"]/@id\n concat: \"\\n\\n\"\n\ndriver:\n useCDP: true\n sleep: 1\n clicks: # demo usage toggle on off multiple times\n - xpath: //a[@href=\"#multiCollapseExample1\"] # toggle on first element\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle on second element\n sleep: 4\n - xpath: //a[@href=\"#multiCollapseExample1\"] # toggle off fist element\n sleep: 1\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle off second element\n - xpath: //button[@data-target=\"#multiCollapseExample2\"] # toggle on second element\n\u26a0\ufe0f Note: each
"},{"location":"in-app-manual/scraping/scraperdevelopment/#cookie-support","title":"Cookie support","text":"clickadds an extra delay ofclicks sleepseconds, so the above adds2+4+1+2+2=11seconds to the loading time of the page.In some websites the use of cookies is needed to bypass a welcoming message or some other kind of protection. Stash supports the setting of cookies for the direct xpath scraper and the CDP based one. Due to implementation issues the usage varies a bit.
To use the cookie functionality a
cookiessub section needs to be added to thedriversection. Each cookie element can consist of aCookieURLand a number ofCookies.-
CookieURLis only needed if you are using the direct / native scraper method. It is the request url that we expect from the site we scrape. It must be in the same domain as the cookies we try to set otherwise all cookies in the same group will fail to set. If theCookieURLis not a valid URL then again the cookies of that group will fail. -
Cookiesare the actual cookies we set. When using CDP that's the only part required. They haveName,Value,Domain,Pathvalues.
In the following example we use cookies for a site using the direct / native xpath scraper. We expect requests to come from
https://www.example.comandhttps://api.somewhere.comthat look for a_warningand a_warncookie. A_test2cookie is also set just as a demo.driver:\n cookies:\n - CookieURL: \"https://www.example.com\"\n Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n Value: \"123412\"\n Domain: \".example.com\"\n Path: \"/\"\n - CookieURL: \"https://api.somewhere.com\"\n Cookies:\n - Name: \"_warn\"\n Value: \"123\"\n Domain: \".somewhere.com\"\nThe same functionality when using CDP would look like this:
driver:\n useCDP: true\n cookies:\n - Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n Value: \"123412\"\n Domain: \".example.com\"\n Path: \"/\"\n - Cookies:\n - Name: \"_warn\"\n Value: \"123\"\n Domain: \".somewhere.com\"\nFor some sites, the value of the cookie itself doesn't actually matter. In these cases, we can use the
ValueRandomproperty instead ofValue. UnlikeValue,ValueRandomrequires an integer value greater than0where the value indicates how long the cookie string should be.In the following example, we will adapt the previous cookies to use
ValueRandominstead. We set the_test2cookie to randomly generate a value with a length of 6 characters and the_warncookie to a length of 3.driver:\n cookies:\n - CookieURL: \"https://www.example.com\"\n Cookies:\n - Name: \"_warning\"\n Domain: \".example.com\"\n Value: \"true\"\n Path: \"/\"\n - Name: \"_test2\"\n ValueRandom: 6\n Domain: \".example.com\"\n Path: \"/\"\n - CookieURL: \"https://api.somewhere.com\"\n Cookies:\n - Name: \"_warn\"\n ValueRandom: 3\n Domain: \".somewhere.com\"\nWhen developing a scraper you can have a look at the cookies set by a site by adding
-
a
CookieURLif you use the direct xpath scraper -
a
Domainif you use the CDP scraper
and having a look at the log / console in debug mode.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#headers","title":"Headers","text":"Sending request headers is possible when using a scraper. Headers can be set in the
driversection and are supported for plain, CDP enabled and JSON scrapers. They consist of a Key and a Value. If the Key is empty or not defined then the header is ignored.driver:\n headers:\n - Key: User-Agent\n Value: My Stash Scraper\n - Key: Authorization\n Value: Bearer ds3sdfcFdfY17p4qBkTVF03zscUU2glSjWF17bZyoe8\n- headers are set after stash's
User-Agentconfiguration option is applied. This means setting aUser-Agentheader from the scraper overrides the one in the configuration settings.
A performer and scene xpath scraper is shown as an example below:
name: Pornhub\nperformerByURL:\n - action: scrapeXPath\n url: \n - pornhub.com\n scraper: performerScraper\nsceneByURL:\n - action: scrapeXPath\n url: \n - pornhub.com/view_video.php\n scraper: sceneScraper\nxPathScrapers:\n performerScraper:\n common:\n $infoPiece: //div[@class=\"infoPiece\"]/span\n performer:\n Name: //h1[@itemprop=\"name\"]\n Birthdate: \n selector: //span[@itemprop=\"birthDate\"]\n parseDate: Jan 2, 2006\n Twitter: //span[text() = 'Twitter']/../@href\n Instagram: //span[text() = 'Instagram']/../@href\n Measurements: $infoPiece[text() = 'Measurements:']/../span[@class=\"smallInfo\"]\n Height: \n selector: $infoPiece[text() = 'Height:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace: \n - regex: .*\\((\\d+) cm\\)\n with: $1\n Ethnicity: $infoPiece[text() = 'Ethnicity:']/../span[@class=\"smallInfo\"]\n FakeTits: $infoPiece[text() = 'Fake Boobs:']/../span[@class=\"smallInfo\"]\n Piercings: $infoPiece[text() = 'Piercings:']/../span[@class=\"smallInfo\"]\n Tattoos: $infoPiece[text() = 'Tattoos:']/../span[@class=\"smallInfo\"]\n CareerLength: \n selector: $infoPiece[text() = 'Career Start and End:']/../span[@class=\"smallInfo\"]\n postProcess:\n - replace:\n - regex: \\s+to\\s+\n with: \"-\"\n sceneScraper:\n common:\n $performer: //div[@class=\"pornstarsWrapper\"]/a[@data-mxptype=\"Pornstar\"]\n $studio: //div[@data-type=\"channel\"]/a\n scene:\n Title: //div[@id=\"main-container\"]/@data-video-title\n Tags: \n Name: //div[@class=\"categoriesWrapper\"]//a[not(@class=\"add-btn-small \")]\n Performers:\n Name: $performer/@data-mxptext\n URL: $performer/@href\n Studio:\n Name: $studio\n URL: $studio/@href \nSee also #333 for more examples.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#json-scraper-example","title":"JSON scraper example","text":"A performer and scene scraper for ThePornDB is shown below:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#object-fields","title":"Object fields","text":""},{"location":"in-app-manual/scraping/scraperdevelopment/#gallery","title":"Gallery","text":"name: ThePornDB\nperformerByName:\n action: scrapeJson\n queryURL: https://api.metadataapi.net/performers?q={}\n scraper: performerSearch\nperformerByURL:\n - action: scrapeJson\n url:\n - https://api.metadataapi.net/performers/\n scraper: performerScraper\nsceneByURL:\n - action: scrapeJson\n url:\n - https://api.metadataapi.net/scenes/\n scraper: sceneScraper\nsceneByFragment:\n action: scrapeJson\n queryURL: https://api.metadataapi.net/scenes?parse={filename}&hash={oshash}&limit=1\n scraper: sceneQueryScraper\n queryURLReplace:\n filename:\n - regex: \"[^a-zA-Z\\\\d\\\\-._~]\" # clean filename so that it can construct a valid url\n with: \".\" # \"%20\"\n - regex: HEVC\n with:\n - regex: x265\n with:\n - regex: \\.+\n with: \".\"\njsonScrapers:\n performerSearch:\n performer:\n Name: data.#.name\n URL:\n selector: data.#.id\n postProcess:\n - replace:\n - regex: ^\n with: https://api.metadataapi.net/performers/\n\n performerScraper:\n common:\n $extras: data.extras\n performer:\n Name: data.name\n Gender: $extras.gender\n Birthdate: $extras.birthday\n Ethnicity: $extras.ethnicity\n Height:\n selector: $extras.height\n postProcess:\n - replace:\n - regex: cm\n with:\n Measurements: $extras.measurements\n Tattoos: $extras.tattoos\n Piercings: $extras.piercings\n Aliases: data.aliases\n Image: data.image\n\n sceneScraper:\n common:\n $performers: data.performers\n scene:\n Title: data.title\n Details: data.description\n Date: data.date\n URL: data.url\n Image: data.background.small\n Performers:\n Name: data.performers.#.name\n Studio:\n Name: data.site.name\n Tags:\n Name: data.tags.#.tag\n\n sceneQueryScraper:\n common:\n $data: data.0\n $performers: data.0.performers\n scene:\n Title: $data.title\n Details: $data.description\n Date: $data.date\n URL: $data.url\n Image: $data.background.small\n Performers:\n Name: $data.performers.#.name\n Studio:\n Name: $data.site.name\n Tags:\n Name: $data.tags.#.tag\ndriver:\n headers:\n - Key: User-Agent\n Value: Stash JSON Scraper\n - Key: Authorization\n Value: Bearer lPdwFdfY17p4qBkTVF03zscUU2glSjdf17bZyoe # use an actual API Key here\n# Last Updated April 7, 2021\nCode\nDate\nDetails\nPerformers (see Performer fields)\nPhotographer\nRating\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#group","title":"Group","text":"Titlefield is required.Aliases\nBackImage\nDate\nDirector\nDuration\nFrontImage\nName\nRating\nStudio (see Studio Fields)\nSynopsis\nTags (see Tag fields)\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#image","title":"Image","text":"Namefield is required.
"},{"location":"in-app-manual/scraping/scraperdevelopment/#performer","title":"Performer","text":"Code\nDate\nDetails\nPerformers (see Performer fields)\nPhotographer\nRating\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nAliases\nBirthdate\nCareerLength\nCircumcised\nCountry\nDeathDate\nDetails\nDisambiguation\nEthnicity\nEyeColor\nFakeTits\nGender\nHairColor\nHeight\nMeasurements\nName\nPenisLength\nPiercings\nTags (see Tag fields)\nTattoos\nURLs\nWeight\nImportant:
Namefield is required.Note: -
"},{"location":"in-app-manual/scraping/scraperdevelopment/#scene","title":"Scene","text":"Gendermust be one ofmale,female,transgender_male,transgender_female,intersex,non_binary(case insensitive).Code\nDate\nDetails\nDirector\nGroups (see Group Fields)\nImage\nPerformers (see Performer fields)\nStudio (see Studio Fields)\nTags (see Tag fields)\nTitle\nURLs\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#studio","title":"Studio","text":"Titlefield is required only if fileless.Name\nURL\nImportant:
"},{"location":"in-app-manual/scraping/scraperdevelopment/#tag","title":"Tag","text":"Namefield is required.Name\nImportant:
"},{"location":"in-app-manual/tasks/","title":"Tasks","text":""},{"location":"in-app-manual/tasks/#tasks","title":"Tasks","text":"Namefield is required.This page allows you to direct the stash server to perform a variety of tasks.
"},{"location":"in-app-manual/tasks/#scanning","title":"Scanning","text":"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* Accessible in Advanced Mode - 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."},{"location":"in-app-manual/tasks/#auto-tagging","title":"Auto Tagging","text":"See the Auto Tagging page.
"},{"location":"in-app-manual/tasks/#scene-filename-parser","title":"Scene Filename Parser","text":"See the Scene Filename Parser page.
"},{"location":"in-app-manual/tasks/#generated-content","title":"Generated Content","text":"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 Accessible in Advanced Mode - 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 Accessible in Advanced Mode - 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 Accessible in Advanced Mode - 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."},{"location":"in-app-manual/tasks/#transcodes","title":"Transcodes","text":"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.
"},{"location":"in-app-manual/tasks/#image-gallery-thumbnails","title":"Image gallery thumbnails","text":"These are generated when the gallery is first viewed, so generating them beforehand is not necessary.
"},{"location":"in-app-manual/tasks/#cleaning","title":"Cleaning","text":"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.
"},{"location":"in-app-manual/tasks/#exporting-and-importing","title":"Exporting and Importing","text":"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.
\u26a0\ufe0f Note: The full import task wipes the current database completely before importing.
See the JSON Specification page for details on the exported JSON format.
"},{"location":"in-app-manual/tasks/autotagging/","title":"Auto tagging","text":""},{"location":"in-app-manual/tasks/autotagging/#auto-tagging","title":"Auto Tagging","text":"When media filepaths or filenames contain a Performer, Studio, or Tag name, it is assigned those Performers, Studios, and Tags. It will only tag based on Performer, Studio, and Tag names that exist in your database.
When the Performer/Studio/Tag name has multiple words, the search will include paths/filenames where the Performer/Studio/Tag name is separated with
.,-,_, and whitespace characters.For example, auto tagging for performer
Jane Doewill match the following filenames:Jane.Doe.1.mp4Jane_Doe.2.mp4Jane-Doe.3.mp4Jane Doe.4.mp4
Matching is case insensitive, and should only match exact wording within word boundaries. For example, the tag
Jane Doewill not matchMaryjane-DoeorJane-Doen, but will matchMary-Jane-Doe,Jane-Doe_n, and[OF]jane doe.Auto tagging for specific Performers, Studios, and Tags can be performed from the individual Performer/Studio/Tag page.
Note: Performer autotagging does not currently match on performer aliases.
"},{"location":"in-app-manual/tasks/identify/","title":"Identify","text":""},{"location":"in-app-manual/tasks/identify/#identify","title":"Identify","text":"This task iterates through your Scenes and attempts to identify the scene using a selection of scraping sources.
This task accepts one or more scraper sources. Valid scraper sources for the Identify task are stash-box instances, and scene scrapers which support scraping via Scene Fragment. The order of the sources may be rearranged.
For each Scene, the Identify task iterates through the scraper sources, in the order provided, and tries to identify the scene using each source. If a result is found in a source, then the Scene is updated, and no further sources are checked for that scene.
"},{"location":"in-app-manual/tasks/identify/#options","title":"Options","text":"The following options can be set:
Option Description Include male performers If false, then male performers will not be created or set on scenes. Set cover images If false, then scene cover images will not be modified. Set organised flag If true, the organised flag is set to true when a scene is organised. Skip matches that have more than one result If this is not enabled and more than one result is returned, one will be randomly chosen to match Tag skipped matches with If the above option is set and a scene is skipped, this will add the tag so that you can filter for it in the Scene Tagger view and choose the correct match by hand Skip single name performers with no disambiguation If this is not enabled, performers that are often generic like Samantha or Olga will be matched Tag skipped performers with If the above options is set and a performer is skipped, this will add the tag so that you can filter for in it the Scene Tagger view and choose how you want to handle those performersField specific options may be set as well. Each field may have a Strategy. The behaviour for each strategy value is as follows:
Strategy Description Ignore Not set. Overwrite Overwrite existing value. Merge (default) For multi-value fields, adds to existing values. For single-value fields, only sets if not already set.For Studio, Performers and Tags, an option is also available to Create Missing objects. This is enabled by default. When true, if a Studio/Performer/Tag is included during the identification process and does not exist in the system, then it will be created.
Default Options are applied to all sources unless overridden in specific source options.
The result of the identification process for each scene is output to the log.
"},{"location":"in-app-manual/tasks/jsonspec/","title":"Import/export JSON specification","text":""},{"location":"in-app-manual/tasks/jsonspec/#importexport-json-specification","title":"Import/Export JSON Specification","text":"The metadata given to Stash can be exported into the JSON format. This structure can be modified, or replicated by other means. The resulting data can then be imported again, giving the possibility for automatic scraping of all kinds. The format of this metadata bulk is a folder structure, containing the following folders:
filesgalleriesimagesperformersscenesstudiosgroups
When exported, files are named with different formats depending on the object type:
Type Format Files/Folders<path depth in hex, two character width>.<basename>.<hash>.jsonGalleries<first zip filename>.<path hash>.jsonor<folder basename>.<path hash>.jsonor<title>.jsonImages<title or first file basename>.<hash>.jsonPerformers<name>.jsonScenes<title or first file basename>.<hash>.jsonStudios<name>.jsonGroups<name>.jsonNote that the file naming is not significant when importing. All json files will be read from the subdirectories.
"},{"location":"in-app-manual/tasks/jsonspec/#content-of-the-json-files","title":"Content of the json files","text":"In the following, the values of the according jsons will be shown. If the value should be a number, it is written with after comma values (like
29.98or50.0), but still as a string. The meaning from most of them should be obvious due to the previous explanation or from the possible values stash offers when editing, otherwise a short comment will be added.The json values are given as strings, if not stated otherwise. Every new line will stand for a new value in the json. If the value is a list of objects, the values of that object will be shown indented.
If a value is empty in any file, it can be left out of the file entirely. Many files have an
created_atandupdated_at, both are kept in the following format:
Example:YYYY-MM-DDThh:mm:ssTZD \n
"},{"location":"in-app-manual/tasks/jsonspec/#performer","title":"Performer","text":"\"created_at\": \"2019-05-03T21:36:58+01:00\"\n
"},{"location":"in-app-manual/tasks/jsonspec/#studio","title":"Studio","text":"name \nurl \ntwitter \ninstagram \nbirthdate \ndeath_date \nethnicity \ncountry \nhair_color \neye_color \nheight \nweight \nmeasurements \nfake_tits \ncareer_length \ntattoos \npiercings \nimage (base64 encoding of the image file) \ncreated_at \nupdated_at\nrating (integer)\ndetails\n
"},{"location":"in-app-manual/tasks/jsonspec/#scene","title":"Scene","text":"name \nurl \nimage (base64 encoding of the image file) \ncreated_at \nupdated_at\nrating (integer) \ndetails \n
"},{"location":"in-app-manual/tasks/jsonspec/#image","title":"Image","text":"title \nstudio \nurl \ndate \nrating (integer) \ndetails \nperformers (list of strings, performers name) \ntags (list of strings) \nmarkers \n title \n seconds \n primary_tag \n tags (list of strings) \n created_at \n updated_at \nfile (not a list, but a single object) \n size (in bytes, no after comma values) \n duration (in seconds) \n video_codec (example value: h264) \n audio_codec (example value: aac) \n width (integer, in pixel) \n height (integer, in pixel) \n framerate \n bitrate (integer, in Bit) \ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#gallery","title":"Gallery","text":"title \nstudio \nrating (integer) \nperformers (list of strings, performers name) \ntags (list of strings) \nfiles (list of path strings)\ngalleries\n zip_files (list of path strings)\n folder_path\n title (for user-created gallery)\ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#files","title":"Files","text":""},{"location":"in-app-manual/tasks/jsonspec/#folder","title":"Folder","text":"title \nstudio \nurl \ndate \nrating (integer) \ndetails \nperformers (list of strings, performers name) \ntags (list of strings) \nzip_files (list of path strings)\nfolder_path \ncreated_at \nupdated_at \n
"},{"location":"in-app-manual/tasks/jsonspec/#video-file","title":"Video file","text":"zip_file (path to containing zip file)\nmod_time\ntype (= folder)\npath\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#image-file","title":"Image file","text":"zip_file (path to containing zip file)\nmod_time\ntype (= video)\npath\nfingerprints\n type\n fingerprint\nsize\nformat\nwidth\nheight\nduration\nvideo_codec\naudio_codec\nframe\nbitrate\ninteractive (bool)\ninteractive_speed (integer)\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#other-files","title":"Other files","text":"zip_file (path to containing zip file)\nmod_time\ntype (= image)\npath\nfingerprints\n type\n fingerprint\nsize\nformat\nwidth\nheight\ncreated_at\nupdated_at\n
"},{"location":"in-app-manual/tasks/jsonspec/#in-json-format","title":"In JSON format","text":"zip_file (path to containing zip file)\nmod_time\ntype (= file)\npath\nfingerprints\n type\n fingerprint\nsize\ncreated_at\nupdated_at\nFor those preferring the json-format, defined here, the following format may be more interesting:
"},{"location":"in-app-manual/tasks/jsonspec/#performerjson","title":"performer.json","text":"
"},{"location":"in-app-manual/tasks/jsonspec/#studiojson","title":"studio.json","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#performerjson\",\n \"title\": \"performer\",\n \"description\": \"A json file representing a performer. The file is named by a MD5 Code.\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the performer\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"URL to website of the performer\",\n \"type\": \"string\"\n },\n \"twitter\": {\n \"description\": \"Twitter name of the performer\",\n \"type\": \"string\"\n },\n \"instagram\": {\n \"description\": \"Instagram name of the performer\",\n \"type\": \"string\"\n },\n \"birthdate\": {\n \"description\": \"Birthdate of the performer. Format is YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"death_date\": {\n \"description\": \"Death date of the performer. Format is YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"ethnicity\": {\n \"description\": \"Ethnicity of the Performer. Possible values are black, white, asian or hispanic\",\n \"type\": \"string\"\n },\n \"country\": {\n \"description\": \"Country of the performer\",\n \"type\": \"string\"\n },\n \"hair_color\": {\n \"description\": \"Hair color of the performer\",\n \"type\": \"string\"\n },\n \"eye_color\": {\n \"description\": \"Eye color of the performer\",\n \"type\": \"string\"\n },\n \"height\": {\n \"description\": \"Height of the performer in centimeters\",\n \"type\": \"string\"\n },\n \"weight\": {\n \"description\": \"Weight of the performer in kilograms\",\n \"type\": \"string\"\n },\n \"measurements\": {\n \"description\": \"Measurements of the performer\",\n \"type\": \"string\"\n },\n \"fake_tits\": {\n \"description\": \"Whether performer has fake tits. Possible are Yes or No\",\n \"type\": \"string\"\n },\n \"career_length\": {\n \"description\": \"The time the performer has been in business. In the format YYYY-YYYY\",\n \"type\": \"string\"\n },\n \"tattoos\": {\n \"description\": \"Giving a description of Tattoos of the performer if any\",\n \"type\": \"string\"\n },\n \"piercings\": {\n \"description\": \"Giving a description of Piercings of the performer if any\",\n \"type\": \"string\"\n },\n \"image\": {\n \"description\": \"Image of the performer, parsed into base64\",\n \"type\": \"string\"\n },\n \"created_at\": {\n \"description\": \"The time this performers data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this performers data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"details\": {\n \"description\": \"Description of the performer\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"name\", \"ethnicity\", \"image\", \"created_at\", \"updated_at\"]\n}\n
"},{"location":"in-app-manual/tasks/jsonspec/#scenejson","title":"scene.json","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#studiojson\",\n \"title\": \"studio\",\n \"description\": \"A json file representing a studio. The file is named by a MD5 Code.\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"description\": \"Name of the studio\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"URL to the studios websites\",\n \"type\": \"string\"\n },\n \"image\": {\n \"description\": \"Logo of the studio, parsed into base64\",\n \"type\": \"string\"\n },\n \"created_at\": {\n \"description\": \"The time this studios data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this studios data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"details\": {\n \"description\": \"Description of the studio\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"name\", \"image\", \"created_at\", \"updated_at\"]\n}\n
"},{"location":"in-app-manual/tasks/scenefilenameparser/","title":"Scene filename parser","text":""},{"location":"in-app-manual/tasks/scenefilenameparser/#scene-filename-parser","title":"Scene Filename Parser","text":"{\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"$id\": \"https://docs.stashapp.cc/in-app-manual/tasks/jsonspec#scenejson\",\n \"title\": \"scene\",\n \"description\": \"A json file representing a scene. The file is named by the MD5 Code of the file its data is referring to.\",\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"description\": \"Title of the scene\",\n \"type\": \"string\"\n },\n \"studio\": {\n \"description\": \"The name of the studio that produced that scene\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"The url to the scenes original source\",\n \"type\": \"string\"\n },\n \"date\": {\n \"description\": \"The release date of the scene. Its given in the format YYYY-MM-DD\",\n \"type\": \"string\"\n },\n \"rating\": {\n \"description\": \"The scenes Rating. Its given in stars, from 1 to 5\",\n \"type\": \"integer\"\n },\n \"details\": {\n \"description\": \"A description of the scene, containing things like the story arc\",\n \"type\": \"string\"\n },\n \"performers\": {\n \"description\": \"A list of names of the performers in this gallery\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"tags\": {\n \"description\": \"A list of the tags associated with this scene\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"markers\": {\n \"description\": \"Markers mark certain events in the scene, most often the change of the position. They are attributed with their own tags.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"title\": {\n \"description\": \"Searchable name of the marker\",\n \"type\": \"string\"\n },\n \"seconds\": {\n \"description\": \"At what second the marker is set. It is given with after comma values, such as 10.0 or 17.5\",\n \"type\": \"string\"\n },\n \"primary_tag\": {\n \"description\": \"A tag identifying this marker. Multiple markers from the same scene with the same primary tag are concatenated, showing them as similar in nature\",\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"A list of the tags associated with this marker\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"created_at\": {\n \"description\": \"The time this marker was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this marker was updated the last time. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n }\n\n },\n \"required\": [\"seconds\", \"primary_tag\", \"created_at\", \"updated_at\"]\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"files\": {\n \"description\": \"A list of paths of the files for this scene\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"minItems\": 1,\n \"uniqueItems\": true\n },\n \"created_at\": {\n \"description\": \"The time this studios data was added to the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n },\n \"updated_at\": {\n \"description\": \"The time this studios data was last changed in the database. Format is YYYY-MM-DDThh:mm:ssTZD\",\n \"type\": \"string\"\n }\n },\n \"required\": [\"files\", \"created_at\", \"updated_at\"]\n}\nThis tool parses the scene filenames in your library and allows setting the metadata from those filenames.
"},{"location":"in-app-manual/tasks/scenefilenameparser/#parser-options","title":"Parser Options","text":"To use this tool, a filename pattern must be entered. The pattern accepts the following fields:
Field RemarktitleText captured within is set as the title of the scene.extMatches the end of the filename. It is not captured. Does not include the last.character.dMatches delimiter characters (-_.). Not captured.iMatches any ignored word entered in theIgnored wordsfield. Ignored words are entered as space-delimited words. Not captured. Use this to match release artifacts likeDVDRipor release groups.dateMatchesyyyy-mm-ddand sets the date of the scene.ratingMatches a single digit and sets the rating of the scene.performerSets the scene performer, based on the text captured.tagSets the scene tag, based on the text captured.studioSets the studio performer, based on the text captured.{}Matches any characters. Not captured.\u26a0\ufe0f Note:
performer,tagandstudiofields will only match against Performers/Tags/Studios that already exist in the system.The
performer/tag/studiofields will remove any delimiter characters (.-_) before querying. Name matching is case-insensitive.The following partial date fields are also supported. The date will only be set on the scene if a date string can be built using the partial date components:
Field RemarkyyyyFour digit yearyyTwo digit year. Assumes the first two digits are20mmTwo digit monthmmmThree letter month, such asJan(case-insensitive)ddTwo digit dateThe following full date fields are supported, using the same partial date rules as above:
yyyymmddyymmddddmmyyyyddmmyymmddyyyymmddyy
All of these fields are available from the
Add Fieldbutton.Title generation also has the following options:
Option Remark Whitespace characters These characters are replaced with whitespace (defaults to._, to handle filenames likethree.word.title.aviCapitalize title capitalises the first letter of each wordThe fields to display can be customised with the
"},{"location":"in-app-manual/tasks/scenefilenameparser/#applying-the-results","title":"Applying the results","text":"Display Fieldsdrop-down section. By default, any field with new/different values will be displayed.Once the options are correct, click on the
Findbutton. The system will search for scenes that have filenames that match the given pattern.The results are presented in a table showing the existing and generated values of the discovered fields, along with a checkbox to determine whether or not the field will be set on each scene. These fields can also be edited manually.
The
Applybutton updates the scenes based on the set fields.\u26a0\ufe0f Note: results are paged and the
"},{"location":"installation/","title":"Installation","text":"Applybutton only applies to scenes on the current page.Stash offers native binaries for the following platforms:
- Windows
- macOS
- Linux
- FreeBSD
- Docker
All official binaries can be downloaded from our GitHub release page. Latest version is available here.
Official Docker image is hosted on Docker Hub. Latest version can be pulled from
"},{"location":"installation/docker/","title":"Docker","text":"stashapp/stash:latest.Info
Before starting make sure your system has Docker installed. You can follow the instructions on how to install Docker from Docker Docs.
Info
Official Stash image is located at
stashapp/stash.Note
Stash README on Docker installation is available here.
"},{"location":"installation/docker/#using-docker-compose","title":"Using Docker Compose","text":""},{"location":"installation/docker/#install","title":"Install","text":"- Download and save
docker-compose.ymlfile from our GitHub. - Modify the
docker-compose.ymlfile to your preferences. - Open terminal in the same directory as saved
docker-compose.ymlorcdto that directory. - Run
docker-compose up -d. - Installing this way will bound Stash to port 9999.
- If everything went well Stash will be available at http://localhost:9999 locally or on your network http://YOUR-LOCAL-IP:9999.
If you are upgrading from older than v0.20 version make sure to re-download the
docker-compose.ymlfile from our GitHub as new volume was added. Alternatively you can edit thedocker-compose.ymlto manually include new volume- ./blobs:/blobs.- Go to the directory where
docker-compose.ymlis saved. - Run
docker-compose pull. Pulls the new image. - Run
docker-compose down. Removes old container. - Run
docker-compose up -d. Creates and starts the new container. - Make sure the mount points and settings are the same as in previous
docker-compose.ymlfile.
- Go to the directory where
docker-compose.ymlis saved. - Run
docker container kill. Force stops the container. - Run
docker container rm. Removes the container. - Delete
docker-compose.ymlfile.
Info
The following step by step was tested using TrueNAS Scale Cobia (23.10.1.3).
"},{"location":"installation/freenas-truenas/#installation","title":"Installation","text":"To install the stashapp, we will use the TrueCharts app database. To install, we'll follow the official documentation at https://truecharts.org/manual/SCALE/guides/getting-started/
- Go to Apps page from the top level SCALE menu
- Click Discover Apps button on the Apps page
- Click Manage Catalogs link on the Discover Apps page
- Click Add Catalog
- After reading the iXsystems notice, click Continue and enter the required information: Name: truecharts Repository: https://github.com/truecharts/catalog Preferred Trains: enterprise, stable and operators (type each one manually) Branch: main
- Click Save and allow SCALE to refresh its catalog with TrueCharts (this may take a few minutes)
After the update is complete, use the search bar to search for \"stash\". When found, click Install.
"},{"location":"installation/freenas-truenas/#options","title":"Options","text":"The installation window will contain several customizable options, but the most important one is the storage option. Search for \"Additional App Storage\" on the page and click \"Add\".
In \"Type of Storage\", select \"Host Path\" if the desired folder is a Dataset. \"Host Path\" should be where your content will be. \"Mount Path\" is the name that appears in the stash for the selection. You can put anything here, like /stash-content for example. After that, click Install.
Installation will take a few minutes. After the stash appears as \"Running\", click \"Open\" on the right and continue with the stash configuration. When entering the folder that contains its contents, remember to search for the same name you entered previously. In the case of this guide, the name was /stash-content.
"},{"location":"installation/freenas-truenas/#truenas-core","title":"TrueNAS Core","text":"Info
We are now offering pre-compiled FreeBSD binary. You can grab it from release page.
Warning
The install guide below was reported as outdated.
"},{"location":"installation/freenas-truenas/#caveats-and-assumptions","title":"Caveats and assumptions","text":"- The method documented here has only been given cursory testing, so there may be compatibility problems.
- This method assumes that Stash will be run within a previously created iocage jail - the process to create and configure the jail is not included here.
- If the jail is in NAT mode, ensure that port 9999 is forwarded to your TrueNAS host.
- The alternative to this method is to compile from source, which is a more involved process and not documented here
In order for the
stash-linuxbinary to work in a FreeBSD system, Linux compatibility must be enabled both in the system and the jail. To enable Linux compatibility:- navigate to
System -> Tunablesin the TrueNAS Web UI - click
Addand enter the following:- Variable:
linux_enable - Value:
YES - Type:
rc.conf
- Variable:
- Click submit.
- In a shell in your iocage jail, edit
/etc/rc.confto add:enable_linux=\"YES\"\n - Reboot the system.
Go into your iocage jail and install
ffmpeg
"},{"location":"installation/freenas-truenas/#create-user-and-group","title":"Create user and group","text":"pkg install ffmpeg\nIt is recommended to not run services as root. Adjust this step to your system. in this example the user
stashwill be created and set to run the service.
"},{"location":"installation/freenas-truenas/#download-stash-linux","title":"Download stash-linux","text":"pw useradd -n stash -u 1069 -d /nonexistent -s /usr/sbin/nologin\nChoose where you would like to store the binary, in this example
/usr/local/binis selected as this is where the ffmpeg binaries also reside. Check github for latest release. Also remember to fix permissions and ownership
"},{"location":"installation/freenas-truenas/#create-configuration-directory","title":"Create configuration directory","text":"cd /usr/local/bin\nfetch https://github.com/stashapp/stash/releases/download/v0.22.1/stash-linux\nchown stash:stash stash-linux\nchmod +x stash-linux\nstash needs a directory for its config file, database and more. Remember to change ownership and permission for the folder you select. The script we will look at in the next step has this path as the default:
"},{"location":"installation/freenas-truenas/#rcd-startup-script","title":"rc.d startup script","text":"mkdir /usr/local/etc/stash\nchown stash:stash /usr/local/etc/stash\nIn order for stash to run as a daemon in the background, and also start at boot, you need a rc.d script.
Enter the following in the editor:mkdir /usr/local/etc/rc.d\nee /usr/local/etc/rc.d/stash\n
To save, press#!/bin/sh\n\n# PROVIDE: stash\n# REQUIRE: DAEMON\n# KEYWORD: shutdown\n\n\n. /etc/rc.subr\n\nname=stash\nrcvar=stash_enable\n\nload_rc_config $name\n\n: ${stash_enable:=\"NO\"}\n: ${stash_user:=\"stash\"}\n: ${stash_group:=\"stash\"}\n: ${stash_config_dir:=\"/usr/local/etc/stash/config.yml\"}\n: ${stash_exec_bin:=\"/usr/local/bin/stash-linux\"}\n\n#daemon\npidfile=\"/var/run/${name}.pid\"\ncommand=\"/usr/sbin/daemon\"\ncommand_args=\"-f -P ${pidfile} ${stash_exec_bin} --config ${stash_config_dir}\"\nstart_precmd=\"stash_precmd\"\n\nstash_precmd() {\n install -o ${stash_user} -g ${stash_group} /dev/null ${pidfile}\n}\n\nrun_rc_command $1\nESC + Enterand confirm withaand make it executable withchmod +x /usr/local/etc/rc.d/stash"},{"location":"installation/freenas-truenas/#enable-the-service-at-boot","title":"Enable the service at boot","text":"If you want Stash to run when you start the jail, run the following command:
And to start the service, reboot the jail or run this command:sysrc \"stash_enable=YES\"\n
Stash is now available at http://jail-IP:9999/service stash start\nDuring setup you can leave all the paths for config, database and etc empty to use the default. They will then be stored in the config-folder we created earlier so you can easily backup the folder. Only add your media content.
"},{"location":"installation/freenas-truenas/#optional-steps","title":"Optional steps","text":"You can change the location where stash stores the configuration files and database. Please note that the path needs to end with
config.ymleven if it does not exist yet. Stash will create it for you. Remember to fix ownership and permissions of the location you choose.sysrc \"stash_config_dir=path/to/location/config.yml\"\nYou can change the user and group that Stash runs as. Remember that the config_dir needs to be owned by the user that Stash runs as, aswell as the stash-linux binary
sysrc \"stash_user=usernamegoeshere\"\nsysrc \"stash_group=groupnamegoeshere\"\nIts also possible to change the location of the stash-linux binary ``` sysrc \"stash_exec_bin=/path/to/stash-linux\"
"},{"location":"installation/linux/","title":"Linux","text":"Info
It is recommended that you install
ffmpegfrom your distribution's package manager. In case you don't, Stash will prompt you to download a copy during setup.Note
Stash offers different binaries for different architectures. You can find your processor architecture by running a simple command
uname -pin a terminal. Replace<binary-name>in the following tutorial accordingly.
"},{"location":"installation/linux/#install","title":"Install","text":"stash-linux= amd64 (x86_64)stash-linux-arm32v6= arm32v6 (armel)stash-linux-arm32v7= arm32v7 (armhf)stash-linux-arm64v8= arm64v8 (arm64)- Download latest
<binary-name>binary from GitHub repository depending on your architecture. - Run
./<binary-name>from the terminal. - If you have trouble, try running
chmod u+x <binary-name>to make the file executable. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either by closing the terminal window or by stopping the process from task manager.
- Download latest
<binary-name>binary from GitHub repository. - Delete old
<binary-name>binary and replace it with the newly downloaded one. - Run
./<binary-name>from the terminal. - If you have trouble, try running
chmod u+x <binary-name>to make the file executable. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
<binary-name>binary file. - Delete
$HOME/.stashfolder.
On macOS, Stash can be run as either a packaged app (
"},{"location":"installation/macos/#packaged-app","title":"Packaged app","text":"Stash.app) or as a command-line app (stash-macos). Both are universal apps, and will therefore run natively on both Apple silicon and Intel-based Macs.Note
The packaged app is recommended for most users.
It supports desktop notifications, displays a menu bar icon, and does not need to be launched from the terminal.
However, due to app restrictions, it only supports setting up in
"},{"location":"installation/macos/#install","title":"Install","text":"$HOME/.stash. If you would like to use a different folder, then you will need to use the command-line app.- Download the latest
Stash.app.zipfrom GitHub repository. - Open
Stash.app.ziparchive and drag theStashapp to your Applications folder. - Open the
Stashapp. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either via icon in the menu bar or by stopping the process from Activity Monitor.
- Download latest
Stash.app.zipfrom GitHub repository. - Delete old
Stashapp. - Open newly downloaded
Stash.app.ziparchive and drag theStashapp to your Applications folder. - Open the
Stashapp. - If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
Stashapp. - Delete
$HOME/.stash.
Note
The command-line app is only recommended for users who are familiar with the terminal, or for those who do not want to set up in
$HOME/.stash.It does not support desktop notifications and does not display a menu bar icon. It must be launched from the terminal.
"},{"location":"installation/macos/#install_1","title":"Install","text":"- Download latest
stash-macosbinary from GitHub repository. -
Run
./stash-macosfrom the terminal.If you have trouble, try running
chmod u+x stash-macosto make the file executable. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- Stop Stash server. Either by closing the terminal window or by stopping the process from Activity Monitor.
- Download latest
stash-macosbinary from GitHub repository. - Delete old
stash-macosbinary and replace it with the newly downloaded one. -
Run
./stash-macosfrom the terminal.If you have trouble, try running
chmod u+x stash-macosto make the file executable. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete
stash-macos. - Delete
$HOME/.stash.
Info
Written by Muldec.
"},{"location":"installation/synology/#foreword","title":"Foreword","text":"Synology devices comes in two categories: those who support containerization through Docker, and those who don't. To see in which category you stand, refer to the \"Applied Models\" section of the Docker Package page.
Now, follow the installation instructions based on whether you can use Docker or you cannot use Docker.
"},{"location":"installation/synology/#to-install-stash-with-docker","title":"To install Stash with Docker","text":"Note
Running Stash without Docker is possible even if your NAS is Docker ready. It offers more control on your Stash instance startup. As an example, it allows you to store your porn collection in an Encrypted Shared Folder, and only run Stash when the Encrypted folder is Mounted (Decrypted).
- Make sure the Docker app is installed and running correctly.
- Search the registry for stash and install.
- Create a stash image with the following set up in 'Advanced Settings':
(These will need to be the same as the Volumes you created in the \"Volume\" tab.)
variable Value PATH (keep as is) STASH_CACHE /cache STASH_METADATA /metadata STASH_GENERATED /generated STASH_STASH /data"},{"location":"installation/synology/#port-settings-section","title":"\"Port Settings\" section","text":"You will need to set a default port in the \"Port\" section, otherwise Docker will assign a different port every time Stash is launched. Leave the container port as-is.
"},{"location":"installation/synology/#network-section","title":"\"Network\" section","text":"Select the \"host\" network rather than \"bridge\".
(Thanks to backer Herelam80 for these instructions)
"},{"location":"installation/synology/#to-install-stash-without-docker","title":"To install Stash without Docker","text":"Warning
This method uses SSH to run command lines on the NAS. If you are unfamiliar with SSH or linux command lines, I suggest you not to go further, as making a mistake in the SSH session can really screw your NAS.
This is intended to work on DSM 7.0 and later. It will not work on any version prior to 7.0.
"},{"location":"installation/synology/#install-prerequisites","title":"Install Prerequisites","text":"In DSM, navigate to
Package Center > Settings. In thePackage Sourcestab, clickAdd, type SynoCommunity as Name and https://packages.synocommunity.com/ as Location and then pressOKto validate.Go back to the Package Center and look for
Python 3.11in the Community tab. Click onInstalland agree to the Third-Party Package warning.Then look for
"},{"location":"installation/synology/#enable-ssh","title":"Enable SSH","text":"Ffmpeg 6in the Community tab. Click onInstalland agree to the Third-Party Package warning.In DSM, navigate to
"},{"location":"installation/synology/#create-a-user-that-will-run-stash","title":"Create a user that will run stash","text":"Control Panel > Connectivity > Terminal & SNMPand check theEnable SSH servicebox.- In DSM, navigate to
Control Panel > File Sharing > User & Group - Click on the
Createbutton - Give it a name (eg stash) and a Password (you will need it later)
- Click
Nextuntil you are on the \"Join groups\" screen - Assign the user to the \"administrators\" group (this will be removed later, but is required by Synology to be able to use SSH (I know, it's stupid) and complete the installation properly)
- Click
Nextuntil you are on the \"Assign shared folders permissions\" screen - Assign the Read/Write permission to your porn folder (the write permission is needed to allow the deletion of clips from the stash app)
- Click
Nextuntil you are on the \"Assign application permissions\" screen - Check
Denyfor all applications - Click
Nextuntil you can click onDone
In your terminal, connect to your NAS using the newly created account that is part of the administrators group.
"},{"location":"installation/synology/#link-ffprobe-ffmpeg","title":"Link ffprobe & ffmpeg","text":"ssh stash@your_nas_hostname\nffmpeg has been installed earlier, but is missing a link to ffprobe (also installed) and the new version of ffmpeg. Run the following command.
"},{"location":"installation/synology/#download-stash","title":"Download Stash","text":"sudo ln -s /var/packages/ffmpeg6/target/bin/ffprobe /usr/local/bin/ffprobe\nsudo ln -s /var/packages/ffmpeg6/target/bin/ffmpeg /usr/local/bin/ffmpeg\nDownload the lastest version of Stash and its checksum from GitHub
# find what architecture your Synology is running on\nuname -m\n\n# depending on the architecture, you'll have to download the right version of stash\n\n# x86_64\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux\n# armv6l\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm32v6\n# armv7l\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm32v7\n# aarch64\nwget https://github.com/stashapp/stash/releases/latest/download/stash-linux-arm64v8\n\n# Download the CHECKSUM\nwget https://github.com/stashapp/stash/releases/latest/download/CHECKSUMS_SHA1\n\n# Perform the checksum validation\nsha1sum -c --ignore-missing CHECKSUMS_SHA1\n\n# you should see a line that says `stash-linux: OK`\n# if not, something went wrong during the download\n\n# Clean up the now unnecessary file\nrm CHECKSUMS_SHA1\nDanger
DO NOT run stash yet or it will generate a bunch of files/folders where we don't want them.
"},{"location":"installation/synology/#python","title":"Python","text":"Prepare a Python environment (for scrapers and plugins)
"},{"location":"installation/synology/#configure-your-nas-to-run-stash","title":"Configure your NAS to run Stash","text":"python3.11 -m ensurepip --Update\npython3.11 -m venv stash-env\nsource stash-env/bin/activate\npip3 install pipreqs\nCreate a profile file
echo 'PATH=/usr/local/bin:$PATH' > .profile\necho 'source stash-env/bin/activate' >> .profile\nCreate the service file by running
cat > stash.service, copy/pasting the following, and hitting CTRL+D when it's done to save the file (hit again if you are not back to the prompt):[Unit]\nDescription=Run Stash at startup\nAfter=network.target\n\n[Service]\nWorkingDirectory=/var/services/homes/stash\nType=simple\nUser=stash\nExecStart=/bin/bash -c -l '\\\n exec ./stash-linux'\nRestart=on-failure\n\n[Install]\nWantedBy=multi-user.target\nNote
Change the
ExecStartline by providing the exact name of the stash executable that you downloaded previously.Start and activate the service
"},{"location":"installation/synology/#verify-that-it-is-working","title":"Verify that it is working","text":"sudo systemctl enable \"$(pwd)/stash.service\"\nsudo systemctl start stash.service\nYou can now access to stash by navigating to your NAS url on port 9999:
"},{"location":"installation/synology/#installing-scrapers-and-plugins","title":"Installing Scrapers and Plugins","text":"http://nas-hostname:9999Whenever you install a new Python scraper or plugin, do the following from the stash user home directory:
pipreqs .stash/.\npip3 install -r .stash/requirements.txt\nNote
Using pipreqs allows to scan all scrapers and plugins installed and find dependencies that they require. You can do the same thing without
"},{"location":"installation/synology/#remove-stash-user-from-administrator-group","title":"Remove stash user from administrator group","text":"pipreqsby going into each individual directory and runpip3 install -r requirements.txt- Go back to DSM, navigate to
Control Panel > File Sharing > User & Group - Click on the stash user and then on
Edit - In the
User Groupstab, uncheck \"administrators\" and click onSave
Info
Unraid app is maintained by a 3rd party. For Unraid specific support you can go to support thread by CorneliousJD.
Note
For users that want to try the development branch of Stash you can change the repository to
"},{"location":"installation/unraid/#install","title":"Install","text":"stashapp/stash:development.- Open Unraid and go to the
Appstab. - Enable apps (if disabled) and search for
Stash. - You can modify paths to your preference.
- Go to Docker tab and enable autostart for
Stash.
Info
binarygeek119/stash-cuda:latestrepository is not maintained by Stash core team.-
First off you need the unraid Nvidia plugin for this to work. On Unraid go to apps and do a search for
nvidia driverand install, this will take some time to install. When the dialog is done it is still installing in the background. When it has finshed you will get a popup saying it is safe to reboot now.Warning
Do not restart Unraid server until the plugin is done installing itself!
-
After getting the popup, reboot your server. After it back online you may continue to the next steps.
- To begin modifing start by going into edit mode by right click on stash icon on Unraid dashboard or in Docker tab.
- In edit mode go to the top and click on basic view to switch to advaced view.
"},{"location":"installation/unraid/#container-configuration","title":"Container configuration","text":"Now we can change some thing to have Stash work with a Nvidia GPU.
- Under Repository change the default Repository from
stashapp/stash:developmenttobinarygeek119/stash-cuda:latest. - Add the following under Extra Parameters:
--runtime=nvidia. - Go down to the bottom of the page and click on
Add another Path, Port, Variable, Label or Device. - Change
pathtoVariableand add the following:Name:enterNVIDIA_DRIVER_CAPABILITIESKey:enterNVIDIA_DRIVER_CAPABILITIESValue:enteralland click save.
- Go down to the bottom of the page and click on
Add another Path, Port, Variable, Label or Device. - Change
pathtoVariableand add the following:Name:enterNVIDIA_VISIBLE_DEVICESKey:enterNVIDIA_VISIBLE_DEVICESValue:enterGPU-xxxx-xxxx-xxx-xxxx-xxxx-xxx-xxxxxxxxxxxx
Where
GPU-xxxx-xxxx-xxx-xxxx-xxxx-xxx-xxxxxxxxxxxxyou must enter your own GPUID. To find it do the folowing:- On a new Unraid page click on settings.
- Go down to the bottom and click Nvidia Driver plugin.
- Copy the key and paste it under
VariablecalledValue.
- Click on save.
- Now click on apply and let the Docker download the new Nvidia version of Stash.
- Enjoy and use as before.
Note
Some Windows 11 versions might open Stash via Terminal instead of going to notification area. You can bypass that by running the program as administrator or use a shortcut to run it via conhost.exe. As a result of running as administrator Stash might fail to detect your Python installtion in PATH, so you need point it the correct way yourself after installation. In Settings > System and under Applications Paths header set Python Executable Path.
"},{"location":"installation/windows/#install","title":"Install","text":"- Download latest
stash-win.exebinary from GitHub repository. -
Run the executable (typically
stash-win.exe).Running the executable might present a security prompt since the binary isn't signed yet. Just click more info and then the
run anywaybutton. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- The program will show an icon in your notification area. You can access some quick links or quit the server from there.
- Stop Stash server. Either via icon in the notification area or by stopping the process from Task Manager.
- Download latest
stash-win.exebinary from GitHub repository. - Delete old
stash-win.exebinary and replace it with the newly downloaded one. -
Run the executable (typically
stash-win.exe).Running the executable might present a security prompt since the binary isn't signed yet. Just click more info and then the
run anywaybutton. -
If everything went well, it should open a browser tab http://localhost:9999 to get started.
- You might be asked to perform a database migration depending on the changes included in the new release. Follow the steps.
- Automatic backup will be performed before the migration.
- If any issues arise during the migration your database will be automatically restored from the backup.
- You should be good to go.
- Stop Stash server.
- Delete the
stash-win.exebinary file. - Delete
%userprofile%/.stashfolder.
Info
Integrations are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Integrations are ways to integrate Stash into other programs.
To install follow the provided install instructions.
"},{"location":"integrations/list/","title":"Browse integrations","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Integration no longer worksIf you found that integration is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"integrations/list/#jellyfinpluginstash","title":"Jellyfin.Plugin.Stash","text":"DescriptionAuthorScreenshotsPulls data from your Stash using the filename to query on.
DirtyRacer1337
"},{"location":"integrations/list/#pluginvideostash","title":"plugin.video.stash","text":"DescriptionAuthorScreenshotsplugin.video.stash is an add-on for the Kodi home theater center software to incorporate Stash, an organizer for your porn.
gitgiggety
"},{"location":"integrations/list/#stashplexagentbundle","title":"StashPlexAgent.bundle","text":"DescriptionAuthorScreenshotsA very simplistic Plex agent to pull metadata from Stash.
Darklyter
"},{"location":"metadata-sources/","title":"Metadata sources","text":"There are several ways to get metadata into Stash.
You can configure your metadata sources under Settings > Metadata Providers. See sections below for more details.
- stash-box instances - more automatic, crowdsourced metadata
- Scrapers - more individual, can be used for different databases, official studios
Scrapers are the way to retrieve information from websites for your scenes/groups/galleries/performers. Using scrapers wisely, you can avoid typing information manually and repetitively. They can help you quickly establish links between groups/scenes and performers/studios, add relative tags, then download covers/posters for easy recognition. It's a great feature to organize your video or image collections.
"},{"location":"metadata-sources/scrapers/#managing-scrapers","title":"Managing scrapers","text":"Scrapers can be installed and managed from the Settings > Metadata Providers page.
Scrapers are installed using the Available Scrapers section. The Community (stable) source is configured by default.
Installed plugins can be updated or uninstalled from the Installed Scrapers section.
"},{"location":"metadata-sources/scrapers/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for scrapers. To add a new source go to Settings > Metadata Providers page and under Available Scrapers click Add Source.
"},{"location":"metadata-sources/scrapers/#installing-scrapers-manually","title":"Installing scrapers manually","text":"By default, Stash looks for scrapers configurations in the scrapers sub-directory of the directory where the stash
config.ymlis read. This will either be the%USERPROFILE%\\.stash\\scraperson Windows or/root/.stash/scraperson Unix systems (Mac, Linux, etc.) or the current working directory.Scrapers are added by adding configuration yaml files (format:
scraperName.yml) to thescrapersdirectory.Loaded scrapers can be viewed in the Settings > Metadata Providers page. After scrapers are added, removed or edited while Stash is running, they can be reloaded by clicking Reload scrapers button.
CommunityScrapers repository is the source for community maintained scrapers.
"},{"location":"metadata-sources/scrapers/#scraper-types","title":"Scraper types","text":""},{"location":"metadata-sources/scrapers/#by-searching-type","title":"By searching type","text":""},{"location":"metadata-sources/scrapers/#fragment","title":"Fragment","text":"This kind of scrapers will fetch the metadata from a website, by using existing data from Stash, like a scene's file name, performer's name...etc. Fragment scrapers will get all the data Stash knows about that scene/performer/gallery, so it's quite flexible when fetching information.
"},{"location":"metadata-sources/scrapers/#search-by-name","title":"Search by name","text":"A Search-By-Name scraper will get only \"name\" input from a scene or performer, then it will search a website with that name, and return a list of results.
Scrapers includes: Babepedia.yml, FreeonesCommunity.yml, IAFD.yml
"},{"location":"metadata-sources/scrapers/#search-by-url","title":"Search by URL","text":"Most scrapers fetch metadata from a given URL, either by using XPath, JSON, or scripts. For this kind of scrapers you need to know the URL for that scene/performer/gallery/group so they can extract information from it.
Scrapers includes: All other scrapers.
"},{"location":"metadata-sources/scrapers/#by-implementation","title":"By implementation","text":""},{"location":"metadata-sources/scrapers/#xpath-and-json-scrapers","title":"XPath and JSON scrapers","text":"This is the most common type of scrapers, which use either XPath parser to pin-point the information and retrieve them, or send out JSON requests to get the information. xpathScraper and jsonScraper can be mixed in the same .yml file.
"},{"location":"metadata-sources/scrapers/#cdp-scrapers","title":"CDP scrapers","text":"This type of scrapers is mostly the same as XPath/JSON scrapers, except it will launch a headless Chrome browser to retrieve the information from websites. It can also get cookies, simulate a mouse click and other actions. These scrapers have
"},{"location":"metadata-sources/scrapers/#python-ruby-scrapers","title":"Python / Ruby scrapers","text":"useCDP: truesetting in them.This type of scrapers will launch Python, Ruby to retrieve information from websites. Script scrapers are powerful, versatile and cross-platform. So they usually can do much more than regular scrapers. To install this kind of scrapers, you need to copy not only the .yml file, but also all the script files like .py, .rb that associated with it.
"},{"location":"metadata-sources/scrapers/#more-details","title":"More details","text":"You can view the detailed information about scrapers here or CommunityScrapers README.
"},{"location":"metadata-sources/scrapers/#create-your-own","title":"Create your own","text":"To create your own scraper, there is detailed information about that as well. Best way to start is to read the simple ones and understand how xpath works. The XPath Cheetsheet is quite useful in creating a .yml file. In Firefox you can use xpath search in \"Web Developer Tools (F12)\". The \"search HTML\" bar actually accepts xpath searches. You can use it to verify your xpath queries.
"},{"location":"metadata-sources/scrapers/#contribution","title":"Contribution","text":"The Scraper community always welcome new members. If you create a nice scraper and find it stable and useful, you can share it via the GitHub repository. Create a pull request, and let the mod review your work. The mods are busy, so it will probably take a few days, or a couple of weeks, but it will be a great feeling once your contribution is accepted by the community.
"},{"location":"metadata-sources/stash-box-instances/","title":"stash-box instances","text":""},{"location":"metadata-sources/stash-box-instances/#fansdb","title":"FansDB","text":"FansDB is a community-driven metadata database focused on adult content platforms (OnlyFans, Fansly, ManyVids, etc.) where the independent creators are the primary focus.
Website | Guidelines | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#javstash","title":"JAVStash","text":"https://fansdb.cc/graphql| JoinJAVStash is a metadata database focused on Japanese Adult Video (JAV) content and their original metadata in Japanese. Primarily driven by automated scrapers.
Website | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#pmv-stash","title":"PMV Stash","text":"https://javstash.org/graphql| Join1PMV Stash is a community-driven metadata database focused on remixed pornographic art such as Porn Music Videos (PMV), Cock Hero (CH), Hypno Vids, Compilations.
Website | Guidelines | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#stashdb","title":"StashDB","text":"https://pmvstash.org/graphql| JoinStashDB is a community-driven metadata database focused on digital scenes of all orientations.
Website | Guidelines | Community forum | Discord | Endpoint
"},{"location":"metadata-sources/stash-box-instances/#theporndb","title":"ThePornDB2","text":"https://stashdb.org/graphql| JoinThePornDB is a metadata database focused on digital scenes and movies. Driven by automated scrapers.
Website | Discord | Endpoint
https://theporndb.net/graphql3 | Join4-
Link leads to a private Discord server. If you are getting that the link is invalid, make sure to join the private Discord server first!\u00a0\u21a9
-
Uses proprietary implemetation of stash-box API.\u00a0\u21a9
-
Has a different endpoint for movies and JAV. For movies use
https://theporndb.net/graphql?type=Movie, for JAV usehttps://theporndb.net/graphql?type=JAV.\u00a0\u21a9 -
Requires registration to access the site.\u00a0\u21a9
Stash data is considered private, and Stash is not designed to be publicly exposed, except to trusted confidants. Stash has a built-in protection against accidentally exposing itself publicly outside of your network. If Stash receives a request from the public internet, and you do not have a password enabled, Stash will reject the request and stop handling requests to protect your privacy.
This often happens when you use the port-forwarding feature of your router or install Stash on a publicly accessible server, such as a VPS. When you do this, anybody in the world can access your Stash instance, so we enforce a password requirement. If your Stash instance has shutdown due to an insecure configuration, it will not handle requests again until you tell it that you have fixed the problem. After setting up either authentication, firewall, or removing your port forwarding rules, you can edit
"},{"location":"networking/authentication-required-when-accessing-stash-from-the-internet/#alternative-and-safe-methods-to-access-your-stash","title":"Alternative and safe methods to access your Stash","text":".stash/config/config.ymland remove the keysecurity_tripwire_accessed_from_public_internet.You may use several methods to safely access Stash from outside of your home network. In the most basic, you can enable authentication in Stash, and re-enable port forwarding. You can also use a VPN solution that allows you to securely access your home network, such as Tailscale, Zerotier, Wireguard, or others.
"},{"location":"networking/authentication-required-when-accessing-stash-from-the-internet/#using-an-external-authentication-provider","title":"Using an external authentication provider","text":"If you are an advanced user, and have secured your Stash instance behind an authwall provided by a reverse proxy or hosting solution, you may continue to use that. You simply have to edit
"},{"location":"plugins/","title":"Plugins","text":".stash/config/config.ymland setdangerous_allow_public_without_authtotrue. If you have already tripped the security feature, you will also have to remove thesecurity_tripwire_accessed_from_public_internetkey in order to allow Stash to serve requests.Info
Plugins are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Plugins adds further features that Stash doesn't itself provide.
"},{"location":"plugins/#managing-plugins","title":"Managing plugins","text":"Plugins can be installed and managed from the Settings > Plugins page.
Plugins are installed using the Available Plugins section. The Community (stable) source is configured by default.
Installed plugins can be updated or uninstalled from the Installed Plugins section.
"},{"location":"plugins/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for plugins. To add a new source go to Settings > Plugins page and under Available Plugins click Add Source.
"},{"location":"plugins/#installing-plugins-manually","title":"Installing plugins manually","text":"By default, Stash looks for plugin configurations in the plugins sub-directory of the directory where the stash
config.ymlis read. This will either be the%USERPROFILE%\\.stash\\pluginson Windows or/root/.stash/pluginson Unix systems (Mac, Linux, etc.) or the current working directory.Plugins are added by adding configuration yaml files (format:
pluginName.yml) to thepluginsdirectory.Loaded plugins can be viewed in the Settings > Plugins page. After plugins are added, removed or edited while Stash is running, they can be reloaded by clicking Reload plugins button.
"},{"location":"plugins/list/","title":"Browse plugins","text":""},{"location":"plugins/list/#browse-plugins","title":"Browse plugins","text":""},{"location":"plugins/list/#sources","title":"Sources","text":"- https://7djx1qp.github.io/stash-plugins/main/index.yml
- https://blackstar3000.github.io/stash-plugins-blackstar/main/index.yml
- https://carrotwaxr.github.io/stash-plugins/stable/index.yml
- https://ceequester.github.io/CommunityScripts/stable/index.yml
- https://coderdudeo.github.io/CoderDudeo-Stash-Plugins/index.yml
- https://f4bio.github.io/stash-plugins/main/index.yml
- https://feederbox826.github.io/plugins/main/index.yml
- https://feederbox826.github.io/stashlist/main/index.yml
- https://jsmthy.github.io/stash-plugins/main/index.yml
- https://lurking987.github.io/stash-plugins/main/index.yml
- https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml
- https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml
- https://rosa-umineko.github.io/CommunityScripts/stable/index.yml
- https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml
- https://serechops.github.io/Serechops-Stash/index.yml
- https://sneakyninja256.github.io/stash-plugins/stable/index.yml
- https://spaceyuck.github.io/stash-plugins/index.yml
- https://stash-of-awesomeness.github.io/stash-plugins/main/index.yml
- https://stashapp.github.io/CommunityScripts/stable/index.yml
- https://stg-annon.github.io/StashScripts/stable/index.yml
- https://tetrax-10.github.io/stash-stuffs/index.yml
- https://valkyr-js.github.io/stash-plugins/index.yml
- https://voidimproper.github.io/stash-plugins/main/index.yml
- https://w0lfiew0lf.github.io/StashApp-Tools/index.yml
- https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml
- https://xiosensei.github.io/Xio-Stash/index.yml
Auto add images to tags using first found image from Google API. Requires modifying the .py file to provide your own API key and CSE ID
https://rosa-umineko.github.io/CommunityScripts/stable/index.yml\nNo README available
rosa-umineko
"},{"location":"plugins/list/#add-secondary-performer-image","title":"Add secondary performer image","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds support for a secondary perfomrer image on the perform details page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#addtional-files-deleter","title":"Addtional Files Deleter","text":"DescriptionSource URLREADMEAuthorScreenshotsDeletes addtional files assosiated with an image or scene object. Which will usually have identical PHashes for scenes or Checksum for images. Unless is a scene manually merged. Apply ignore tag to scene/image object for plugin to bypass.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#adulttime-interactive-downloader","title":"Adulttime Interactive Downloader","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload Interactive Files for Adulttime Scenes
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
tooliload
"},{"location":"plugins/list/#ai-tagger","title":"AI Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsTag videos and Images with Locally hosted AI using Skier's Free and Patreon AI models
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
skier233
"},{"location":"plugins/list/#audio-transcodes","title":"audio-transcodes","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerate a transcode video from an audio file
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#audioplayer","title":"AudioPlayer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd an audio-only toggle button and support for audio files in the Stash player through hls transcoder.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#audioplayerlite","title":"AudioPlayerLite","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin identifies files with no video codec and plays them as audio.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#audiotab","title":"audioTab","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an audio tab to the menu bar
https://sneakyninja256.github.io/stash-plugins/stable/index.yml\nView README
sneakyninja256
"},{"location":"plugins/list/#auto-select-updatable-plugins-and-scrapers","title":"Auto Select Updatable Plugins and Scrapers","text":"DescriptionSource URLREADMEAuthorScreenshotsAuto selects updatable Plugins and Scrapers when Check for Updates is clicked
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#auto-update-plugins-and-scrapers","title":"Auto Update Plugins and Scrapers","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically updates Plugins and Scrappers on website Startup
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#autovr","title":"autovr","text":"DescriptionSource URLREADMEAuthorScreenshotsautomatically toggle VR mode
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#average-rating","title":"Average Rating","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds average rating to performers and studios
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#babepedia-gallery-scraper","title":"BabePedia Gallery Scraper","text":"DescriptionSource URLREADMEAuthorScreenshotsScans your Performer Gallery for any BabePedia URLs and scrapes the related galleries for that performer.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#backup-plugins","title":"Backup Plugins","text":"DescriptionSource URLREADMEAuthorScreenshotsCreates a backup of the 'plugins' directory.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#bulk-image-scrape","title":"Bulk Image Scrape","text":"DescriptionSource URLREADMEAuthorScreenshotsApply an image scraper to all images
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
NotMyMainUser
"},{"location":"plugins/list/#bulk-import-performers","title":"Bulk Import Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsBulk Import Performers based on names from a text file.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#categorize-tags-based-on-parent","title":"Categorize Tags Based On Parent","text":"DescriptionSource URLREADMEAuthorScreenshotscolors the tag background image based on the heighest parent and sorts tag with the same heighest parent together
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#choose-your-own-adventure-player-backer","title":"Choose Your Own Adventure Player (Backer)","text":"DescriptionSource URLREADMEAuthorScreenshotsPlugin to adapt Choose Your Own Adventure Games to the VideoJS player.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
cj12312021
"},{"location":"plugins/list/#cjs-card-tweaks","title":"CJ's Card Tweaks.","text":"DescriptionSource URLREADMEAuthorScreenshotsProvides various tweaks for the Stash Cards.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
cj12312021
"},{"location":"plugins/list/#cleanupui","title":"CleanupUI","text":"DescriptionSource URLREADMEAuthorScreenshotsUI plugin to hide features you don't want
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#colorcodedtags","title":"ColorCodedTags","text":"DescriptionSource URLREADMEAuthorScreenshotsChanges the colors of tag labels based on naming convention.
https://coderdudeo.github.io/CoderDudeo-Stash-Plugins/index.yml\nView README
coderdudeo
"},{"location":"plugins/list/#comic-info-extractor","title":"Comic Info Extractor","text":"DescriptionSource URLREADMEAuthorScreenshotsExtract the metadata from cbz with the Comicrack standard (ComicInfo.xml)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
yoshnopa
"},{"location":"plugins/list/#communityscriptsuilibrary","title":"CommunityScriptsUILibrary","text":"DescriptionSource URLREADMEAuthorScreenshotsCommunityScripts UI helper library
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
No Author
"},{"location":"plugins/list/#completethestash","title":"CompleteTheStash","text":"DescriptionSource URLREADMEAuthorScreenshotsFinds missing scenes for selected performers and creates missing scene metadata to another missing Stash instance. You can use either StashDB or TPDB or both as a source for missing scenes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#cuptag","title":"cuptag","text":"DescriptionSource URLREADMEAuthorScreenshotsTag performers with cup sizes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#default-data-for-path","title":"Default Data For Path","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds configured Tags, Performers and/or Studio to all newly scanned Scenes, Images and Galleries.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
TheSinfulKing
"},{"location":"plugins/list/#discord-presence","title":"Discord Presence","text":"DescriptionSource URLREADMEAuthorScreenshotsSets currently playing scene data as your Discord status. See README for prerequisites and config options (blue hyperlink next to enable/disable button)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
NotForMyCV
"},{"location":"plugins/list/#display-tag-image-with-tag","title":"Display Tag Image With Tag","text":"DescriptionSource URLREADMEAuthorScreenshotsany page in stash that has clickable tag, instead of showing the tag name only, show the image of the tag above it.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#dupe-marker-detector","title":"Dupe Marker Detector","text":"DescriptionSource URLREADMEAuthorScreenshotsFinds and marks duplicate markers
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
feederbox826
"},{"location":"plugins/list/#dupfilemanager","title":"DupFileManager","text":"DescriptionSource URLREADMEAuthorScreenshotsManages duplicate files.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#duplicate-scene-marker-cleaner","title":"Duplicate Scene Marker Cleaner","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically detects and removes duplicate scene markers based on scene ID, seconds, and title upon scene updates or via manual trigger.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#e621_tagger","title":"e621_tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsFinding images and videos on e621 and tagging them.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#easytag","title":"EasyTag","text":"DescriptionSource URLREADMEAuthorScreenshotsUI plugin to add shortcuts for commonly used tags
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#edit-unorganized","title":"edit-unorganized","text":"DescriptionSource URLREADMEAuthorScreenshotsDefault to edit tab on unorganized scenes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#embedded-scene-player","title":"Embedded Scene Player","text":"DescriptionSource URLREADMEAuthorScreenshotsDetects embed URLs for file-less scenes and shows them in the scene player.
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#extended-stats","title":"Extended Stats","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds new stats to the stats page
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#external-links-enhanced","title":"External Links Enhanced","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds additional icons for external links.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
QxxxGit
"},{"location":"plugins/list/#extra-performer-info","title":"Extra Performer Info","text":"DescriptionSource URLREADMEAuthorScreenshotsadd award info from wikidata
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#fast-tagger","title":"Fast Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsFast tagging without searching for tags
https://spaceyuck.github.io/stash-plugins/index.yml\nView README
No Author
"},{"location":"plugins/list/#filemonitor","title":"FileMonitor","text":"DescriptionSource URLREADMEAuthorScreenshotsMonitors the Stash library folders, and updates Stash if any changes occurs in the Stash library paths.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#filename-parser","title":"Filename parser","text":"DescriptionSource URLREADMEAuthorScreenshotsParses filename into studio, date, performers and title
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
gitgiggety
"},{"location":"plugins/list/#filepath-copy","title":"filepath-copy","text":"DescriptionSource URLREADMEAuthorScreenshotsCopy file path to clipboard when selected
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#find-file-errors","title":"Find File Errors","text":"DescriptionSource URLREADMEAuthorScreenshotsfind files that stash has previously errored on from the log file
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#find-marker-for-tag-images","title":"Find Marker For Tag Images","text":"DescriptionSource URLREADMEAuthorScreenshotsScript to update tag images based on a randomly matched scene marker.
https://lurking987.github.io/stash-plugins/main/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#find-marker-tag-images","title":"Find Marker Tag Images","text":"DescriptionSource URLREADMEAuthorScreenshotsScript to update tag images based on scene markers
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#fix-the-stash","title":"Fix The Stash","text":"DescriptionSource URLREADMEAuthorScreenshotsProvides easy data fixes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#foldersort","title":"folderSort","text":"DescriptionSource URLREADMEAuthorScreenshotsOrganise your PMV folder(s) based on Stash info
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#fontawesome-js","title":"fontawesome-js","text":"DescriptionSource URLREADMEAuthorScreenshotsUse fontawesome icons from React libraries
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#funscript-markers","title":"Funscript Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate markers if there is a funscript with \"chapters\" included in the metadata of the script
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#gallery-date-parser","title":"Gallery Date Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsFind date in path or filename and add it to the gallery
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
HijackHornet
"},{"location":"plugins/list/#gallery-linker","title":"Gallery Linker","text":"DescriptionSource URLREADMEAuthorScreenshotsLinks image galleries to related scenes and performers based on file patterns, dates, and metadata.
https://voidimproper.github.io/stash-plugins/main/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#glassy-branding","title":"Glassy - Branding","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#hashthestash","title":"HashTheStash","text":"DescriptionSource URLREADMEAuthorScreenshotsCalculates additional fingerprints for scenes.
https://minasukihikimuna.github.io/MidnightRider-Stash/index.yml\nNo README available
MinasukiHikimuna
"},{"location":"plugins/list/#hot-cards","title":"Hot Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds custom styling to card elements that match a Tag ID or a Rating Threshold.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
HandyRandyx
"},{"location":"plugins/list/#hover-cards","title":"Hover Cards","text":"DescriptionSource URLREADMEAuthorScreenshotshttps://valkyr-js.github.io/stash-plugins/index.yml\nNo README available
Valkyr-JS
"},{"location":"plugins/list/#image-date-from-metadata","title":"Image Date From Metadata","text":"DescriptionSource URLREADMEAuthorScreenshotsFind date in image or clip metadata
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#image2scene","title":"image2Scene","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd a mechanism to link images to scenes in the Image Edit Panel.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#imagegallerynavigation","title":"imageGalleryNavigation","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin adds features for navigating between images within a Gallery from the Image details page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#lightbox-visual-novel","title":"Lightbox Visual Novel","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay the image description with Typewriter effect on the footer.
https://w0lfiew0lf.github.io/StashApp-Tools/index.yml\nNo README available
W0lfieW0lf
"},{"location":"plugins/list/#local-visage","title":"Local Visage","text":"DescriptionSource URLREADMEAuthorScreenshotsLocal Performer Recognition plugin using DeepFace
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#log-console","title":"log-console","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay log messages in the web browser console
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#log-toast","title":"log-toast","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay log messages as toasts
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#marker-delete-button","title":"Marker Delete Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a delete button to entries on the Markers page and on the Scene page.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WeedLordVegeta420
"},{"location":"plugins/list/#markergen","title":"markergen","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerate markers on save
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#mcmetadata","title":"mcMetadata","text":"DescriptionSource URLREADMEAuthorScreenshotsGenerates metadata for use with other media servers like Emby and Jellyfin, and optionally organizes/renames your tagged scenes.
https://carrotwaxr.github.io/stash-plugins/stable/index.yml\nNo README available
carrotwaxr
"},{"location":"plugins/list/#misc-tags","title":"Misc Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd extra tags for VR and other ues
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#movie-duration-from-scenes","title":"Movie Duration from Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsMore accurately reflect your movie's duration with the sum of durations of its scenes.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#movie-fy","title":"Movie-Fy","text":"DescriptionSource URLREADMEAuthorScreenshotsMovie-Fy meta-package
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-bulk-movie-scraper","title":"Movie-Fy Bulk Movie Scraper","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdate your movie metadata in bulk.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-check-and-update-scene-titles","title":"Movie-Fy Check and Update Scene Titles","text":"DescriptionSource URLREADMEAuthorScreenshotsCheck and update titles for scenes in the Movie studio
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-create-movie-studio","title":"Movie-Fy Create Movie Studio","text":"DescriptionSource URLREADMEAuthorScreenshotsCreates a new Movie Studio to be used with Mass_Movie_Create
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-scene-studio-bulk-update","title":"Movie-Fy Scene Studio Bulk Update","text":"DescriptionSource URLREADMEAuthorScreenshotsBulk update scene studios based on movie studios.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#movie-fy-update-movie-scene-covers","title":"Movie-Fy Update Movie Scene Covers","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdate scene cover images with movie cover images.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#nfosceneparser","title":"nfoSceneParser","text":"DescriptionSource URLREADMEAuthorScreenshotsFills scene data from NFO or filename pattern
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Gykes
"},{"location":"plugins/list/#organizer-on-update","title":"Organizer On Update","text":"DescriptionSource URLREADMEAuthorScreenshotsOrganize your tags based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#overlay-info","title":"overlay-info","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds more information to scene card overlay
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#path-parser","title":"Path Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdates scene info based on the file path.
https://ceequester.github.io/CommunityScripts/stable/index.yml\nNo README available
Ceequester
"},{"location":"plugins/list/#path-parser_1","title":"Path Parser","text":"DescriptionSource URLREADMEAuthorScreenshotsUpdates scene info based on the file path.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
ImJustMatt
"},{"location":"plugins/list/#performer-body-calculator","title":"Performer Body Calculator","text":"DescriptionSource URLREADMEAuthorScreenshotsTags performers based on existing metadata, with tags matching the performers body type
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#performer-details-extended","title":"Performer Details Extended","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays additional metadata on performer pages, such as their most regular scene partners, top studio, and total play duration. Requires Stash v0.27.0 or higher.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#performer-gallery-scraper-plugin","title":"Performer Gallery Scraper Plugin","text":"DescriptionSource URLREADMEAuthorScreenshotsA plugin to scrape galleries from porngals4.com for specific performers and create zip archives.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#performer-scene-compare","title":"Performer Scene Compare","text":"DescriptionSource URLREADMEAuthorScreenshotsCompares local performer scenes with StashDB and updates the local database.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#performer-stashbox-url-to-id","title":"Performer Stashbox Url to ID","text":"DescriptionSource URLREADMEAuthorScreenshotsIf the performer has a url for another stashbox add it as an id to the performer
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#performer-age","title":"performer-age","text":"DescriptionSource URLREADMEAuthorScreenshotsTag performers with age tags
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#phash-duplicate-tagger","title":"PHash Duplicate Tagger","text":"DescriptionSource URLREADMEAuthorScreenshotsPHash Duplicate Tagger (PDT) Will tag scenes based on duplicate PHashes for easier/safer removal.
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#play-video-if-preview-not-found","title":"Play Video If Preview Not Found","text":"DescriptionSource URLREADMEAuthorScreenshotsPlays video on scene card hover if preview is not found
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#plex-sync","title":"Plex Sync","text":"DescriptionSource URLREADMEAuthorScreenshotsRefresh Plex metadata when scene updated in Stash. Requires the StashPlexAgent.bundle agent.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#public-ip","title":"Public IP","text":"DescriptionSource URLREADMEAuthorScreenshotsQuery ident.me to check my current IP (ensure VPN is working)
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#python-tools-installer","title":"Python Tools Installer","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload stashapp-tools for DockerEnv
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
tooliload
"},{"location":"plugins/list/#pythondepmanager","title":"PythonDepManager","text":"DescriptionSource URLREADMEAuthorScreenshotsManage Python dependencies for CommunityScripts
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#quick-sentiment","title":"Quick Sentiment","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds favourite and watch later overlays to scene cards
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#quickrating","title":"QuickRating","text":"DescriptionSource URLREADMEAuthorScreenshotsMore rating UI options (only enable one)
https://s3l3ct3dloves.github.io/stashPlugins/stable/index.yml\nNo README available
S3L3CT3DLoves
"},{"location":"plugins/list/#randombutton","title":"RandomButton","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to quickly jump to a random scene, image, performer, studio, group, tag, or gallery, both on overview and internal entity pages.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#randomize-performer-images","title":"Randomize Performer Images","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay random images of performer when visiting a performer page. check README.md for set up.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#randomize-performer-images-using-gallery","title":"Randomize Performer Images Using Gallery","text":"DescriptionSource URLREADMEAuthorScreenshotsdisplay random images of performer when visiting a performer page. check README.md for set up.
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#rebrand","title":"Rebrand","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a name override of your choice in Stash
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#remove-redundant-parent-tags-from-tagged-objects","title":"Remove redundant parent tags from tagged objects","text":"DescriptionSource URLREADMEAuthorScreenshotsremoves parent tags from objects if a more specific child tag is also present
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#rename-file-on-update","title":"Rename File on Update","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames files when they are updated in Stash.
https://stash-of-awesomeness.github.io/stash-plugins/main/index.yml\nNo README available
stash-of-awesomeness
"},{"location":"plugins/list/#renamefile","title":"RenameFile","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
David-Maisonave
"},{"location":"plugins/list/#renamer","title":"Renamer","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames scene files based on scene details and updates associated scenes with a \"Renamed\" tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#renamer-dev","title":"Renamer-Dev","text":"DescriptionSource URLREADMEAuthorScreenshotsRenames scene files based on scene details and updates associated scenes with a \"Renamed\" tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#renameronupdate","title":"renamerOnUpdate","text":"DescriptionSource URLREADMEAuthorScreenshotsRename/move filename based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#renameronupdatedevelop","title":"renamerOnUpdateDevelop","text":"DescriptionSource URLREADMEAuthorScreenshotsRename/move filename based on a template.
https://f4bio.github.io/stash-plugins/main/index.yml\nNo README available
f4bio
"},{"location":"plugins/list/#replace-thumbnails-with-high-res-images","title":"Replace Thumbnails With High-Res Images","text":"DescriptionSource URLREADMEAuthorScreenshotsReplaces thumbnails with original high res images
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#scene-cover-cropper","title":"Scene Cover Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsCrop Scene Cover Images
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#scene-marker-tags-to-scene","title":"Scene Marker Tags to Scene","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds primary tag of Scene Marker to the Scene on marker create/update.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WithoutPants
"},{"location":"plugins/list/#scene-page-remember-states","title":"Scene Page Remember States","text":"DescriptionSource URLREADMEAuthorScreenshotsUses local storage to remember the state of the scene page detail panel nav bar and activate it on page load. Remembers collapse state of the divider.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#scenehub","title":"SceneHub","text":"DescriptionSource URLREADMEAuthorScreenshotsCollects the latest scenes from popular network sites and displays them all in one page.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#serechopsscenecard","title":"SerechopsSceneCard","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom scene card via the Plugin API.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#set-performers-from-tags","title":"Set Performers From Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically sets performers in scenes and images based on tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
Torrafox
"},{"location":"plugins/list/#set-scene-cover","title":"Set Scene Cover","text":"DescriptionSource URLREADMEAuthorScreenshotssearches Stash for Scenes with a cover image in the same folder and sets the cover image in stash to that image
https://rosa-umineko.github.io/CommunityScripts/stable/index.yml\nNo README available
rosa-umineko
"},{"location":"plugins/list/#set-scene-cover_1","title":"Set Scene Cover","text":"DescriptionSource URLREADMEAuthorScreenshotssearches Stash for Scenes with a cover image in the same folder and sets the cover image in stash to that image
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#shelve","title":"shelve","text":"DescriptionSource URLREADMEAuthorScreenshots[EXPERIMENTAL - use at own risk] Moves files based on object metadata
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#shelve-ui","title":"shelve-ui","text":"DescriptionSource URLREADMEAuthorScreenshotsUI for renaming files in bulk based on metadata.
https://withoutpants.github.io/stash-plugin-prototypes/main/index.yml\nView README
WithoutPants
"},{"location":"plugins/list/#skip-intro","title":"skip-intro","text":"DescriptionSource URLREADMEAuthorScreenshotsSkips static duration intros
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#star-identifier","title":"Star Identifier","text":"DescriptionSource URLREADMEAuthorScreenshotsUse facial recognition to automatically identify who is in images or scene screenshots from the performers already in your Stash library.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#stash-accessibility","title":"Stash Accessibility","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an Accessibility button in the top right navbar that offers various accessibility features.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ai","title":"Stash AI","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd Tags or Markers to a video using AI
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
cc1234475
"},{"location":"plugins/list/#stash-batch-create-all","title":"Stash Batch Create All","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a 'Create All' button to the scene tagger view. It will target all 'Create' buttons and add new tags as well.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-batch-query-edit","title":"Stash Batch Query Edit","text":"DescriptionSource URLREADMEAuthorScreenshotsBatch modify scene tagger search query
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-result-toggle","title":"Stash Batch Result Toggle","text":"DescriptionSource URLREADMEAuthorScreenshotsIn Scene Tagger, adds button to toggle all stashdb scene match result fields. Saves clicks when you only want to save a few metadata fields. Instead of turning off every field, you batch toggle them off, then toggle on the ones you want
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-save","title":"Stash Batch Save","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a batch save button to scenes tagger
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-batch-search","title":"Stash Batch Search","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a batch search button to scenes and performers tagger
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-disable-all","title":"Stash Disable All","text":"DescriptionSource URLREADMEAuthorScreenshotsDisables all UI configs and plugins. Saves the current config to a JSON file so that it can be restored to original state.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stash-download-scenes","title":"Stash Download Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAn easy method to directly download the stream of any Stash scene.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-dynamic-groups","title":"Stash Dynamic Groups","text":"DescriptionSource URLREADMEAuthorScreenshotsDesignate dynamic groups that can be populated simply by assigning a tag.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-enable-all","title":"Stash Enable All","text":"DescriptionSource URLREADMEAuthorScreenshotsRestores the UI to its original state via a saved JSON config.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stash-fps-overlay","title":"Stash FPS Overlay","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an FPS overlay on the scene cards.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ingest","title":"Stash Ingest","text":"DescriptionSource URLREADMEAuthorScreenshotsMoves identified scenes from the \".StashIngest\" folder to the root \"Scenes\" folder.
https://jsmthy.github.io/stash-plugins/main/index.yml\nView README
jsmthy
"},{"location":"plugins/list/#stash-jellyfin-exporter","title":"Stash Jellyfin Exporter","text":"DescriptionSource URLREADMEAuthorScreenshotsRestructures your Stash library to be Jellyfin compliant to better serve and populate metadata within your Jellyfin server.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-markdown","title":"Stash Markdown","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds markdown parsing to tag description fields
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-markers-autoscroll","title":"Stash Markers Autoscroll","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically scrolls markers page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-matched-performer-scrape","title":"Stash Matched Performer Scrape","text":"DescriptionSource URLREADMEAuthorScreenshotsScrapes performers in bulk from ThePornDB and StashDB on exact name matches only.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-mergers","title":"Stash Mergers","text":"DescriptionSource URLREADMEAuthorScreenshotsA plugin for selectively merging data between performers in Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#stash-new-performer-filter-button","title":"Stash New Performer Filter Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a customizable button to the performers page. Links to a new performers filter by default.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-new-scenes-filter-button","title":"Stash New Scenes Filter Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a filter button to the scenes page in Stash.
https://blackstar3000.github.io/stash-plugins-blackstar/main/index.yml\nNo README available
blackstar3000
"},{"location":"plugins/list/#stash-notes","title":"Stash Notes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to the navigation bar which opens a small window for writing notes to your browser's local storage.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
QxxxGit
"},{"location":"plugins/list/#stash-open-media-player","title":"Stash Open Media Player","text":"DescriptionSource URLREADMEAuthorScreenshotsOpen scene filepath links in an external media player
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-audit-task-button","title":"Stash Performer Audit Task Button","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a button to the performers page to run the audit plugin task
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-custom-fields","title":"Stash Performer Custom Fields","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds custom fields to performers that are stored in performer details as JSON.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-favicons","title":"Stash Performer Favicons","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds the performer URL favicons as a new line item in the performer details.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-performer-image-cropper","title":"Stash Performer Image Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an image cropper to performer page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-image-extractor","title":"Stash Performer Image Extractor","text":"DescriptionSource URLREADMEAuthorScreenshotsExtracts all performers from your localdb to a local directory for easy editing.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-performer-markers-tab","title":"Stash Performer Markers Tab","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a Markers link to performer pages
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-tagger-additions","title":"Stash Performer Tagger Additions","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds performer birthdate and url to tagger view. Makes clicking performer name open stash profile in new tab instead of current tab.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-performer-url-searchbox","title":"Stash Performer URL Searchbox","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a search by performer url textbox to the performers page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-reels","title":"Stash Reels","text":"DescriptionSource URLREADMEAuthorScreenshotsTikTok for Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#stash-right-click-galleries","title":"Stash Right Click Galleries","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the gallery cards to perform various quick tasks related to galleries.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-images","title":"Stash Right Click Images","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the image cards to perform various quick tasks related to images.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-performer-merge","title":"Stash Right Click Performer Merge","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the to perform various quick tasks related to settings.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-performers","title":"Stash Right Click Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the performer cards to perform various quick tasks related to performers.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-scenes","title":"Stash Right Click Scenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the scene cards to perform various quick tasks related to scenes.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-settings","title":"Stash Right Click Settings","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the settings icon to perform various quick tasks related to settings.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-suite","title":"Stash Right Click Suite","text":"DescriptionSource URLREADMEAuthorScreenshotsMeta-package installer for the Stash Right-Click Suite tools.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-right-click-tags","title":"Stash Right Click Tags","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom right-click menu to the tag cards to perform various quick tasks related to tags.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-file-size","title":"Stash Scene File Size","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay file size on scene cards.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-specs-overlay","title":"Stash Scene Specs Overlay","text":"DescriptionSource URLREADMEAuthorScreenshotsHides all the scene specs overlay within the scene card and reveals them on hover.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-scene-tagger-additions","title":"Stash Scene Tagger Additions","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds scene duration and filepath to tagger view.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-scene-tagger-colorizer","title":"Stash Scene Tagger Colorizer","text":"DescriptionSource URLREADMEAuthorScreenshotsColorize scene tagger match results to show matching and mismatching scene data.
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-scene-tagger-draft-submit","title":"Stash Scene Tagger Draft Submit","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds button to Scene Tagger to submit draft to stashdb
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-set-stashbox-favorite-performers","title":"Stash Set Stashbox Favorite Performers","text":"DescriptionSource URLREADMEAuthorScreenshotsSet Stashbox favorite performers according to stash favorites
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashbox-scene-count","title":"Stash Stashbox Scene Count","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds stashbox scene counts to performers and studios
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashid-icon","title":"Stash StashID Icon","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds checkmark icon to performer and studio cards that have a stashid
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stashid-input","title":"Stash StashID Input","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds input for entering new stash id to performer details page and studio page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-stats","title":"Stash Stats","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds stats to stats page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-studio-logo-wall-view","title":"Stash Studio Logo Wall View","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds the studio logo on the scene cards in Wall view.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-tag-custom-colors","title":"Stash Tag Custom Colors","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom button in the navbar to stylize tag chips based on CSS snippets, regex patterns, or basic color-coding.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-tag-image-cropper","title":"Stash Tag Image Cropper","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an image cropper to tag page
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-timestamps","title":"Stash TimeStamps","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate timestamps from pre-existing markers within the scene's details.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-toggle-scene-sprites","title":"Stash Toggle Scene Sprites","text":"DescriptionSource URLREADMEAuthorScreenshotsToggles scene sprites to replace static preview image of all scenes on the current index page.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-ui-plugin-example","title":"Stash UI Plugin Example","text":"DescriptionSource URLREADMEAuthorScreenshotsAn attempt to simplify the process of building UI plugins.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stash-video-player-ab-loop-time-input","title":"Stash Video Player AB Loop Time Input","text":"DescriptionSource URLREADMEAuthorScreenshotsReplaces the video player AB loop start and end buttons with time inputs
https://7djx1qp.github.io/stash-plugins/main/index.yml\nNo README available
7dJx1qP
"},{"location":"plugins/list/#stash-omnisearch","title":"stash-omnisearch","text":"DescriptionSource URLREADMEAuthorScreenshotssearch all the things on stash
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stash-open","title":"stash-open","text":"DescriptionSource URLREADMEAuthorScreenshotsOpens media files in local media player
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stash-s6-helper","title":"stash-s6 helper","text":"DescriptionSource URLREADMEAuthorScreenshotsstash-s6 helper plugin
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stashannotate","title":"stashAnnotate","text":"DescriptionSource URLREADMEAuthorScreenshotsAllows users to create a custom annotation and highlight field on images similar to popular Booru sites.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashappandroidtv-companion","title":"StashAppAndroidTV Companion","text":"DescriptionSource URLREADMEAuthorScreenshotsA companion plugin for StashAppAndroidTV
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
damontecres
"},{"location":"plugins/list/#stashaudioplayer","title":"StashAudioPlayer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd an audio-only toggle button and support for audio files in the Stash player through hls transcoder.
https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml\nView README
d0t-d0t-d0t
"},{"location":"plugins/list/#stashaudioplayerlite","title":"StashAudioPlayerLite","text":"DescriptionSource URLREADMEAuthorScreenshotsThis plugin identifies files with no video codec and plays them as audio.
https://raw.githubusercontent.com/d0t-d0t-d0t/stash-repo/refs/heads/dist/index.yml\nNo README available
d0t-d0t-d0t
"},{"location":"plugins/list/#stashdb-performer-gallery","title":"stashdb performer gallery","text":"DescriptionSource URLREADMEAuthorScreenshotsAutomatically download performer images from stashdb or other stash-boxes. Add the [Stashbox Performer Gallery] tag to a performer and it will create a gallery of images from that stash-box database. Apply the tag [Set Profile Image] to an image to set it as the profile image of that performer. Note you will need to configure the download path and add this as a path under settings > library
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#stashdb-tag-import","title":"StashDB Tag Import","text":"DescriptionSource URLREADMEAuthorScreenshotsImport StashDB's list of Tags for your Stash.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashdb-fullimg","title":"stashdb-fullimg","text":"DescriptionSource URLREADMEAuthorScreenshotsDownload full-size images from StashDB
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#stashdisable","title":"stashDisable","text":"DescriptionSource URLREADMEAuthorScreenshotsstashDisable meta-package
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"plugins/list/#stashlist-sync","title":"stashlist-sync","text":"DescriptionSource URLREADMEAuthorScreenshotsSync stashIDs to stashlist history
https://feederbox826.github.io/stashlist/main/index.yml\nView README
feederbox826
"},{"location":"plugins/list/#stashnewperformerscenes","title":"stashNewPerformerScenes","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a custom icon in the performer card should they have a new scene released within the specified date range from the navbar button.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#stashnotifications","title":"StashNotifications","text":"DescriptionSource URLREADMEAuthorScreenshotsReceive notifications about plugin and scraper changes.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
QxxxGit
"},{"location":"plugins/list/#stashtagperformerimage","title":"stashTagPerformerImage","text":"DescriptionSource URLREADMEAuthorScreenshotsChecks parent directory of image on Image.Update.Post and compares to any existing performers in the db. Updates that image with the related performer.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#studio-background-shadow","title":"Studio background shadow","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd drop shadows to studio icons for visibility
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#studio-top-performer","title":"Studio Top Performer","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds a Queen icon with the top performer listed in the studio cards as determined by most scenes starred in from that particular studio.
https://serechops.github.io/Serechops-Stash/index.yml\nNo README available
serechops
"},{"location":"plugins/list/#tag-galleries-from-images","title":"Tag galleries from images","text":"DescriptionSource URLREADMEAuthorScreenshotstags galleries with tags of contained images.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tag-graph","title":"Tag Graph","text":"DescriptionSource URLREADMEAuthorScreenshotsInteractive tag graph with vis.js, to view go to http://localhost:9999/plugin/tagGraph/assets/graph/
https://stg-annon.github.io/StashScripts/stable/index.yml\nNo README available
stg-annon
"},{"location":"plugins/list/#tag-images-from-performer-tags","title":"Tag Images From Performer Tags","text":"DescriptionSource URLREADMEAuthorScreenshotstags images with performer tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tag-scenes-from-performer-tags","title":"Tag Scenes From Performer Tags","text":"DescriptionSource URLREADMEAuthorScreenshotstags scenes with performer tags.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Dankonite
"},{"location":"plugins/list/#tag-text-to-emoji","title":"Tag Text to Emoji","text":"DescriptionSource URLREADMEAuthorScreenshotschanges text to emoji if you are using common tags from stashdb
https://xiosensei.github.io/Xio-Stash/index.yml\nNo README available
xiosensei
"},{"location":"plugins/list/#tag-color-regex","title":"tag-color-regex","text":"DescriptionSource URLREADMEAuthorScreenshotsColors tags based on regex
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-filter","title":"tag-filter","text":"DescriptionSource URLREADMEAuthorScreenshotsFilter out and hide meta-tags
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-import","title":"tag-import","text":"DescriptionSource URLREADMEAuthorScreenshotsfeederbox opinionated tag import
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-link","title":"tag-link","text":"DescriptionSource URLREADMEAuthorScreenshotslink local tags to stashDB
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tag-video","title":"tag-video","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd <video> support to tag images
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tagcopypaste","title":"tagCopyPaste","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds Copy/Paste buttons to Tags field.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#tagger-img-res","title":"tagger-img-res","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds resolutions to all tagger images
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#tetrax-userscript-library","title":"Tetrax Userscript Library","text":"DescriptionSource URLREADMEAuthorScreenshotsUtility library for Tetrax userscripts
https://tetrax-10.github.io/stash-stuffs/index.yml\nNo README available
tetrax-10
"},{"location":"plugins/list/#the-porn-db-markers","title":"The Porn DB Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsSync Markers from The Porn DB aka theporndb.net
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Tweeticoats
"},{"location":"plugins/list/#theme-switch","title":"Theme Switch","text":"DescriptionSource URLREADMEAuthorScreenshotsTheme and CSS script manager located in main menu bar top right.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
elkorol
"},{"location":"plugins/list/#thumbnail-previews","title":"Thumbnail Previews","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays preview videos on thumbnail cards.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#timestamp-trade","title":"Timestamp Trade","text":"DescriptionSource URLREADMEAuthorScreenshotsSync Markers with timestamp.trade, a new database for sharing markers.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
Tweeticoats
"},{"location":"plugins/list/#titlefromfilename","title":"titleFromFilename","text":"DescriptionSource URLREADMEAuthorScreenshotsSet a scene's title from it's filename
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
bnkai
"},{"location":"plugins/list/#titleobserver","title":"titleobserver","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds an event listener for title changes
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#useragent","title":"useragent","text":"DescriptionSource URLREADMEAuthorScreenshotsProgramatically set scraper User-Agent
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#valkyr-scene-cards","title":"Valkyr Scene Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsA customisable rework of the scene card component for Stash.
https://valkyr-js.github.io/stash-plugins/index.yml\nView README
Valkyr-JS
"},{"location":"plugins/list/#video-banner","title":"Video Banner","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplays random generated preview videos in the detail page banner.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"plugins/list/#video-chapter-markers","title":"Video Chapter Markers","text":"DescriptionSource URLREADMEAuthorScreenshotsCreate markers from chapter information embedded in video files
https://stashapp.github.io/CommunityScripts/stable/index.yml\nView README
qxzg
"},{"location":"plugins/list/#videoscrollwheel","title":"VideoScrollWheel","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds functionality to change volume/time in scene video player by hovering over left/right side of player and scrolling with mouse scrollwheel. Scroll while hovering on left side to adjust volume, scroll on right side to skip forward/back.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
WeedLordVegeta420
"},{"location":"plugins/list/#vjs-mmb-fullscreen","title":"vjs-mmb-fullscreen","text":"DescriptionSource URLREADMEAuthorScreenshotsVideoJS middle mouse button fullscreen
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#vjs-shortcut","title":"vjs-shortcut","text":"DescriptionSource URLREADMEAuthorScreenshotsAdd YouTube keyboard shortcuts to VideoJS
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#vjs-vr-zoom","title":"vjs-vr-zoom","text":"DescriptionSource URLREADMEAuthorScreenshotsVideoJS VR zoom controls
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"plugins/list/#watched-video-icon","title":"Watched Video Icon","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds icon and css class to watched videos
https://feederbox826.github.io/plugins/main/index.yml\nNo README available
feederbox826
"},{"location":"scripts/","title":"Scripts","text":"Info
Scripts are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Scripts are standalone programs that can interact with Stash either through GraphQL queries, custom Javascript or by directly editing Stash database or external files.
To install a script follow the script's install instructions.
"},{"location":"scripts/list/","title":"Browse scripts","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Script no longer worksIf you found that script is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"scripts/list/#addmarkerono","title":"AddMarkerOnO","text":"DescriptionAuthorScreenshotsWill auto-generate a marker when the SceneAddO event is trigger
rosa-umineko
"},{"location":"scripts/list/#blurrycardbackground","title":"blurryCardBackground","text":"DescriptionAuthorScreenshotsAdd blurry background to scene/movie/gallery/image/studio.
philpw99
"},{"location":"scripts/list/#filenameperformerstocsv","title":"FilenamePerformersToCSV","text":"DescriptionAuthorScreenshotsParse performer names from your media filenames into CSV files for batch import into Stash!
ALonelyJuicebox
"},{"location":"scripts/list/#get-profilepictures","title":"Get-ProfilePictures","text":"DescriptionAuthorScreenshotsGet-ProfilePictures
MinasukiHikimuna
"},{"location":"scripts/list/#kodi-helper","title":"Kodi helper","text":"DescriptionAuthorScreenshotsGenerates nfo and strm for use with Kodi.
WithoutPants
"},{"location":"scripts/list/#ofmetadatatostash","title":"OFMetadataToStash","text":"DescriptionAuthorScreenshotsOnlyFans metadata import tool for Stash, written in Powershell.
- Simple to use with a straightforward command line based UI!
- Script can auto-associate scenes/images with the appropriate OnlyFans performer(s) and studio, in batch!
- Built-in utility for completely scrubbing and sanitizing OnlyFans metadata databases
ALonelyJuicebox
"},{"location":"scripts/list/#plex-to-stash-ratings","title":"plex-to-stash-ratings","text":"DescriptionAuthorScreenshotsTransfer scene rating and view count from Plex to Stash.
oikmeg
"},{"location":"scripts/list/#pwplayerjs-scene-card-quick-player","title":"pwPlayer.js - Scene Card Quick Player","text":"DescriptionAuthorScreenshotsThis Javascript will create a \"Play\" button in each scene card. You can click on it and the video for that scene will be played right away. Click on the video again, then you are back to the scene list.
philpw99
"},{"location":"scripts/list/#sqlite-renamer-for-stash","title":"SQLITE Renamer for Stash","text":"DescriptionAuthorScreenshotsUsing metadata from your database (SQLITE) to rename your file.
Belleyy
"},{"location":"scripts/list/#stash-watcher","title":"Stash Watcher","text":"DescriptionAuthorScreenshotsStash Watcher is a service that watches your Stash library directories for changes and then triggers a Metadata Scan when new files are added to those directories. It then waits a period of time before triggering another scan to keep Stash from constantly scanning if you're making many changes. Note that updates are watched during that window; the update is merely delayed.
DuctTape42
"},{"location":"scripts/list/#stashapp-tag-importer","title":"stashapp-tag-importer","text":"DescriptionAuthorScreenshotsCreates tags and aliases, resolves tag conflicts, and updates tag titles and descriptions from Stashbox (StashDB) to your local Stash instance. It can be run periodically to perform a one way sync to keep your Stash instance up to date with Stashbox (StashDB).
soundchaser128
"},{"location":"scripts/list/#stashgalleryupdate","title":"StashGalleryUpdate","text":"DescriptionAuthorScreenshotsDumb little script to match and update Stash galleries from scenes
Darklyter
"},{"location":"scripts/list/#stashstudiosync","title":"StashStudioSync","text":"DescriptionAuthorScreenshotsAn easy way to query a stashbox GQL endpoint and import any unknown studio IDs.
Stash-KennyG
"},{"location":"scripts/list/#stashtagskins","title":"StashTagSkins","text":"DescriptionAuthorScreenshotsUsed to quickly apply and change themes of tags for Stash.
Stash-KennyG
"},{"location":"scripts/list/#stashvideohashernode","title":"StashVideohasherNode","text":"DescriptionAuthorScreenshotsThis is a very simple script that can be run on multiple systems to process a large Stash import of scenes. Instead of running cover and phash generation tasks on the Stash server itself, this script will allow you to do the same thing on as many computers as you would like, with all of the nodes contributing back to the Stash server.
Darklyter
"},{"location":"themes/","title":"Themes","text":"Info
Themes are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Stash supports CSS themes to adjust the look-and-feel of the interface. There are several that have been created by the maintainers and users.
Themes can be installed either via plugin or as Custom CSS.
"},{"location":"themes/#installing-via-plugin","title":"Installing via plugin","text":"Plugins can be installed and managed from the Settings > Plugins page.
Plugins are installed using the Available Plugins section. The Community (stable) source is configured by default that has several themes.
Installed plugins can be updated or uninstalled from the Installed Plugins section.
"},{"location":"themes/#adding-sources","title":"Adding sources","text":"Anyone can create their own source index for plugins. To add a new source go to Settings > Plugins page and under Available Plugins click Add Source.
"},{"location":"themes/#installing-via-custom-css","title":"Installing via Custom CSS","text":"- Find a theme from the list and copy the content of .css file.
- In Stash, go to Settings > Interface and scroll down to Custom CSS heading.
- Make sure Custom CSS enabled is checked.
- Click on Edit under Custom CSS and then paste the CSS code into the text box.
- You will need to force-reload Shift+F5 in order to see the theme.
Custom CSS allows you to modify Stash stock stylesheets.
The following is a list of some useful CSS snippets. You may use them by copying-and-pasting them into the Custom CSS editor found in the Settings > Interface panel or by navigating to
localhost:9999/settings?tab=interfaceWarning
- Future releases of Stash may break these CSS tweaks.
- CSS tweaks may not appear without flushing the Stash browser cache first on Chrome.
Reduce left and right padding on Scene and Performer grid pages allowing for more thumbnails on each row.
"},{"location":"themes/custom-css-snippets/#allow-for-longer-string-when-displaying-studio-as-text-on-scene-thumbnails","title":"Allow for longer string when displaying \"Studio as Text\" on scene thumbnails","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Fit more thumbnails on each row */\n\n.grid { padding: 0px !important; }\nAllow for longer string when displaying \"Studio as Text\" on scene thumbnails.
"},{"location":"themes/custom-css-snippets/#hide-scene-specs-resolution-duration-from-scene-card","title":"Hide scene specs (resolution, duration) from scene card","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Allow for longer string when displaying \"Studio as Text\" on scene thumbnails */\n\n.scene-studio-overlay {\n font-weight: 600 !important;\n opacity: 1 !important;\n width: 60% !important;\n text-overflow: ellipsis !important;\n}\nHide scene specs (resolution, duration) from scene card.
"},{"location":"themes/custom-css-snippets/#hide-studio-logotext-from-scene-card","title":"Hide studio logo/text from scene card","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide scene specs (resolution, duration) from scene card */\n\n.scene-specs-overlay {\ndisplay: none;\n}\nHide studio logo/text from scene card.
"},{"location":"themes/custom-css-snippets/#make-the-list-of-tags-take-up-less-width","title":"Make the list of tags take up less width","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide studio logo/text from scene card */\n\n.scene-studio-overlay {\ndisplay: none;\n}\nMake the list of tags take up less width.
"},{"location":"themes/custom-css-snippets/#swap-studio-and-resolutionduration-positions","title":"Swap studio and resolution/duration positions","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Make the list of tags take up less width */\n\n.bs-popover-bottom {\nmax-width: 500px\n}\nSwap studio and resolution/duration positions.
"},{"location":"themes/custom-css-snippets/#adjust-the-mouse-over-behaviour-in-wall-mode","title":"Adjust the mouse over behaviour in wall mode","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Swap studio and resolution/duration positions */\n\n.scene-studio-overlay {\nbottom: 1rem;\nright: 0.7rem;\nheight: inherit;\ntop: inherit;\n}\n\n.scene-specs-overlay {\nright: 0.7rem;\ntop: 0.7rem;\nbottom: inherit;\n}\nAdjust the mouse over behaviour in wall mode.
"},{"location":"themes/custom-css-snippets/#disable-zoom-on-hover-in-wall-mode","title":"Disable zoom on hover in wall mode","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Adjust the mouse over behaviour in wall mode */\n\n@media (min-width: 576px) {\n.wall-item:hover::before {\nopacity: 0; \n}\n\n.wall-item:hover .wall-item-container {\ntransform: scale(1.5);\n}\n}\nDisable zoom on hover in wall mode.
"},{"location":"themes/custom-css-snippets/#hide-the-scene-scrubber","title":"Hide the scene scrubber","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Disable zoom on hover in wall mode */\n\n.wall-item:hover .wall-item-container {\n transform: none;\n}\n.wall-item:before {\n opacity: 0 !important;\n}\nThis will hide the large scene scrubber under the video player and max out the player's height.
"},{"location":"themes/custom-css-snippets/#hide-the-truncated-text","title":"Hide the truncated text","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes tab] Hide the scene scrubber and max out the player's height */\n.scrubber-wrapper {\ndisplay: none;\n}\nThis will hide the truncated text that appears under the tile and date.
"},{"location":"themes/custom-css-snippets/#images","title":"Images","text":""},{"location":"themes/custom-css-snippets/#disable-lightbox-animation","title":"Disable lightbox animation","text":"DescriptionAuthorScreenshotsCSS code/* [Scenes Tab] - Hide the truncated text on scene card */\n\n.TruncatedText.scene-card__description { \ndisplay: none;\n}\nDisable lightbox animation.
"},{"location":"themes/custom-css-snippets/#dont-crop-preview-thumbnails","title":"Don't crop preview thumbnails","text":"DescriptionAuthorScreenshotsCSS code/* [Images tab] Disable lightbox animation */\n\n.Lightbox-carousel {\ntransition: none;\n}\nDon't crop preview thumbnails.
"},{"location":"themes/custom-css-snippets/#groups","title":"Groups","text":""},{"location":"themes/custom-css-snippets/#better-group-layout-for-desktops-regular-size-poster","title":"Better Group layout for desktops, regular size poster","text":"DescriptionAuthorScreenshotsCSS code/* [Images tab] Don't crop preview thumbnails */\n\n.flexbin > * > img {\nobject-fit: inherit;\nmax-width: none;\nmin-width: initial;\n}\nMaking the front and back image much bigger. Left panel uses 70% while the right uses 30%.
"},{"location":"themes/custom-css-snippets/#better-group-layout-for-desktops-larger-size-poster","title":"Better Group layout for desktops, larger size poster","text":"DescriptionAuthorScreenshotsCSS code/* [Groups tab] Better Group layout for desktops: Regular size poster */\n\n.group-details.mb-3.col.col-xl-4.col-lg-6 {\nflex-basis: 70%\n}\n.col-xl-8.col-lg-6{\nflex-basis: 30% \n}\n.group-images{\nflex-wrap: wrap\n}\n.group-image-container {\nflex: 0 0 500px\n}\nMaking the front and back image much bigger. Left panel uses 70% while the right uses 30%.
"},{"location":"themes/custom-css-snippets/#galleries","title":"Galleries","text":""},{"location":"themes/custom-css-snippets/#grid-view-for-galleries","title":"Grid view for galleries","text":"DescriptionAuthorScreenshotsCSS code/* [Groups tab] Better Group layout for desktops: Larger size poster */\n\n.group-details.mb-3.col.col-xl-4.col-lg-6 {\nflex-basis: 70%\n}\n.col-xl-8.col-lg-6{\nflex-basis: 30% \n}\n.group-images{\nflex-direction: column;\nflex-wrap: wrap\n}\n.group-image-container {\nflex: 1 1 700px\n}\nGrid view for galleries.
"},{"location":"themes/custom-css-snippets/#disable-lightbox-image-transition","title":"Disable lightbox image transition","text":"DescriptionAuthorScreenshotsCSS code/* [Galleries tab] Grid view for galleries */\n\n.col.col-sm-6.mx-auto.table .d-none.d-sm-block {\n display: none !important;\n}\n.col.col-sm-6.mx-auto.table .w-100.w-sm-auto {\n width: 175px !important;\n background-color: rgba(0, 0, 0, .45);\n box-shadow: 0 0 2px rgba(0, 0, 0, .35);\n}\n.col.col-sm-6.mx-auto.table tr {\n display: inline-table;\n}\nDisable lightbox image transition.
"},{"location":"themes/custom-css-snippets/#hide-the-lightbox-header-and-footer","title":"Hide the lightbox header and footer","text":"DescriptionAuthorScreenshotsCSS code/* [Gallery tab] Disable lightbox image transition */\n.Lightbox-carousel {\ntransition: unset;\n}\nHides the lightbox header and footer to make the image area larger. Mouse reveals them as an overlay to the image.
peresabcod
"},{"location":"themes/custom-css-snippets/#performers","title":"Performers","text":""},{"location":"themes/custom-css-snippets/#show-entire-performer-image-in-performer-card","title":"Show entire performer image in performer card","text":"DescriptionAuthorScreenshotsCSS code/* [Gallery tab] Hides the lightbox header and footer to make the image area larger. Mouse reveals them as an overlay to the image*/\n\n.Lightbox-header,\n.Lightbox-footer{\nz-index:9999;\nposition:absolute;\nwidth:100%;\nopacity:0;\nbackground-color:#0008;\ntransition: opacity 0.5s ease;\n}\n\n.Lightbox-footer{\nbottom:0;}\n\n.Lightbox-navbutton{\nopacity:0;\ntransition: opacity 0.5s ease;\n}\n\n\n.Lightbox-navbutton:hover,\n.Lightbox-header:hover,\n.Lightbox-footer:hover{\nopacity:1;\n}\nShow entire performer image in performer card.
"},{"location":"themes/custom-css-snippets/#show-a-larger-image-in-performers-page-for-desktop","title":"Show a larger image in performer's page for desktop","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show entire performer image in performer card */\n\n.performer.image {\nbackground-size: contain !important;\n}\nShow a larger image in performer's page for desktop.
"},{"location":"themes/custom-css-snippets/#place-performer-image-in-the-background-on-performer-page","title":"Place performer image in the background on performer page","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show a larger image in performer's page for desktop */\n.performer-image-container{\nflex: 0 0 50%;\nmax-width: 50%;\n}\n/* Changing .col-md-8 settings also affects studios and tags display. 50% should be good enough. */\n.col-md-8 {\nflex: 0 0 50%;\nmax-width: 50%;\n}\nPlace performer image in the background on performer page.
"},{"location":"themes/custom-css-snippets/#show-larger-performer-images-in-performers-list","title":"Show larger performer images in performers list","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Place performer image in the background on performer page */\n\n.performer-image-container.col-md-4.text-center {\n flex: 0 0 0%;\n max-width: 0%;\n}\n\n#performer-page .performer-image-container .btn.btn-link {\n position: fixed;\n width: 100%;\n top: 0;\n left: 0;\n padding: 0;\n}\n\n#performer-page .performer-image-container .btn.btn-link:before {\n content: '';\n position:absolute;\n top:0;\n left: 0;\n right: 0;\n bottom: 0;\n background: linear-gradient(to left, rgba(0,0,0,0) 0%,rgb(0 0 0 / 75%) 100%);\n z-index: 1;\n}\n\n#performer-page .performer-image-container .performer {\n max-height: none;\n max-width: none;\n width: 100%;\n}\nShow larger performer images in performers list.
"},{"location":"themes/custom-css-snippets/#move-the-buttons-in-the-performers-edit-panel-to-the-top-instead-of-bottom","title":"Move the buttons in the Performer's edit panel to the top instead of bottom","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Show larger performer images in performers list */\n/* original value: height: 30rem; min-width:13.25rem; */\n.performer-card-image{\nheight: 45rem;\nmin-width: 20rem;\n}\nMove the buttons in the Performer's edit panel to the top instead of bottom (in newer version of Stash, the buttons are already positioned both at top and bottom.
"},{"location":"themes/custom-css-snippets/#move-the-tags-row-in-the-performers-edit-panel-to-the-second-position-just-after-name","title":"Move the tags row in the Performer's edit panel to the second position (just after name)","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Move the buttons in the Performer's edit panel to the top instead of bottom (in newer version of Stash, the buttons are already positioned both at top and bottom. */\n\nform#performer-edit {\n display: flex;\n flex-direction: column;\n}\n#performer-edit > .row {\n order: 1;\n}\n#performer-edit > .row:last-child {\n order: 0;\n margin-bottom: 1rem;\n}\nMove the tags row in the Performer's edit panel to the second position (just after name).
"},{"location":"themes/custom-css-snippets/#studios","title":"Studios","text":""},{"location":"themes/custom-css-snippets/#different-studio-cards-layout","title":"Different studio cards layout","text":"DescriptionAuthorScreenshotsCSS code/* [Performers tab] Move the tags row in the Performer's edit panel to the second position (just after name). */\n\nform#performer-edit {\n display: flex;\n flex-direction: column;\n}\n#performer-edit > .row:nth-child(24) {\n order: -1;\n}\n#performer-edit > .row:first-child {\n order: -2;\n}\nChanges the layout of studio cards.
Qx#1573
"},{"location":"themes/custom-css-snippets/#more-studio-per-row","title":"More studio per row","text":"DescriptionAuthorScreenshotsCSS code/* [Studios tab] Changes the layout of studio cards */\n.studio-card.grid-card.card div.card-section div.rating-banner { display: none; }\n.slick-slide .studio-card-image { height: 300px; }\n\n.studio-card, .recommendation-row .studio-card {\n padding: 0;\n width: 500px;\n height: 300px;\n}\n\n.studio-card-image, .recommendation-row .studio-card .studio-card-image {\n max-height: 300px;\n width: 500px;\n}\n\n.studio-card.grid-card.card div.card-section {\n position: absolute;\n bottom: 0em;\n width: inherit;\n background-color: rgba(0, 0, 0, 0.7);\n overflow: hidden;\n height: 2.5em;\n transition: 0.5s ease-in-out;\n}\n\n.studio-card.grid-card.card div.card-section:hover {\n height: 7em;\n}\nDisplay more studio per row
hijack_hornet
"},{"location":"themes/custom-css-snippets/#tags","title":"Tags","text":""},{"location":"themes/custom-css-snippets/#different-tag-cards-layout","title":"Different tag cards layout","text":"DescriptionAuthorScreenshotsCSS code/* [Studios tab] Show more item per row */\n:not(.recommendation-row .studio-card).studio-card {\n width: 15%\n}\n:not(.recommendation-row .studio-card-image).studio-card-image {\n width: 100%\n}\n.studio-card h5 {\n text-align: center !important;\n display: block;\n}\nChanges the layout of tag cards on tags tab and when hovering on tags in different content.
Qx#1573
"},{"location":"themes/custom-css-snippets/#alternative-tag-layout","title":"Alternative tag layout","text":"DescriptionAuthorScreenshotsCSS code/* [Tags changes] changes the layout of tag cards on tags page and hover */\n.tag-parent-tags, .tag-sub-tags { display: none;}\n.tag-card.zoom-0.grid-card.card div.card-section div.card-popovers.btn-group { margin-top: 1em; }\n.tag-card.zoom-0.grid-card.card div.thumbnail-section a.tag-card-header img.tag-card-image { object-fit: cover; }\n.tag-card.zoom-0.grid-card.card div.card-section hr { display: none; }\n\n.tag-card.zoom-0.grid-card.card {\n padding: 0;\n width: 300px;\n height: 180px;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section {\n position: absolute;\n text-shadow: 2px 2px 2px #000;\n width: 100%;\n background-color: rgba(0, 0, 0, 0.3);\n height: 3em;\n overflow: hidden;\n transition: 0.8s ease-in-out;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section a {\n text-decoration: none;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section:hover {\n height: 22em;\n}\n\n.tag-card.zoom-0.grid-card.card \n div.card-section a \n h5.card-section-title.flex-aligned \n div.TruncatedText {\n white-space: nowrap;\n text-overflow: ellipsis;\n width: 300px;\n overflow: hidden;\n display: block;\n}\n\n.tag-card.zoom-0.grid-card.card div.card-section div.TruncatedText.tag-description {\n position: relative;\n top: 0.5em;\n -webkit-text-stroke-width: 1px;\n font-size: 16px;\n}\n\n.tag-card .card-popovers .btn {\n text-shadow: 1px 1px 1px #000;\n stroke: black;\n stroke-width: 15;\n}\nChanges the tags layout to show more images, and details on hover.
hijack_hornet
"},{"location":"themes/custom-css-snippets/#subtag-explorer","title":"Subtag explorer","text":"DescriptionAuthorScreenshotsCSS code/*Tag layout changes*/\n.tag-card {\n width: 16rem;\n padding: 0;\n}\n\n.tag-card .card-section {\n height: 2.5rem;\n position: absolute;\n bottom: 0;\n left: 0;\n right: 0;\n background: #0000007a;\n line-height: none;\n}\n.tag-card .card-section .TruncatedText {\n -webkit-line-clamp: 1 !important;\n}\n.tag-card h1,\nh2,\nh3,\nh4,\nh5,\nh6,\n.h1,\n.h2,\n.h3,\n.h4,\n.h5,\n.h6 {\n line-height: normal;\n}\n.tag-card hr,\n.tag-description {\n display: none;\n}\n.tag-card .btn-group {\n position: absolute;\n width: 100%;\n bottom: 2.5rem;\n margin-bottom: 0;\n opacity: 0;\n transition: ease 0.2s;\n}\n.tag-card .btn-group:hover {\n opacity: 1;\n transition: ease 0.2s;\n background: #0000007a;\n}\n\n.tag-card-image {\n object-fit: cover;\n object-position: center;\n}\n\n.zoom-0 .tag-card-image {\n max-height: none;\n height: 16rem;\n width: 12rem;\n}\n\n.zoom-1 .tag-card-image {\n max-height: none;\n height: 20rem;\n width: 15rem;\n}\n\n.zoom-2 .tag-card-image {\n max-height: none;\n height: 24rem;\n width: 18rem;\n}\n\n.zoom-3 .tag-card-image {\n max-height: none;\n height: 28rem;\n width: 21rem;\n}\n\n.zoom-0.tag-card,\n.zoom-1.tag-card,\n.zoom-2.tag-card,\n.zoom-3.tag-card {\n width: initial;\n}\n\n.tag-card .card-section > a {\n position: absolute;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 7px 14px 0px 14px;\n}\n.tag-card .card-section .tag-sub-tags {\n position: relative;\n margin-top: 2rem;\n z-index: 1;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\nThis snipset includes the above tag layout snipset with a twist. Its meant to be used for people who use subtags as a hierachy. For example Watermelon is a subtag of Fruits, so when i click Fruits i want to see both oranges and watermelons, but i might want to get into the list of fruits subtags more easily. That what this snipset is used for. Any tag that has a subtag will show a (...) icon. When clicking its name you will show all subtags of this tag. if you click its image, it will instead open the tag itself normaly. You can change '137cbd' in the icon url to any color you want to match you theme.
hijack_hornet
"},{"location":"themes/custom-css-snippets/#global","title":"Global","text":""},{"location":"themes/custom-css-snippets/#change-the-order-of-navigation-bar-buttons","title":"Change the order of navigation bar buttons","text":"DescriptionAuthorScreenshotsCSS code/*Tag layout changes*/\n.tag-card {\n width: 16rem;\n padding: 0;\n}\n\n.tag-card .card-section {\n height: 2.5rem;\n position: absolute;\n bottom: 0;\n left: 0;\n right: 0;\n background: #0000007a;\n line-height: none;\n}\n.tag-card .card-section .TruncatedText {\n -webkit-line-clamp: 1 !important;\n}\n.tag-card h1,\nh2,\nh3,\nh4,\nh5,\nh6,\n.h1,\n.h2,\n.h3,\n.h4,\n.h5,\n.h6 {\n line-height: normal;\n}\n.tag-card hr,\n.tag-description {\n display: none;\n}\n.tag-card .btn-group {\n position: absolute;\n width: 100%;\n bottom: 2.5rem;\n margin-bottom: 0;\n opacity: 0;\n transition: ease 0.2s;\n}\n.tag-card .btn-group:hover {\n opacity: 1;\n transition: ease 0.2s;\n background: #0000007a;\n}\n\n.tag-card-image {\n object-fit: cover;\n object-position: center;\n}\n\n.zoom-0 .tag-card-image {\n max-height: none;\n height: 16rem;\n width: 12rem;\n}\n\n.zoom-1 .tag-card-image {\n max-height: none;\n height: 20rem;\n width: 15rem;\n}\n\n.zoom-2 .tag-card-image {\n max-height: none;\n height: 24rem;\n width: 18rem;\n}\n\n.zoom-3 .tag-card-image {\n max-height: none;\n height: 28rem;\n width: 21rem;\n}\n\n.zoom-0.tag-card,\n.zoom-1.tag-card,\n.zoom-2.tag-card,\n.zoom-3.tag-card {\n width: initial;\n}\n\n.tag-card .card-section > a {\n position: absolute;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 7px 14px 0px 14px;\n}\n.tag-card .card-section .tag-sub-tags {\n position: relative;\n margin-top: 2rem;\n z-index: 1;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\n/*Tag subtag exploration snipset*/\n.tag-card .card-section > a {\n cursor: default;\n pointer-events: none;\n}\n.tag-card .card-section > hr {\n margin-top: 2rem;\n}\n.tag-card .card-section .tag-sub-tags {\n position: absolute !important;\n margin-top: 0 !important;\n width: 100%;\n height: 100%;\n display: block;\n left: 0;\n right: 0;\n top: 0;\n bottom: 0;\n padding: 0;\n}\n.tag-sub-tags::before {\n content: \"\";\n display: block;\n background: url(\"https://img.icons8.com/material-outlined/24/137cbd/connection-status-off.png\")\n no-repeat;\n background-size: 1.5rem 1.5rem;\n width: 1.5rem;\n height: 1.5rem;\n float: right;\n margin: 0.5rem 0.5rem 0 0;\n}\n.tag-sub-tags > a {\n width: 100%;\n height: 100%;\n display: block;\n}\n\n.tag-card .btn-group a {\n z-index: 10;\n}\n.tag-sub-tags {\n font-size: 0;\n}\n.tag-parent-tags {\n display: none;\n}\nUse
ordervalues below 0 to move specific buttons to the left of the non-ordered buttons, and values above 1 to move them to the right of the non-ordered buttons.
"},{"location":"themes/custom-css-snippets/#hide-the-donate-button","title":"Hide the Donate button","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Change the order of navigation bar buttons */\n\nnav .navbar-nav:first-child {\ndisplay: flex;\nflex-direction: row;\n}\ndiv.nav-link[data-rb-event-key=\"/tags\"] {\norder: -2;\n}\ndiv.nav-link[data-rb-event-key=\"/groups\"] {\norder: -1;\n}\ndiv.nav-link[data-rb-event-key=\"/scenes\"] {\norder: 1;\n}\nHide the Donate button.
"},{"location":"themes/custom-css-snippets/#blur-nsfw-images","title":"Blur NSFW images","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Hide the Donate button */\n\n.btn-primary.btn.donate.minimal {\ndisplay: none;\n}\nUse for when working on stash but don't want to expose NSFW images and text. May not be exhaustive.
"},{"location":"themes/custom-css-snippets/#blur-nsfw-images-and-unblur-on-mouse-over","title":"Blur NSFW images and unblur on mouse over","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Blur NSFW images */\n\n.scene-card-preview-video,\n.scene-card-preview-image,\n.image-card-preview-image,\n.image-thumbnail,\n.gallery-card-image,\n.performer-card-image,\n.tag-card-image,\nimg.performer,\n.group-card-image,\n.gallery .flexbin img,\n.wall-item-media,\n.scene-studio-overlay .image-thumbnail,\n.image-card-preview-image,\n#scene-details-container .text-input,\n#scene-details-container .scene-header,\n#scene-details-container .react-select__single-value,\n.scene-details .pre,\n#scene-tabs-tabpane-scene-file-info-panel span.col-8.text-truncate > a,\n.gallery .flexbin img,\n.group-details .logo {\nfilter: blur(12px);\n}\n\n.scene-card-video {\nfilter: blur(13px);\n}\n\n.jw-video,\n.jw-preview,\n.jw-flag-floating,\n.image-container,\n.studio-logo,\n.scene-cover {\nfilter: blur(20px);\n}\n\n.group-card .text-truncate,\n.scene-card .card-section {\nfilter: blur(4px);\n}\nBlur NSFW images and unblur on mouse over.
fl0w#9497
"},{"location":"themes/custom-css-snippets/#hide-0-count-badges","title":"Hide 0 count badges","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Blur NSFW images and unblur on mouse over */\n/* === MORE BLUR === */\n/* scene */\n.scene-card-preview,\n.vjs-poster,\nvideo,\n.scene-cover,\n.scrubber-item,\n\n/* image */\n.image-card-preview,\n.image-image,\n.gallery-image,\n\n/* group */\n.group-card-image,\n.group-images,\n\n/* gallery */\n.gallery-card-image,\ntable > tbody > tr > td > a > img.w-100,\n\n/* performer */\n.performer-card-image,\nimg.performer,\n\n/* studio */\n.studio-card-image,\n\n/* tag */\n.tag-card-image\n\n{\nfilter: blur(30px);\n}\n\n/* === LESS BLUR === */\n/* common */\n.card-section-title,\n\n/* scene */\n.scene-studio-overlay,\n.scene-header > h3,\nh3.scene-header,\n.studio-logo,\n.image-thumbnail,\n\n/* image */\nh3.image-header,\n\n/* group */\n.group-details > div > h2,\n\n/* gallery */\nh3.gallery-header,\n\n/* studio */\n.studio-details .logo,\n.studio-details > div > h2,\n\n/* tag */\n.logo-container > .logo,\n.logo-container > h2\n\n{\nfilter: blur(2px);\n}\n\n/* === UNBLUR ON HOVER === */\n/* common */\n.thumbnail-section:hover *,\n.card:hover .card-section-title,\n\n/* scene */\n.card:hover .scene-studio-overlay,\n.video-js:hover .vjs-poster,\nvideo:hover,\n.scene-header:hover > h3,\ndiv:hover > .scene-header,\n.studio-logo:hover,\n.scene-cover:hover,\n.image-thumbnail:hover,\n.scene-card-preview:hover,\n.scrubber-item:hover,\n\n/* image */\n.image-image:hover,\ndiv:hover > .image-header,\n.gallery-image:hover,\n\n/* group */\n.group-images:hover,\n.group-details > div > h2:hover,\n\n/* gallery */\ndiv:hover > .gallery-header,\ntable > tbody > tr > td:hover > a > img.w-100,\n\n/* performer */\nimg.performer:hover,\n\n/* studio */ \n.studio-details .logo:hover,\n.studio-details:hover > div > h2,\n\n/* tag */\n.logo-container > .logo:hover,\n.logo-container:hover > h2\n{\nfilter: blur(0px);\n}\nHide 0 count badges.
echo6ix
"},{"location":"themes/custom-css-snippets/#border-around-cards-activated-with-checkbox-selection","title":"Border around cards activated with checkbox selection","text":"DescriptionAuthorScreenshotsCSS code/* [Global changes] Hide 0 count badges */\nspan.badge[data-value=\"0\"] {\n display: none;\n}\nAdd a noticeable border around any cards that have been selected using the checkbox selection. Border color uses Stash's
--primarycolor variable to maintain consistency with any theme that uses Stash's color variables.echo6ix
"},{"location":"themes/list/","title":"Browse themes","text":""},{"location":"themes/list/#browse-themes","title":"Browse themes","text":""},{"location":"themes/list/#sources","title":"Sources","text":"/* [Global changes] Modify card when checkbox is selected */\n.grid-card.card:has(input:checked) {\nbox-shadow: 0 0 0 1px var(--primary,rgba(255, 255, 255, 0.30));\n}\n- https://feederbox826.github.io/themes/main/index.yml
- https://serechops.github.io/Serechops-Stash/index.yml
- https://stashapp.github.io/CommunityScripts/stable/index.yml
- https://tetrax-10.github.io/stash-stuffs/index.yml
- https://uncertainmongoose.github.io/dracula-for-stash/index.yml
Changes the tags layout to show more images, and details on hover
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#direct-stream","title":"direct-stream","text":"DescriptionSource URLREADMEAuthorScreenshotsAdds styling to settings to indicate direct stream
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#dracula-theme","title":"Dracula Theme","text":"DescriptionSource URLREADMEAuthorScreenshotsA dark theme for Stash based on the popular Dracula theme.
https://uncertainmongoose.github.io/dracula-for-stash/index.yml\nNo README available
UncertainMongoose
"},{"location":"themes/list/#glassy-a-window-to-your-collection","title":"Glassy - A Window to Your Collection","text":"DescriptionSource URLREADMEAuthorScreenshotsA Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-font-overhaul","title":"Glassy - Font Overhaul","text":"DescriptionSource URLREADMEAuthorScreenshotsA Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-front-page-animations-and-blur","title":"Glassy - Front Page Animations and Blur","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-marker-wall-redesign","title":"Glassy - Marker Wall Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-performer-scene-card-details-redesign","title":"Glassy - Performer Scene Card Details Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-and-movie-card-redesign","title":"Glassy - Scene and Movie Card Redesign","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-and-movie-card-redesign-no-animated-titles","title":"Glassy - Scene and Movie Card Redesign - No Animated Titles","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-6040","title":"Glassy - Scene Player-Details 60/40","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-reversed","title":"Glassy - Scene Player-Details Reversed","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-scene-player-details-reversed-6040","title":"Glassy - Scene Player-Details Reversed 60/40","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-smaller-performer-cards-on-main-page","title":"Glassy - Smaller Performer Cards on Main Page","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-smaller-performer-image-cards","title":"Glassy - Smaller Performer Image Cards","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-video-res-icons","title":"Glassy - Video-Res Icons","text":"DescriptionSource URLREADMEAuthorScreenshotsA Glassy Add-On Module.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-images","title":"Glassy Images","text":"DescriptionSource URLREADMEAuthorScreenshotsImages for A Stash Theme
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#glassy-installer","title":"Glassy Installer","text":"DescriptionSource URLREADMEAuthorScreenshotsGlassy meta-package for requirements.
https://serechops.github.io/Serechops-Stash/index.yml\nView README
serechops
"},{"location":"themes/list/#hide-donate","title":"hide-donate","text":"DescriptionSource URLREADMEAuthorScreenshotsHide the Donate button.
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#hide-ocount","title":"hide-ocount","text":"DescriptionSource URLREADMEAuthorScreenshotsHide O-Count and O-Count trakcers
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#more-studio-row","title":"more-studio-row","text":"DescriptionSource URLREADMEAuthorScreenshotsDisplay more studio per row
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#no-autotag","title":"no-autotag","text":"DescriptionSource URLREADMEAuthorScreenshotsHide autotagger, everywhere
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#no-speed","title":"no-speed","text":"DescriptionSource URLREADMEAuthorScreenshotsHide the playback speed button
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#noto-color-emoji","title":"noto-color-emoji","text":"DescriptionSource URLREADMEAuthorScreenshotsNoto Color Emoji font
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#performer-grid","title":"performer-grid","text":"DescriptionSource URLREADMEAuthorScreenshotsAligns performer details in a grid
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"themes/list/#theme-blackhole","title":"Theme - BlackHole","text":"DescriptionSource URLREADMEAuthorScreenshotsBlackHole Theme for Stash by BViking78
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
BViking78
"},{"location":"themes/list/#theme-colorpalette","title":"Theme - colorPalette","text":"DescriptionSource URLREADMEAuthorScreenshotsBased on the default theme, change the overall color of the page by setting the hue value. Make minor changes to the remaining styles.
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
wql219
"},{"location":"themes/list/#theme-minimal","title":"Theme - Minimal","text":"DescriptionSource URLREADMEAuthorScreenshotsMinimal Theme for Stash
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
deuulc
"},{"location":"themes/list/#theme-moderndark","title":"Theme - ModernDark","text":"DescriptionSource URLREADMEAuthorScreenshotsModernDark Theme for Stash by cj13
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
cj13
"},{"location":"themes/list/#theme-neondark","title":"Theme - NeonDark","text":"DescriptionSource URLREADMEAuthorScreenshotsNeonDark Theme for Stash by Dankonite
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Dankonite
"},{"location":"themes/list/#theme-night","title":"Theme - Night","text":"DescriptionSource URLREADMEAuthorScreenshotsNight Theme for Stash (unknown author)
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
No Author
"},{"location":"themes/list/#theme-plex","title":"Theme - Plex","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fidelio 2020
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fidelio
"},{"location":"themes/list/#theme-plex-better-styles","title":"Theme - Plex Better Styles","text":"DescriptionSource URLREADMEAuthorScreenshotsA modified version of Stash-Plex theme
https://tetrax-10.github.io/stash-stuffs/index.yml\nView README
tetrax-10
"},{"location":"themes/list/#theme-pornhub","title":"Theme - Pornhub","text":"DescriptionSource URLREADMEAuthorScreenshotsPornHub Theme for Stash by neurokinin
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
ronilaukkarinen
"},{"location":"themes/list/#theme-pulsar","title":"Theme - Pulsar","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fonzie 2020-21
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#theme-pulsarlight","title":"Theme - PulsarLight","text":"DescriptionSource URLREADMEAuthorScreenshotsPlex Theme for Stash by Fonzie 2021
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#theme-rounded-yellow","title":"Theme - Rounded Yellow","text":"DescriptionSource URLREADMEAuthorScreenshotsTheme with rounded corners and yellow accents
https://stashapp.github.io/CommunityScripts/stable/index.yml\nNo README available
Fonzie
"},{"location":"themes/list/#wrap-subtag","title":"wrap-subtag","text":"DescriptionSource URLREADMEAuthorScreenshotsWraps detail values (subtags)
https://feederbox826.github.io/themes/main/index.yml\nNo README available
feederbox826
"},{"location":"userscripts/","title":"Userscripts","text":"Info
Userscripts are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Userscripts are programs written in Javascript that modifies web pages to improve browsing with new features, formatting and more.
"},{"location":"userscripts/#install","title":"Install","text":"To install the userscript you will need a browser extension such as:
- Violentmonkey
- Tampermonkey
- Greasemonkey
Exhaustive list of git repositories related to Stash Google Sheets document.
Userscript no longer worksIf you found that userscript is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"userscripts/list/#stash-userscripts","title":"Stash userscripts","text":"CompatabilityMake sure your instance URL is declared in
"},{"location":"userscripts/list/#performer-image-carousel","title":"Performer Image Carousel","text":"DescriptionAuthorScreenshots@match.Displays a carousel of performer images in the header.
Serechops
"},{"location":"userscripts/list/#stash-checker","title":"stash-checker","text":"DescriptionAuthorScreenshotsStash Checker is an userscript for porn websites to check if a Scene/Performer is in your Stash instance. It shows a checkmark if an item was found in your Stash. Hovering over the checkmark gives you a tooltip with information about the item in your Stash.
timo95
"},{"location":"userscripts/list/#stashcreateall","title":"stashCreateAll","text":"DescriptionAuthorScreenshotsAutomate batch creation and tagging
Serechops
"},{"location":"userscripts/list/#stash-box-userscripts","title":"stash-box userscripts","text":"stash-box compatabilitySometimes just updating
"},{"location":"userscripts/list/#db-noto-color","title":"db-noto-color","text":"DescriptionAuthorScreenshots@matchis enough to make the userscript to work on a different stash-box instance. But it's not a guarantee.Adds Noto Color Emoji to stash-box instances
feederbox826
"},{"location":"userscripts/list/#fansdb-submission-helper","title":"FansDB Submission Helper","text":"DescriptionREADMEAuthorScreenshots- Adds button to add all unmatched aliases to performer
- Adds button to add all unmatched urls to performer
- Adds button to add all unmatched measurements to performer (if they match expected formats)
- Convert unmatched urls from regular strings to linked strings
View README
mmenanno, DogmaDragon
"},{"location":"userscripts/list/#stashdb-submission-helper","title":"StashDB Submission Helper","text":"DescriptionREADMEAuthorScreenshots- Adds button to add all unmatched aliases to performer
- Adds button to add all unmatched urls to performer
- Adds button to add all unmatched measurements to performer (if they match expected formats)
- Convert unmatched urls from regular strings to linked strings
View README
mmenanno
"},{"location":"userscripts/list/#stashdb-diff","title":"stashdb-diff","text":"DescriptionAuthorScreenshotsadd character-by-character diff for stashdb
feederbox826
"},{"location":"userscripts/list/#stashdb-link-chip","title":"stashdb-link-chip","text":"DescriptionAuthorScreenshotsadd chips to links in edit queue
feederbox826
"},{"location":"userscripts/list/#stashdb-relative-date","title":"stashdb-relative-date","text":"DescriptionAuthorScreenshotsadds relative dates to stashdb
feederbox826
"},{"location":"userscripts/list/#stashdb-rm","title":"stashdb-rm","text":"DescriptionAuthorScreenshotsRemove scenes from loaded studios on stashdb.org
feederbox826
"},{"location":"userscripts/list/#studio-image-blur-for-stashdb","title":"Studio Image Blur for StashDB","text":"DescriptionAuthorScreenshotsBlurs images from specific studios on StashDB scene cards, based on studio name and img src
Serechops
"},{"location":"userscripts/list/#utility-userscripts","title":"Utility userscripts","text":"There are some userscripts that might be useful to Stash users, but does not directly involve Stash or stash-box instances.
"},{"location":"userscripts/list/#twitter-media-unblur","title":"twitter-media-unblur","text":"DescriptionAuthorScreenshotsunblur all twitter sensitive media post
feederbox826
"},{"location":"userscripts/list/#pmvhaven-autodl","title":"PMVHaven AutoDL","text":"DescriptionAuthorScreenshotsDashboard to simplify PMV downloading on PMVHaven
S3L3CT3DLoves
"},{"location":"userscripts/list/#spankbang-autodl","title":"SpankBang AutoDL","text":"DescriptionAuthorScreenshotsDashboard to download all a user's videos on SpankBang
S3L3CT3DLoves
"},{"location":"userscripts/list/#spankbang-frontend-scraper","title":"SpankBang Frontend Scraper","text":"DescriptionAuthorScreenshotsUse in Stash to scrape Spankbang from the browser, bypassing cloudflare issues
S3L3CT3DLoves
"},{"location":"userscripts/list/#lifeselector-unblur","title":"LifeSelector unblur","text":"DescriptionAuthorScreenshotsUnblur LifeSelector website
feederbox826
"},{"location":"userscripts/list/#redgifs-autosettings","title":"redgifs autosettings","text":"DescriptionAuthorScreenshotsAuto Unmute / Play / HD redgifs
feederbox826
"},{"location":"userscripts/list/#stash-tmdb-syncscraper","title":"Stash-TMDB Sync/Scraper","text":"DescriptionAuthorScreenshotsSync Button in TMDB Site.to Create Movie/Performer in Stash and Update performer missing info.
W0lfieW0lf
"},{"location":"utilities/","title":"Utilities","text":"Info
Utilities are created by third parties and not officially affiliated or supported by the core Stash team. If you have issues, please reach out to the original creators.
Utilities are other external applications that utilise or interact with Stash in some way.
To install follow the utilities install instructions.
"},{"location":"utilities/list/","title":"Browse utilities","text":"stash-git-indexExhaustive list of git repositories related to Stash Google Sheets document.
Utility no longer worksIf you found that utility is no longer working you can try contacting the author directly or create an issue on their Git platform. You can also create a GitHub issue on Stash-Docs for it to be removed from the list.
"},{"location":"utilities/list/#clip-mash","title":"clip-mash","text":"DescriptionAuthorScreenshotsVideo editing app that allows you to automate creating compilations from multiple videos. It runs in your browser. It's mostly made for, ahem, adult content, which is why it can connect to Stash and fetch videos and scene markers from there to guide the video creation process. You can also use local files and set the markers in ClipMash itself and then generate a compilation based on that.
soundchaser128
"},{"location":"utilities/list/#stash-app-for-android-tv","title":"Stash App for Android TV","text":"DescriptionAuthorScreenshotsA basic Android TV app for browsing and playing videos from a Stash server. Not all features of Stash are supported, but the basics for browsing, searching, and playing scenes should work. The app is not intended to perform administrative functions such as scanning, scraping, or editing details.
damontecres
"},{"location":"utilities/list/#stash-compilation-maker","title":"stash-compilation-maker","text":"DescriptionAuthorScreenshotsConnects to your Stash instance and creates simple compilation videos from scene markers. You select one or more tags, or one or more performers and it will take (currently) the first 15 seconds of video after the marker start and compile all of the markers into one video.
soundchaser128
"},{"location":"utilities/list/#stash-qmt","title":"stash-qmt","text":"DescriptionAuthorScreenshotsstash-qmt (quick manual tagger) is a simple GUI tool designed to help with cases of manually tagging multiple similar scenes (manually, as in, with having to actually watch them) in Stash.
PokerFacowaty
"},{"location":"utilities/list/#stash-vr-companion","title":"stash-vr-companion","text":"DescriptionAuthorScreenshotsSimilar to stash-deovr as above but designed as a web app that sits in a docker container next to stash to make it easier to use and add more functionality.
Tweeticoats
"},{"location":"utilities/list/#stash-vr","title":"stash-vr","text":"DescriptionAuthorScreenshotsWatch your Stash library in VR for that full immersion effect.
Stash-VR bridges your Stash instance and VR video player allowing you to browse, play and manage your scenes using the video players native VR UI.
o-fl0w
"},{"location":"utilities/list/#stash-webvr","title":"stash-webvr","text":"DescriptionAuthorScreenshotsWebVR friendly Stash client that displays only videos tagged with \"Virtual Reality\" tag.
stishadmin
"},{"location":"utilities/list/#stash_helper","title":"Stash_helper","text":"DescriptionAuthorScreenshotsAdds some helping features to Stash (Bookmarks, playlist, external player, etc). Windows only.
philpw99
"},{"location":"utilities/list/#stashbox-performer-bot","title":"StashBox Performer Bot","text":"DescriptionAuthorScreenshotsThis program is designed to help automate the creation and updating of Performers on StashBox instances. It is designed to copy Performer info from one StashBox to another, to avoid having to maintain the information in both sources manually.
S3L3CT3DLoves
"}]} \ No newline at end of file
