Stash

https://github.com/stashapp/stash
Admin
Stash is a self-hosted web application written in Go that organizes and serves your media...
Tokens:148,317
Snippets:1,004
Trust Score:-
License:AGPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Studios - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to query studios with name, url, and scene_count fields.

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{ allStudios { name url scene_count} }" }' localhost:9998/graphql
```

--------------------------------

### Start and enable Stash service

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Start the stash service and enable it to run at boot.

```bash
sudo systemctl start stash.service
sudo systemctl enable stash.service
```

--------------------------------

### Install gql-iterate via npm

Source: https://github.com/stashapp/stash/wiki/Importing-via-CSV-using-gql-iterate

Install the gql-iterate CLI globally using npm.

```bash
npm install @efstajas/gql-iterate -g
```

--------------------------------

### Install gql-iterate via yarn

Source: https://github.com/stashapp/stash/wiki/Importing-via-CSV-using-gql-iterate

Install the gql-iterate CLI globally using yarn.

```bash
yarn add @efstajas/gql-iterate -g
```

--------------------------------

### Build example plugins with go build

Source: https://github.com/stashapp/stash/blob/develop/pkg/plugin/examples/README.md

Builds the example plugins from the base stash source directory. The resulting binaries must be placed together with the yml files in the `plugins` subdirectory of your stash directory.

```bash
go build -tags=plugin_example -o plugin_goraw.exe ./pkg/plugin/examples/goraw/...
go build -tags=plugin_example -o plugin_gorpc.exe ./pkg/plugin/examples/gorpc/...
```

--------------------------------

### Install scraper dependencies

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Activate the stash environment, navigate to the scraper directory, generate requirements with pipreqs, and install them.

```bash
source stash-env/bin/activate
cd your_scraper_directory
pipreqs .
sudo pip3 install -r requirements.txt
```

--------------------------------

### Get list of performer names from Freeones - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to search Freeones for "bella".

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{ scrapeFreeonesPerformerList (query: \"bella\" ) }" }' localhost:9998/graphql
```

--------------------------------

### Get System Status - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to query systemStatus for appSchema and status fields. Note that this example uses port 9999 instead of 9998.

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{ systemStatus { appSchema status } }" }' localhost:9999/graphql
```

--------------------------------

### Patch IInteractiveClient.connect with custom provider (TypeScript)

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/UIPluginApi.md

Example of installing a custom interactive client provider to add logging when connect() is called. It throws an error if no default provider is present, then wraps the default client's connect method.

```typescript
InteractiveUtils.interactiveClientProvider = (
  opts
) => {
  if (!opts.defaultClientProvider) {
    throw new Error('invalid setup');
  }

  const client = opts.defaultClientProvider(opts);
  const connect = client.connect;
  client.connect = async () => {
      console.log('patching connect method');
      return connect.call(client);
    };
   
  return client;
};

```

--------------------------------

### Example assets mapping (YAML)

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Plugins.md

Example of the 'assets' field in a plugin configuration. Maps URL prefixes to filesystem paths relative to the plugin configuration file. For a plugin with id 'foo', this maps '/plugin/foo/assets/foo/file.txt' to '{pluginDir}/bar/file.txt', '/plugin/foo/assets/file.txt' to '{pluginDir}/file.txt', and '/plugin/foo/assets/bar/file.txt' to '{pluginDir}/bar/file.txt' via the '/' entry.

```yaml
assets:
  foo: bar
  /: .

```

--------------------------------

### Generate content - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to send the metadataGenerate mutation with previews set to true and others false.

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "mutation { metadataGenerate ( input : { sprites: false previews: true imagePreviews: false markers: false transcodes: false } ) }" }' localhost:9998/graphql
```

--------------------------------

### Example performer CSV data

Source: https://github.com/stashapp/stash/wiki/Importing-via-CSV-using-gql-iterate

Example rows for the CSV file. Only name and eye_color are filled in.

```csv
Alice,,,,,,blue
Betty,,,,,,green
Carter,,,,,,brown
```

--------------------------------

### Build frontend and backend with make commands

Source: https://github.com/stashapp/stash/blob/develop/docs/ARCHITECTURE.md

These commands build the frontend, start a development server with hot-reload, and then build the backend. The backend build requires the frontend to be built first.

```bash
# Build frontend
make ui
```

```bash
# Develop frontend with hot-reload
make ui-start
```

```bash
# Build backend (requires frontend to be built first)
make build
```

--------------------------------

### Prepare Python environment for scrapers

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Set up a Python virtual environment and install pipreqs for scraper dependencies.

```bash
sudo -H python -m ensurepip --upgrade
python3 -m venv stash-env
source stash-env/bin/activate
pip3 install pipreqs
```

--------------------------------

### Example hookContext for Scene.Update.Post

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Plugins.md

Example 'args' values for a Scene update operation hook. Shows the hookContext with type 'Scene.Update.Post', id 45, and the input fields including tag_ids and id.

```json
{
    "hookContext": {
        "type":"Scene.Update.Post",
        "id":45,
        "input":{
            "clientMutationId":null,
            "id":"45",
            "title":null,
            "details":null,
            "url":null,
            "date":null,
            "rating":null,
            "organized":null,
            "studio_id":null,
            "gallery_ids":null,
            "performer_ids":null,
            "groups":null,
            "tag_ids":["21"],
            "cover_image":null,
            "stash_ids":null
        },
        "inputFields":[
            "tag_ids",
            "id"
        ]
    }
}
```

