README

Stash











Stash is a self-hosted webapp written in Go which organizes and serves your diverse content collection, catering to both your SFW and NSFW needs.

!Screenshot of Stash web application interface

- 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 watch a SFW demo video to see it in action.

For further information see Support & Resources section.

 Installing Stash

 [!tip]
Step-by-step instructions are available at docs.stashapp.cc/installation.

 [!important]
 Windows Users

 As of version 0.27.0, Stash no longer supports _Windows 7, 8, Server 2008 and Server 2012._  
 At least Windows 10 or Server 2016 is required.

 macOS Users

 As of version 0.29.0, Stash requires _macOS 11 Big Sur_ or later.  
 As of version 0.32.0, Stash requires _macOS 12 Monterey_ or later.  
 Older versions can still be run through Docker.

 Windows |  macOS |  Linux |  Docker
:---:|:---:|:---:|:---:
Latest Release  Development Preview | Latest Release  Development Preview | Latest Release (amd64)  Development Preview (amd64)  More Architectures... | Instructions  Sample docker-compose.yml

Download links for other platforms and architectures are available on the Releases page.

 First Run

 Windows/macOS Users: Security Prompt

On Windows or macOS, running the app might present a security prompt since the application binary isn't yet signed. 

- On Windows, bypass this by clicking "more info" and then the "run anyway" button.
- On macOS, Control+Click the app, click "Open", and then "Open" again.

 ffmpeg

Stash requires FFmpeg. If you don't have it installed, Stash will prompt you to download a copy during setup. It is recommended that Linux users install ffmpeg from their distro's package manager.

 Usage

 Quickstart Guide

Stash is a web-based application. Once the application is running, the interface is available (by default) from http://localhost:9999.

On first run, Stash will prompt you for some configuration options and media directories to index, called "Scanning" in Stash. After scanning, your media will be available for browsing, curating, editing, and tagging.

Stash can pull metadata (performers, tags, descriptions, studios, and more) directly from many sites through the use of scrapers, which integrate directly into Stash. Identifying an entire collection will typically require a mix of multiple sources:
- The stashapp team maintains StashDB, a crowd-sourced repository of scene, studio, and performer information. Connecting it to Stash will allow you to automatically identify much of a typical media collection. It runs on our stash-box software and is primarily focused on mainstream digital scenes and studios. Instru