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
Что это такое?Stash — это веб-приложение на Go, которое вы разворачиваете у себя. Оно упорядочивает вашу личную коллекцию видео и изображений (SFW или NSFW) и показывает её, подтягивая метаданные — исполнителей, теги и студии — из онлайн-скраперов.
Это настольная программа или сервер, который я запускаю и открываю в браузере?Это локальный сервер, который вы запускаете (как готовый бинарный файл или через Docker). Работаете вы с ним через веб-браузер, а не через отдельное окно настольной программы.
Как запустить Stash?Скачайте готовый бинарный файл для Windows, macOS или Linux со страницы Releases или разверните программу с помощью готового docker-compose.yml. После запуска откройте веб-интерфейс и укажите папки с медиафайлами, чтобы программа их просканировала.
Нужно ли мне самому устанавливать FFmpeg?Stash требует FFmpeg. Если его нет, Stash при настройке предложит скачать копию. Пользователям Linux рекомендуется установить FFmpeg через менеджер пакетов своего дистрибутива.
Нужно ли знать о требованиях к версии ОС перед установкой?Да: начиная с v0.27.0 Stash перестал поддерживать Windows 7/8/Server 2008/2012 (требуются Windows 10 или Server 2016+), а начиная с v0.32.0 требуется macOS 12 Monterey или новее.
Как Stash определяет исполнителей, теги и студии для моих файлов?Он использует скраперы, которые получают метаданные с сайтов и баз данных. Основным эталонным источником служит StashDB — база, которую пополняет сообщество и которая работает на открытом ПО stash-box. Для нишевого контента также используются несколько других баз на stash-box, которыми управляет сообщество.
Могу ли я добавить больше скраперов или расширить Stash сверх встроенных возможностей?Да: скраперы, плагины и темы, которые поддерживает сообщество, можно скачать и установить прямо из меню «Settings» в Stash или найти в репозитории CommunityScrapers.
Какие типы файлов Stash на самом деле умеет упорядочивать?Stash поддерживает широкий набор видео- и графических форматов. Он позволяет добавлять теги к контенту и просматривать статистику по исполнителям, тегам и студиям.
Есть ли встроенная справка, если я застряну?Да: нажатие Shift+? внутри приложения открывает встроенное руководство. Также есть официальный сайт с документацией, FAQ и вики сообщества.
What are similar projects?livego, amane, mediamtx, go2rtc, livekit, ConvertX, ffmpeg-libav-tutorial, 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