--------------------------------

### Return plugin output using a main function

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md

Example #2: Defines a main function that returns the output object, then calls it. The result of the call is the evaluated value.

```javascript
function main() {
    return {
        Output: "ok"
    };
}

main();
```

--------------------------------

### Run stash/build container with docker run (concrete paths)

Source: https://github.com/stashapp/stash/blob/develop/docker/build/x86_64/README.md

Using the example directory structure, this command mounts /stash/config, /media, /stash/metadata, /stash/cache, and /stash/generated to the appropriate container paths.

```bash
docker run \
 -e STASH_STASH=/data/ \
 -e STASH_METADATA=/metadata/ \
 -e STASH_CACHE=/cache/ \
 -e STASH_GENERATED=/generated/ \
 -v /stash/config:/root/.stash \
 -v /media:/data \
 -v /stash/metadata:/metadata \
 -v /stash/cache:/cache \
 -v /stash/generated:/generated \
 -p 9999:9999 \
 stash/build:latest 

```

--------------------------------

### replace postProcess example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Replaces text using a regex pattern. The example replaces '2001 to 2003' with '2001-2003' by matching '\s+to\s+' and replacing with '-'. Capture groups are referenced with $1, $2, etc.

```yaml
CareerLength: 
  selector: $infoPiece[text() = 'Career Start and End:']/../span[@class="smallInfo"]
    postProcess:
      - replace:
          - regex: \s+to\s+
            with: "-"
```

--------------------------------

### Scan for new files - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to send the metadataScan mutation with useFileMetadata set to false.

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": " mutation { metadataScan (input: { useFileMetadata: false} ) }" }' localhost:9998/graphql
```

--------------------------------

### Symlink ffmpeg and ffprobe into ~/.stash

Source: https://github.com/stashapp/stash/wiki/Installing-on-FreeNAS-TrueNAS

Create symbolic links in $HOME/.stash to the ffmpeg and ffprobe binaries so stash can find them after installing via pkg install ffmpeg.

```bash
ln -s /usr/local/bin/ffmpeg ~/.stash/ffmpeg
ln -s /usr/local/bin/ffprobe ~/.stash/ffprobe
```

--------------------------------

### Script action YAML configuration

Source: https://github.com/stashapp/stash/wiki/Scraping-configuration

Example YAML configuration for the Script action. The 'script' field is required and accepts a list of string arguments. This example runs 'python iafdScrape.py query'.

```yaml
action: script
script:
  - python
  - iafdScrape.py
  - query
```

--------------------------------

### Example directory structure for stash

Source: https://github.com/stashapp/stash/blob/develop/docker/build/x86_64/README.md

Recommended directory layout where cache, generated, and metadata are in the same parent directory, and media is separate.

```text
/stash
  /config
  /metadata
  /generated
  /cache
/media

```

--------------------------------

### SceneStore Find method

Source: https://github.com/stashapp/stash/blob/develop/docs/ARCHITECTURE.md

Example query from pkg/sqlite/scene.go showing how a repository method retrieves a single scene by ID. Uses the repository's queryStruct helper to execute a query and map the result to a models.Scene. Returns an error if the query fails.

```go
func (qb *SceneStore) Find(ctx context.Context, id int) (*models.Scene, error) {
    var scene models.Scene
    err := qb.repository.queryStruct(ctx, qb.sceneQuery(), []interface{}{id}, &scene)
    if err != nil {
        return nil, err
    }
    return &scene, nil
}
```

--------------------------------

### javascript postProcess example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Uses a javascript code block that must return a string. The input string is available in the 'value' variable. If an error occurs while compiling or running the script, the original value is returned. The example capitalises the first letter of the value.

```yaml
performer:
  Name:
    selector: //div[@class="example element"]
    postProcess:
      - javascript: |
          // capitalise the first letter
          if (value && value.length) {
            return value[0].toUpperCase() + value.substring(1)
          }
```

--------------------------------

### XPath scraper configuration example for performer and scene

Source: https://github.com/stashapp/stash/wiki/Scraping-configuration

Example YAML configuration for an XPath scraper that defines performer and scene scrapers with common selectors, post-processing (replace, parseDate), and field mappings. Demonstrates the use of variables, selectors, and nested fields.

```yaml
name: Pornhub
performerByURL:
  - action: scrapeXPath
    url: 
      - pornhub.com
    scraper: performerScraper
sceneByURL:
  - action: scrapeXPath
    url: 
      - pornhub.com/view_video.php
    scraper: sceneScraper
