stash README

The project's README from github.com/stashapp/stash. As one markdown file: README.md.

Stash

Build Docker pulls GitHub Sponsors Open Collective backers Go Report Card Discord GitHub release (latest by date) Codeberg Translate GitHub issues by-label

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

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.

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:

StashDB is the canonical instance of our open source metadata API, stash-box.

Support & Resources

Need help or want to get involved? Start with the documentation, then reach out to the community if you need further assistance.

Documentation

Community & Discussion

Community Scrapers & Plugins

Architecture

You can find an overview of Stash's architecture in the ARCHITECTURE.md document.

Contributing

We welcome contributions and help from all humans who want to improve the project.

Before contributing, please read the Contributing document to understand our guidelines and processes for contributing to the project.

You can learn about setting up a local development environment in the Development document.

Translation

The widget below shows the current translation status of Stash across all supported languages. If you want to help us translate Stash, you can make an account at Codeberg Translate to contribute to new or existing languages. Thanks!

Translation status

stash (stashapp/stash)

Searching Database…

13.1K ·GitHub
Stash
What is this?Stash is a self-hosted webapp written in Go that organizes and serves your personal video/image collection (SFW or NSFW), pulling in metadata like performers, tags, and studios from online scrapers.
Is this a desktop program or something I run as a server and open in a browser?It runs as a local server you launch (native binary or Docker), and you interact with it through a web browser interface rather than a native desktop window.
How do I get Stash running?Download the prebuilt binary for Windows, macOS, or Linux from the Releases page, or deploy it with the provided docker-compose.yml; once running, open the web UI and point it at your media folders to scan them.
Do I need to install FFmpeg myself?Stash requires FFmpeg, but if it is missing Stash will prompt you to download a copy during setup; Linux users are advised to install it via their distro's package manager instead.
Are there OS version requirements I should know about before installing?Yes: since v0.27.0 Stash dropped support for Windows 7/8/Server 2008/2012 (Windows 10 or Server 2016+ required), and since v0.32.0 it requires macOS 12 Monterey or later.
How does Stash figure out performers, tags, and studios for my files?It uses scrapers that pull metadata from sites and databases, with StashDB (a crowd-sourced community database run on the open-source stash-box software) as the main canonical source, plus several other community-run stash-box instances for niche content.
Can I add more scrapers or extend Stash beyond what's built in?Yes, community-maintained scrapers, plugins, and themes can be downloaded and installed directly from within Stash's Settings menu, or found in the CommunityScrapers repository.
What file types does Stash actually organize?Stash supports a wide variety of both video and image formats, letting you tag content and browse statistics across performers, tags, and studios.
Is there an in-app help if I get stuck?Yes, pressing Shift+? inside the app opens an in-app manual, and there's also an official documentation site, FAQ, and community wiki.
What are similar projects?livego, amane, mediamtx, go2rtc, livekit, ffmpeg-libav-tutorial, ConvertX, moviepy
Which topics is it in?media-server, metadata, media, graphql, video-processing, ffmpeg, image-processing, json, golang, video, hacktoberfest, plugin
Creator
stashapp
Size
65.4 MB
Stars
13.1K
Updated
CommitOct 07Releasev0.31.1Apr 13
Age
8y
Commits · 90 Days