README
¶
Stash
Stash is a self-hosted webapp written in Go which organizes and serves your porn.
- 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 you can read the in-app manual.
Installing Stash
Windows
MacOS
Linux
DockerFirst Run
Windows Users: Security Prompt
Running the app might present a security prompt since the binary isn't yet signed. Bypass this by clicking "more info" and then the "run anyway" button.
FFMPEG
Stash requires ffmpeg. If you don't have it installed, Stash will download a copy for you. 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.
Many community-maintained scrapers are available for download from CommunityScrapers repository. The community also maintains StashDB, a crowd-sourced repository of scene, studio, and performer information, that can automatically identify much of a typical media collection. Inquire in the Discord for details. Identifying an entire collection will typically require a mix of multiple sources.
StashDB is the canonical instance of our open source metadata API, stash-box.
Translation
🇧🇷 🇨🇳 🇩🇰 🇳🇱 🇬🇧 🇪🇪 🇫🇮 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇵🇱 🇷🇺 🇪🇸 🇸🇪 🇹🇼 🇹🇷
Stash is available in 25 languages (so far!) and it could be in your language too. If you want to help us translate Stash into your language, you can make an account at translate.stashapp.cc to get started contributing new languages or improving existing ones. Thanks!
Support (FAQ)
Check out our documentation on Stash-Docs for information about the software, questions, guides, add-ons and more.
For more help you can:
- Check the in-app documentation, in the top right corner of the app (it's also mirrored on Stash-Docs)
- Join the Matrix space
- Join the Discord server, where the community can offer support.
- Start a discussion on GitHub
Customization
Themes and CSS Customization
There is a directory of community-created themes on Stash-Docs, along with instructions on how to install them.
You can also change the Stash interface to fit your desired style with various snippets from Custom CSS snippets.
For Developers
Pull requests are welcome!
See Development and Contributing for information on working with the codebase, getting a local development setup, and contributing changes.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
autotag
Package autotag provides methods to auto-tag scenes with performers, studios and tags.
|
Package autotag provides methods to auto-tag scenes with performers, studios and tags. |
|
pkg
|
|
|
exec
Package exec provides functions that wrap os/exec functions.
|
Package exec provides functions that wrap os/exec functions. |
|
ffmpeg
Package ffmpeg provides a wrapper around the ffmpeg and ffprobe executables.
|
Package ffmpeg provides a wrapper around the ffmpeg and ffprobe executables. |
|
hash
Package hash provides utility functions for generating hashes from strings and random keys.
|
Package hash provides utility functions for generating hashes from strings and random keys. |
|
hash/md5
Package md5 provides utility functions for generating MD5 hashes.
|
Package md5 provides utility functions for generating MD5 hashes. |
|
hash/oshash
Package oshash implements the algorithm that OpenSubtitles.org uses to generate unique hashes.
|
Package oshash implements the algorithm that OpenSubtitles.org uses to generate unique hashes. |
|
logger
Package logger provides methods and interfaces used by other stash packages for logging purposes.
|
Package logger provides methods and interfaces used by other stash packages for logging purposes. |
|
plugin
Package plugin implements functions and types for maintaining and running stash plugins.
|
Package plugin implements functions and types for maintaining and running stash plugins. |
|
plugin/common
Package common encapulates data structures and functions that will be used by plugin executables and the plugin subsystem in the stash server.
|
Package common encapulates data structures and functions that will be used by plugin executables and the plugin subsystem in the stash server. |
|
plugin/common/log
Package log provides a number of logging utility functions for encoding and decoding log messages between a stash server and a plugin instance.
|
Package log provides a number of logging utility functions for encoding and decoding log messages between a stash server and a plugin instance. |
|
plugin/util
Package util implements utility and convenience methods for plugins.
|
Package util implements utility and convenience methods for plugins. |