xPathScrapers:
  performerScraper:
    common:
      $infoPiece: //div[@class="infoPiece"]/span
    performer:
      Name: //h1[@itemprop="name"]
      Birthdate: 
        selector: //span[@itemprop="birthDate"]
        parseDate: Jan 2, 2006
      Twitter: //span[text() = 'Twitter']/../@href
      Instagram: //span[text() = 'Instagram']/../@href
      Measurements: $infoPiece[text() = 'Measurements:']/../span[@class="smallInfo"]
      Height: 
        selector: $infoPiece[text() = 'Height:']/../span[@class="smallInfo"]
        replace: 
          - regex: .*\((\d+)\)
            with: $1
      Ethnicity: $infoPiece[text() = 'Ethnicity:']/../span[@class="smallInfo"]
      FakeTits: $infoPiece[text() = 'Fake Boobs:']/../span[@class="smallInfo"]
      Piercings: $infoPiece[text() = 'Piercings:']/../span[@class="smallInfo"]
      Tattoos: $infoPiece[text() = 'Tattoos:']/../span[@class="smallInfo"]
      CareerLength: 
        selector: $infoPiece[text() = 'Career Start and End:']/../span[@class="smallInfo"]
        replace:
          - regex: \s+to\s+
            with: "-"
  sceneScraper:
    common:
      $performer: //div[@class="pornstarsWrapper"]/a[@data-mxptype="Pornstar"]
      $studio: //div[@data-type="channel"]/a
    scene:
      Title: //div[@id="main-container"]/@data-video-title
      Tags: 
        Name: //div[@class="categoriesWrapper"]//a[not(@class="add-btn-small ")]
      Performers:
        Name: $performer/@data-mxptext
        URL: $performer/@href
      Studio:
        Name: $studio
        URL: $studio/@href    
```

--------------------------------

### Authentication - API Key header curl example

Source: https://github.com/stashapp/stash/wiki/API

Recommended authentication method for latest dev version. Add the generated API key in a header for every request.

```bash
curl -X POST -H "ApiKey: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJiaWxsIiwiaWF0IjoxNjE3MDkzMDYwLCJzdWIiOiJBUElLZXkifQ.WhUyvmnVeW8wGV5fkVyje3xLfz5A97HFwyZy-4i8Q-I" -H "Content-Type: application/json" --data '{ "query": "mutation { metadataScan (input:{useFileMetadata: false})}" }' localhost:9998/graphql
```

--------------------------------

### map, feetToCm, lbToKg postProcess example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Shows a performer scraper that maps gender values (F to Female, M to Male), converts height from feet/inches to cm, and weight from lbs to kg. The map operation replaces matching input values with output values; unmatched values remain unmodified.

```yaml
performer:
  Gender:
    selector: //div[@class="example element"]
    postProcess:
      - map:
          F: Female
          M: Male
  Height:
    selector: //span[@id="height"]
    postProcess:
      - feetToCm: true
  Weight:
    selector: //span[@id="weight"]
    postProcess:
      - lbToKg: true
```

--------------------------------

### Stash scrape configuration example

Source: https://github.com/stashapp/stash/wiki/Scraping-configuration

Example YAML configuration for using a remote stash server as a scraping source. Requires the top-level 'stashServer' field with a 'url' that may include embedded credentials. Applies to performerByName, performerByFragment, and sceneByFragment actions.

```yaml
name: stash
performerByName:
  action: stash
performerByFragment:
  action: stash
sceneByFragment:
  - action: stash
stashServer:
  url: http://stashserver.com:9999
```

--------------------------------

### Return plugin output using a variable

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md

Example #3: Assigns the output object to a variable and then evaluates that variable as the last expression.

```javascript
var output = {
    Output: "ok"
};

output;
```

--------------------------------

### Python performer scraper example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Python example of a performer scraper that reads JSON input from stdin, handles 'query', 'scrape', and 'scrapeURL' commands, and outputs JSON to stdout. Errors and progress messages should be written to stderr.

```python
import json
import sys
import string

def readJSONInput():
	input = sys.stdin.read()
	return json.loads(input)


def searchPerformer(name):
    # perform scraping here - using name for the query

    # fill in the output
    ret = []
    
    # example shown for a single found performer 
    p = {}
    p['name'] = "some name"
    p['url'] = "performer url"
    ret.append(p)
    
    return ret

def scrapePerformer(input):
    ret = []
    # get the url from the input
    url = input['url']
    return scrapePerformerURL(url)

def debugPrint(t):
    sys.stderr.write(t + "\n")

def scrapePerformerURL(url):
    debugPrint("Reading url...")
    debugPrint("Parsing html...")
    
    # parse html

    # fill in performer details - single object
    ret = {}

    ret['name'] = "fred"
    ret['aliases'] = "freddy"
    ret['ethnicity'] = ""
    # and so on

    return ret

# read the input 
i = readJSONInput()

if sys.argv[1] == "query":
    ret = searchPerformer(i['name'])
    print(json.dumps(ret))
elif sys.argv[1] == "scrape":
    ret = scrapePerformer(i)
    print(json.dumps(ret))
elif sys.argv[1] == "scrapeURL":
    ret = scrapePerformerURL(i['url'])
    print(json.dumps(ret))

