An organizer for your porn, written in Go
Go to file
Flashy78 e5af37efbc
Tagger match performer by alias (#4182)
2023-10-16 14:39:41 +11:00
.github Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
.idea Cut over to v2.5 UI (#433) 2020-04-03 08:46:23 +11:00
cmd Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
docker Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
docs Studio Tagger (#3510) 2023-07-31 09:50:24 +10:00
graphql Gallery URLs (#4114) 2023-09-25 12:27:20 +10:00
internal Model refactor, part 3 (#4152) 2023-10-16 14:26:34 +11:00
pkg Tagger match performer by alias (#4182) 2023-10-16 14:39:41 +11:00
scripts Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
ui Fix type issues (#4176) 2023-10-16 14:34:54 +11:00
.dockerignore Replace packr with go embed (#1751) 2021-09-22 13:08:34 +10:00
.gitattributes Refactor build (#493) 2020-04-29 12:13:08 +10:00
.gitignore Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
.golangci.yml Remove vendored dependencies (#4110) 2023-09-12 10:36:48 +10:00
.gqlgenc.yml Fix submission of scene drafts without performers (#2515) 2022-04-18 10:43:27 +10:00
.mockery.yml Model refactor (#3915) 2023-09-01 10:39:29 +10:00
LICENSE Add LICENSE until we get all signers on the switch (#297) 2020-01-20 22:18:12 -05:00
Makefile Fix armv7 illegal instruction 2023-09-27 09:26:58 +10:00
README.md Readme: Update Translation information (#4061) 2023-08-26 17:01:49 -04:00
go.mod Bump golang.org/x/net from 0.7.0 to 0.17.0 (#4192) 2023-10-16 14:28:33 +11:00
go.sum Bump golang.org/x/net from 0.7.0 to 0.17.0 (#4192) 2023-10-16 14:28:33 +11:00
gqlgen.yml Model refactor (#3915) 2023-09-01 10:39:29 +10:00
tools.go Update go dependencies (#3480) 2023-02-28 08:26:14 +11:00

README.md

Stash

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

Stash is a self-hosted webapp written in Go which organizes and serves your porn.

demo image

  • 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 consult the documentation or read the in-app manual.

Installing Stash

Windows MacOS Linux Docker
Latest Release
Development Preview
Latest Release (Apple Silicon)
Development Preview (Apple Silicon)
Latest Release (Intel)
Development Preview (Intel)
Latest Release (amd64)
Development Preview (amd64)
More Architectures...
Instructions
Sample docker-compose.yml

First 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

Translate 🇧🇷 🇨🇳 🇩🇰 🇳🇱 🇬🇧 🇪🇪 🇫🇮 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇵🇱 🇷🇺 🇪🇸 🇸🇪 🇹🇼 🇹🇷

Stash is available in 25 languages (so far!) and it could be in your language too. We use Weblate to coordinate community translations. If you want to help us translate Stash into your language, you can make an account at Stash's Weblate 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:

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.