```

--------------------------------

### Start StashApp with docker compose up

Source: https://github.com/stashapp/stash/blob/develop/docker/production/README.md

Starts the StashApp container in detached mode using Docker Compose. By default, StashApp binds to port 9999 and is accessible at http://localhost:9999 or http://YOUR-LOCAL-IP:9999.

```bash
docker compose up -d
```

--------------------------------

### Scrape performer attributes from Freeones - curl example

Source: https://github.com/stashapp/stash/wiki/API

Example using curl to scrape Freeones for "Abella Danger" and return name, height, and birthdate.

```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{ scrapeFreeones ( performer_name : \"Abella Danger\" ) { name height birthdate} }" }' localhost:9998/graphql
```

--------------------------------

### Custom served folders configuration in config.yml

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Interface.md

Example of configuring custom served folders in config.yml. The '/custom' URL path prefix exposes these folders. The '/' entry matches any path not otherwise mapped.

```yaml
custom_served_folders:
  /: D:\stash\static
  /foo: D:\bar
```

--------------------------------

### Add remote for Codeberg Weblate repository

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/locales/README.md

First-time setup command to add the Codeberg Weblate repository as a remote named 'weblate_codeberg'.

```bash
git remote add weblate_codeberg https://translate.codeberg.org/git/stash/stash/
```

--------------------------------

### performerByName and performerByURL with xPathScrapers

Source: https://github.com/stashapp/stash/wiki/Scraping-configuration

Shows a complete performerByName and performerByURL setup using scrapeXPath, including the queryURL placeholder and the required xPathScrapers definitions.

```yaml
name: Boobpedia
performerByName:
  action: scrapeXPath
  queryURL: http://www.boobpedia.com/wiki/index.php?title=Special%3ASearch&search={}&fulltext=Search
  scraper: performerSearch
performerByURL:
  - action: scrapeXPath
    url: 
      - boobpedia.com/boobs/
    scraper: performerScraper
xPathScrapers:
  performerSearch:
    performer:
      Name: # name element
      URL: # URL element that matches the boobpedia.com/boobs/ URL above
  performerScraper:
    # ... performer scraper details ...

```

--------------------------------

### Example .stashignore file

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Tasks.md

Shows a .stashignore file that ignores temporary files and specific directories, while keeping a specific file using negation. Place this file in any directory within your library; patterns apply to all files and subdirectories within that directory.

```plaintext
# Ignore temporary files
*.tmp
*.log

# Ignore specific directories
temp/
.thumbnails/

# But keep this specific file
!important.tmp
```

--------------------------------

### Return plugin output using an IIFE

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md

Example #1: Uses an immediately-invoked function expression (IIFE) to return the plugin output object. The evaluated value of the script becomes the output.

```javascript
(function() {
    return {
        Output: "ok"
    };
})();
```

--------------------------------

### Example scraper source YAML format

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Scraping.md

Defines the required structure for a scraper source YAML file. The source URL must return a YAML file containing all available packages. The path can be a relative path to the zip file or an external URL.

```yaml
- id: <package id>
  name: <package name>
  version: <version>
  date: <date>
  requires:
  - <ids of packages required by this package (optional)>
  - ...
  path: <path to package zip file>
  sha256: <sha256 of zip>
  metadata:
    <optional key/value pairs for extra information>
- ...
```

--------------------------------

### Common fragment example with $infoPiece

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Defines a common fragment $infoPiece and uses it in the Measurements selector to build a more complex XPath expression.

```yaml
common:
  $infoPiece: //div[@class="infoPiece"]/span
performer:
  Measurements: $infoPiece[text() = 'Measurements:']/../span[@class="smallInfo"]
```

--------------------------------

### Create a tag using gql.Do

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md

Example of using the gql.Do API to execute a GraphQL mutation. The mutation string is defined with escaped newlines, and the variables object is passed. The result is logged with log.Info.

```javascript
// creates a tag
var mutation = "\
mutation tagCreate($input: TagCreateInput!) {\
  tagCreate(input: $input) {\
    id\
  }\
}";

var variables = {
    input: {
        'name': tagName
    }
};

result = gql.Do(mutation, variables);
log.Info("tag id = " + result.tagCreate.id);
```

--------------------------------

### Unsupported recursive common fragments

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Shows an example of recursive common fragments that will cause an error because referencing $info in $models is not supported.

```yaml
common:
  $info: //div[@class="info"]
  # Referencing $info in $models will cause an error
  $models: $info/a[@class="model"]
scene:
  Title: $info/h1
  Performers:
    Name: $models
    URL: $models/@href
```

--------------------------------

### Custom served folders config for static images in custom CSS

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Interface.md

Example of configuring a custom served folder to use static images in custom CSS, such as for a Plex theme. The 'background.png' and 'noise.png' files can be placed in the custom folder and referenced via '/custom/...'.

```yaml
custom_served_folders:
  /: <stash folder>\custom
```

--------------------------------

### Use ValueRandom for cookie values

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Shows how to replace static `Value` with `ValueRandom` to generate random cookie strings. `ValueRandom` requires an integer greater than 0 indicating the length. The example sets `_test2` to length 6 and `_warn` to length 3.

```yaml
driver:
  cookies:
    - CookieURL: "https://www.example.com"
      Cookies:
        - Name: "_warning"
          Domain: ".example.com"
          Value: "true"
          Path: "/"
        - Name: "_test2"
          ValueRandom: 6
          Domain: ".example.com"
          Path: "/"
    - CookieURL: "https://api.somewhere.com"
      Cookies:
        - Name: "_warn"
          ValueRandom: 3
          Domain: ".somewhere.com"
```

--------------------------------

### Config file regex exclusion patterns

Source: https://github.com/stashapp/stash/wiki/Exclude-file-configuration

Add these regex patterns to the config file under the 'exclude' key. Patterns are case-insensitive and match partially. Double escaping of backslashes is required. The examples cover sample.mp4 files, hidden directories, Windows paths, and network paths.

```yaml
exclude: 
- "sample\\.mp4$"
- "/\\.[[:word:]]+/"
- "c:\\\\stash\\\\videos\\\\exclude"
- "^/stash/videos/exclude/"
- "\\\\stash\\network\\share\\excl\\"
```

--------------------------------

### Run stash/build container with docker run (template)

Source: https://github.com/stashapp/stash/blob/develop/docker/build/x86_64/README.md

After building the container, run it with docker run, setting environment variables for stash, metadata, cache, and generated directories, and mounting volumes for config, media, metadata, cache, and generated. Replace <path to config dir>, <path to media>, etc. with appropriate paths. The media directory should be separate from cache, generated, and metadata.

```bash
docker run \
 -e STASH_STASH=/data/ \
 -e STASH_METADATA=/metadata/ \
 -e STASH_CACHE=/cache/ \
 -e STASH_GENERATED=/generated/ \
 -v <path to config dir>:/root/.stash \
 -v <path to media>:/data \
 -v <path to metadata>:/metadata \
 -v <path to cache>:/cache \
 -v <path to generated>:/generated \
 -p 9999:9999 \
 stash/build:latest 

```

--------------------------------

### Run backend tests with make it

Source: https://github.com/stashapp/stash/blob/develop/docs/ARCHITECTURE.md

Use this command to run the backend test suite. It is invoked from the project root.

```bash
# Backend test
make it
```

--------------------------------

### Get System Status - GraphQL query payload

Source: https://github.com/stashapp/stash/wiki/API

Payload for the systemStatus query to get databaseSchema, databasePath, configPath, appSchema, and status.

```json
{
  "query": "{ systemStatus { databaseSchema databasePath configPath appSchema status } }" 
}
```

--------------------------------

### Download ffmpeg and checksum

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Download the ARM64 static build of ffmpeg and its MD5 checksum.

```bash
wget https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-arm64-static.tar.xz
wget https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-arm64-static.tar.xz.md5
```

--------------------------------

### exec configuration with binary and arguments

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ExternalPlugins.md

Shows the exec field for an external plugin task, where the first element is the binary and subsequent elements are arguments. The binary is searched in the path and then in the plugin config directory. The {pluginDir} placeholder can be used in arguments.

```yaml
exec:
  - my_plugin
  - foo
  - bar
```

--------------------------------

### Remove shimmer effect on start page and settings

Source: https://github.com/stashapp/stash/wiki/Theme-Light-Pulsar

Removes the glowing shimmer effect from cards on the start page and settings for readability, using !important to override the default card background.

```css
/* --- Removes the glowing shimmer effect on the start page & the settings for readability purpose --- */
.mx-auto.card, .changelog-version.card {
	background-image: none !important; 
	background-color: rgba(16, 20, 25, .40) !important; 
}
```

--------------------------------

### Unpack and move ffmpeg to .stash/

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Extract the ffmpeg archive and move the ffmpeg and ffprobe binaries into the .stash/ folder.

```bash
tar xvf ffmpeg-release-arm64-static.tar.xz
mv ffmpeg-4.4-arm64-static/ffmpeg ffmpeg-4.4-arm64-static/ffprobe .stash/
```

--------------------------------

### Make stash-linux executable

Source: https://github.com/stashapp/stash/wiki/Installing-on-FreeNAS-TrueNAS

Make the downloaded stash-linux binary executable before running it.

```bash
chmod +x stash-linux
```

--------------------------------

### Create systemd service file for Stash

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Create the stash.service file by running cat and pasting the provided unit configuration. Save with CTRL+D.

```ini
[Unit]
Description=Run Stash at startup
After=network.target

[Service]
Type=simple
User=stash
ExecStart=/bin/bash -c '\
   source /var/services/homes/stash/stash-env/bin/activate stash-env; \
   exec /var/services/homes/stash/stash-linux-arm64v8'
Restart=on-failure

[Install]
WantedBy=multi-user.target
# end
```

--------------------------------

### subtractDays postProcess example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Subtracts a number of days from the current date and returns the resulting date in stash's date format. The example first replaces a pattern like '3 days ago' with the number, then subtracts that many days.

```yaml
Date:
  selector: //strong[contains(text(),"Added:")]/following-sibling::text()
  postProcess:
    - replace:
        - regex: (\d+)\sdays\sago.+
          with: $1
    - subtractDays: true
```

--------------------------------

### Apache prerequisites - enable modules

Source: https://github.com/stashapp/stash/wiki/Reverse-proxy

Prerequisites for the Apache configuration: enables required Apache modules including proxy, rewrite, headers, and ssl.

```bash
sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2enmod proxy_balancer
sudo a2enmod lbmethod_byrequests

sudo a2enmod rewrite
sudo a2enmod headers

# for SSL
sudo a2enmod ssl
```

--------------------------------

### Using {inputHostname} placeholder in scene fields

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Uses the {inputHostname} placeholder to set the studio name and to select the description from a div with a data-domain attribute.

```yaml
scene:
  Studio:
    fixed: "{inputHostname}"
  Details:
    selector: //div[@data-domain="{inputHostname}"]//p[@class="description"]
```

--------------------------------

### Run gql-iterate import command

Source: https://github.com/stashapp/stash/wiki/Importing-via-CSV-using-gql-iterate

CLI command to import performers from a CSV file using the performers.gql query. Assumes files are in the current directory and gql-iterate is in PATH.

```bash
gql-iterate --host http://_yourserverIP:portgoeshere_/graphql --input ./performerdata.csv --query ./performers.gql
```

--------------------------------

### Hide 'old.' Text on Small Screens

Source: https://github.com/stashapp/stash/wiki/Theme-Pulsar

Hides the term 'old.' from 'xx years old.' when the screen resolution gets too small.

```css
@media (max-width: 1700px) {
div.card.performer-card .text-muted {text-align:right;margin-top:-2px;margin-bottom:1px;margin-right:-33px; height:20px; max-height:20px; overflow: hidden;
}
}
```

--------------------------------

### Download docker-compose.yml with curl

Source: https://github.com/stashapp/stash/blob/develop/docker/production/README.md

Creates a stashapp directory, changes into it, and downloads the docker-compose.yml file from the StashApp repository using curl.

```bash
mkdir stashapp && cd stashapp
curl -o docker-compose.yml https://raw.githubusercontent.com/stashapp/stash/develop/docker/production/docker-compose.yml
```

--------------------------------

### Get Studios - GraphQL query payload

Source: https://github.com/stashapp/stash/wiki/API

Payload for the allStudios query. Must include at least one of id, checksum, url, name, image_path, or scene_count.

```json
{
  "query": "{ allStudios { id checksum url name image_path scene_count } }" 
}
```

--------------------------------

### Split attribute example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Splits a comma-separated list of tags located in the span and returns the tags. The split attribute is a fixed post-processing field applied after postProcess operations.

```yaml
Tags:
  Name:
    selector: //span[@class="list_attributes"]
    split: ","
```

--------------------------------

### Responsive layout for settings and configuration tabs

Source: https://github.com/stashapp/stash/wiki/Theme-Light-Pulsar

Contains media queries for different screen sizes to adjust the layout of settings menus, configuration tabs, and related elements.

```css
@media (min-width: 768px) {
.offset-md-3 {margin-left: 1%;}
#settings-menu-container {margin-left:1% !important; z-index:9; width:200px; padding-top:25px;}

	#configuration-tabs-tabpane-interface .setting-section:first-child .card  .setting div:nth-child(2) { width:64%;min-width:300px;padding-top:6px}
	#configuration-tabs-tabpane-interface .setting-section:first-child .card .setting div .sub-heading {margin-top:-28px; margin-left:255px;width:700px}
	#language .input-control { width:250px}
	
	#configuration-tabs-tabpane-interface .setting-section .setting-group>.setting:not(:first-child) {margin-left:275px}
	#configuration-tabs-tabpane-interface .setting-section .setting-group>.setting:nth-child(2) {margin-top: -40px}
}

@media (min-width: 1200px) {
	.offset-md-3 {margin-left: 14%;margin-right:2%}
	.setting-section h1, #tasks-panel h1 { max-width:220px;}
	#settings-menu-container {
		padding-top:25px;
		margin-left:14% !important;
		z-index:9;
		width:205px;
	}
}

@media (max-width: 768px) {
	.offset-md-3 {margin-left: 1%;}
	#settings-menu-container {margin-left:1%; z-index:9;width:180px;	padding-top:25px;}
	#settings-container {    padding-left: 180px;}
	.setting-section h1, #tasks-panel h1 { max-width:300px;}
}

@media (max-width: 576px) {
	.offset-sm-3 {margin-left: 1%;}
	#settings-menu-container {margin-left:1%;z-index:9;width:160px;	padding-top:25px;}
	#settings-container {padding-left: 10px;}
}

@media (max-width: 1004px) {
	.setting-section h1, #tasks-panel h1 { max-width:400px;}
	.job-table.card {margin-top:2px !important;}
}
```

--------------------------------

### Custom locale JSON to override actions.add_directory

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Interface.md

Example of a custom locale JSON file that overrides the 'actions.add_directory' label. The format must match the en-GB.json locale file.

```json
{
  "actions": {
    "add_directory": "Some other description"
  }
}
```

--------------------------------

### Inspect video file with ffprobe -show_format -show_streams

Source: https://github.com/stashapp/stash/wiki/Troubleshooting-video-playback-issues

Use ffprobe to list format and stream details of a video file, which can be helpful when filing bug reports or discussing issues in chat.

```bash
ffprobe -show_format -show_streams big_buck_bunny.mkv

```

--------------------------------

### Add event listener for stash:location event

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/UIPluginApi.md

Use PluginApi.Event.addEventListener to listen for Stash events. The example logs the pathname of the new location when the 'stash:location' event fires.

```javascript
PluginApi.Event.addEventListener("stash:location", (e) => console.log("Page Changed", e.detail.data.location.pathname))
```

--------------------------------

### parseDate unix postProcess example

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Parses a Unix timestamp (e.g., 1660169451) into stash's date format (YYYY-MM-DD). The 'unix' date format is selected to handle Unix timestamps.

```yaml
Date:
  selector: //div[@class="value epoch"]/text()
  postProcess:
    - parseDate: unix
```

--------------------------------

### POST /graphql - allStudios

Source: https://github.com/stashapp/stash/wiki/API

Retrieves a list of studios with fields such as id, checksum, url, name, image_path, and scene_count.

```APIDOC
## POST /graphql

### Description
Retrieves a list of studios with fields such as id, checksum, url, name, image_path, and scene_count.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Request Body
- **query** (string) - Required - GraphQL query string: `{ allStudios { id checksum url name image_path scene_count } }`

### Request Example
{
  "query": "{ allStudios { id checksum url name image_path scene_count } }"
}

### Response
#### Success Response (200)
- **data** (object) - Contains the list of studios.

#### Response Example
{
  "data": {
    "allStudios": [
      {
        "id": "1",
        "checksum": "abc",
        "url": "https://example.com",
        "name": "Studio Name",
        "image_path": "/path/to/image",
        "scene_count": 10
      }
    ]
  }
}
```

--------------------------------

### Fetch Weblate repository

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/locales/README.md

Fetches the develop branch from the Weblate remote.

```bash
git fetch weblate_codeberg develop
```

--------------------------------

### Extract 30-second video sample with ffmpeg -ss -t

Source: https://github.com/stashapp/stash/wiki/Troubleshooting-video-playback-issues

Extracts a 30-second sample starting at the 120-second marker using stream copy, typically requested by developers to analyze a playback issue.

```bash
ffmpeg -ss 120 -i big_buck_bunny.mkv  -t 30 -c:v copy -c:a copy 30_second_sample.mkv

```

--------------------------------

### Plugin configuration file format (YAML)

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Plugins.md

Basic structure of a plugin configuration file. Includes fields for name, description, version, url, UI configuration (css, javascript, requires, assets, csp), settings, and task-related fields (exec, interface, errLog, tasks). The 'requires' field under 'ui' loads plugin dependencies. The 'assets' field maps URL prefixes to filesystem paths. The 'csp' field overrides content security policies.

```yaml
name: <plugin name> 
# optional list of dependencies to be included
# "#" is is part of the config - do not remove
# requires: <plugin ID>
description: <optional description of the plugin>
version: <optional version tag>
url: <optional url>

ui:
  # optional list of css files to include in the UI
  css:
    - <path to css file>

  # optional list of js files to include in the UI
  javascript:
    - <path to javascript file>

  # optional list of plugin IDs to load prior to this plugin
  requires:
    - <plugin ID>

  # optional list of assets 
  assets:
    urlPrefix: fsLocation
    ...

  # content-security policy overrides
  csp:
    script-src:
      - http://alloweddomain.com
    
    style-src:
      - http://alloweddomain.com
    
    connect-src:
      - http://alloweddomain.com

# map of setting names to be displayed in the plugins page in the UI
settings:
  # internal name
  foo:
  # name to display in the UI
  displayName: Foo
  # type of the attribute to show in the UI
  # can be BOOLEAN, NUMBER, or STRING
  type: BOOLEAN

# the following are used for plugin tasks only
exec:
  - ...
interface: [interface type]
errLog: [one of none trace, debug, info, warning, error]
tasks:
  - ...

```

--------------------------------

### Get list of performer names from Freeones - GraphQL query payload

Source: https://github.com/stashapp/stash/wiki/API

Payload for the scrapeFreeonesPerformerList query. $q is the name or alias (or partial) to search for. Use caution with wait periods to avoid blacklisting.

```json
{
  "query": "{ scrapeFreeonesPerformerList(query: $q) }" 
}
```

--------------------------------

### PluginApi.hooks.useLoadComponents

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/UIPluginApi.md

Hook to load components asynchronously.

```APIDOC
## `PluginApi.hooks.useLoadComponents`

### Description
Loads components using the `PluginApi.utils.loadComponents` method.

### Parameters
- `components` (Promise[]) - Required - The list of components to load. These values should come from the `PluginApi.loadableComponents` namespace.

### Returns
- `boolean` - `true` if the components are loading.
```

--------------------------------

### CSS for Wall Preview Input Width

Source: https://github.com/stashapp/stash/wiki/Theme-Light-Pulsar

Sets the width of the input control in the wall preview to 160px.

```css
#wall-preview .input-control {width:160px}
```

--------------------------------

### CDP clicks demo scraper

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Demo scraper using CDP clicks to toggle elements on a Bootstrap page. Each click adds an extra delay of 'clicks sleep' seconds; the example adds 11 seconds total to page load time.

```yaml
name: clickDemo # demo only for a single URL
sceneByURL:
  - action: scrapeXPath
    url:
      - https://getbootstrap.com/docs/4.3/components/collapse/
    scraper: sceneScraper

xPathScrapers:
  sceneScraper:
    scene:
      Title: //head/title
      Details: # shows the id/s of the visible div/s for the Multiple targets example of the page
        selector: //div[@class="bd-example"]//div[@class="multi-collapse collapse show"]/@id
        concat: "\n\n"

driver:
  useCDP: true
  sleep: 1
  clicks: # demo usage toggle on off multiple times
    - xpath: //a[@href="#multiCollapseExample1"] # toggle on first element
    - xpath: //button[@data-target="#multiCollapseExample2"] # toggle on second element
      sleep: 4
    - xpath: //a[@href="#multiCollapseExample1"] # toggle off fist element
      sleep: 1
    - xpath: //button[@data-target="#multiCollapseExample2"] # toggle off second element
    - xpath: //button[@data-target="#multiCollapseExample2"] # toggle on second element
```

--------------------------------

### Run stash-linux

Source: https://github.com/stashapp/stash/wiki/Installing-on-FreeNAS-TrueNAS

Run stash-linux from the current directory after ensuring it is executable.

```bash
./stash-linux
```

--------------------------------

### Build the Docker container with make docker-build

Source: https://github.com/stashapp/stash/blob/develop/docker/build/x86_64/README.md

Run from the top-level directory containing tools.go to build the stash Docker image from the current source code. Note that this image does not include python, so python-based scrapers will not work.

```bash
make docker-build

```

--------------------------------

### Launch Chrome with remote debugging port

Source: https://github.com/stashapp/stash/wiki/FAQ

Command to launch a special Chrome instance for Visible CDP scraping. Run in Chrome's binary directory.

```bash
chrome.exe --remote-debugging-port=9222
```

--------------------------------

### Enable TLS emulation with useSurf driver

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Adds the `useSurf: true` flag to the `driver` section of the YAML configuration to enable TLS emulation. This automatically removes the `User-Agent` header to avoid fingerprint mismatch. Note that proxies not supporting SOCKS5 may fail in rare cases.

```yaml
driver:
  useSurf: true
```

--------------------------------

### Configure cookies for direct scraper with CookieURL

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Defines cookies for the direct/native xpath scraper. Each cookie group requires a `CookieURL` matching the request domain; otherwise the group fails. Cookies include `Name`, `Value`, `Domain`, and `Path`. The example sets `_warning`, `_test2`, and `_warn` cookies for two different URLs.

```yaml
driver:
  cookies:
    - CookieURL: "https://www.example.com"
      Cookies:
        - Name: "_warning"
          Domain: ".example.com"
          Value: "true"
          Path: "/"
        - Name: "_test2"
          Value: "123412"
          Domain: ".example.com"
          Path: "/"
    - CookieURL: "https://api.somewhere.com"
      Cookies:
        - Name: "_warn"
          Value: "123"
          Domain: ".somewhere.com"
```

--------------------------------

### SSH to NAS

Source: https://github.com/stashapp/stash/wiki/Installing-on-Synology-NAS

Connect to the NAS via SSH using an administrator account.

```bash
ssh admin@nas-hostname
```

--------------------------------

### exec configuration using python script

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ExternalPlugins.md

Shows the exec field using a python script located in the same directory as the plugin config file. The {pluginDir} placeholder is used to reference the plugin directory.

```yaml
exec:
  - python
  - {pluginDir}/foo.py
```

--------------------------------

### Wall View Preview Improvements

Source: https://github.com/stashapp/stash/wiki/Theme-Pulsar

Improves the display of preview videos in the Wall View by setting container widths, hiding overflow, and adjusting text styling.

```css
/* --- Improves how the Preview Videos in the Wall View are displayed --- */
.wall-item-container {width: 100%; background-color: rgba(0, 0, 0, .10); overflow:hidden }
.wall-item-media { height:100%; background-color: rgba(0, 0, 0, .0);overflow:hidden }
.wall-item-anchor { width: 102%; overflow:hidden }
.wall-item-text {margin-bottom:0px; color: #111; text-shadow: 1px 1px 1px #fff }
```

--------------------------------

### Open the Stash SQLite database with sqlite3

Source: https://github.com/stashapp/stash/wiki/Manually-Editing-the-Stash-Sqlite3-database

Use these commands to navigate to the Stash data directory and open the database file with the sqlite3 client. Run them from a terminal before executing any SQL commands.

```bash
cd ~/.stash
sqlite3 stash-go.sqlite
```

--------------------------------

### Responsive Settings Layout Adjustments

Source: https://github.com/stashapp/stash/wiki/Theme-Pulsar

Additional responsive CSS for settings containers, headings, and menu positioning at various breakpoints.

```css
@media (min-width: 1000px) {
	#settings-container #configuration-tabs-tabpane-interface .setting-section > .setting { padding: 15px 0px;}
	#settings-container #configuration-tabs-tabpane-interface .setting-section .setting-group .setting>div:first-item{margin-left: 4% !important;}	
	
	#settings-container #stash-table {margin-top:25px}
	#configuration-tabs-tabpane-interface .setting-section:first-child .card {	margin-top: -5px;	margin-left: -1%}		

	#language .input-control { width:250px}

	#configuration-tabs-tabpane-interface .setting-section:first-child .card > .setting div:nth-child(1) { width:255px}


	#configuration-tabs-tabpane-interface .setting-section:first-child .card  .setting div:nth-child(2) { width:68%;padding-top:6px}
	#configuration-tabs-tabpane-interface .setting-section:first-child .card .setting div .sub-heading {margin-top:-28px; margin-left:255px;width:700px}

	#configuration-tabs-tabpane-interface #language {margin-bottom:15px}
	#configuration-tabs-tabpane-library #stashes .sub-heading {margin-top:-26px; margin-left:235px;width:700px}
	
}
```

--------------------------------

### Studio object fields list

Source: https://github.com/stashapp/stash/wiki/Scraping-configuration

List of valid studio fields for a scraper mapping.

```text
Name
URL
```

--------------------------------

### Using {inputURL} placeholder in scene fields

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/ScraperDevelopment.md

Uses the {inputURL} placeholder to set the scene URL as a fixed value and to select the title from the page.

```yaml
scene:
  URL:
    fixed: "{inputURL}"
  Title:
    selector: //h1[@class="title"]
```

--------------------------------

### Create and checkout branch for Weblate translations

Source: https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/locales/README.md

Creates and checks out a new branch named 'codeberg_weblate' to hold the Weblate translations.

```bash
git checkout -b codeberg_weblate
```
Tokens:
Raw