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 是一个用 Go 编写的自托管网页应用,用来整理和播放你个人的视频和图片收藏(包括适宜工作场合的 SFW 内容和不适宜工作场合的 NSFW 内容),并从在线抓取源获取演员、标签和制作公司等元数据。
这是桌面程序,还是需要作为服务器运行、再用浏览器打开的?它是一个你自行启动的本地服务器(可以是原生可执行文件,也可以用 Docker 运行),你通过网页浏览器界面操作,而不是一个原生桌面窗口。
怎样才能让 Stash 运行起来?从 Releases 页面下载适用于 Windows、macOS 或 Linux 的预编译版本,或使用提供的 docker-compose.yml 部署;运行后打开网页界面,并指定你的媒体文件夹让它扫描。
我需要自己安装 FFmpeg 吗?Stash 需要 FFmpeg。如果没有安装,Stash 会在设置过程中提示你下载一份副本;Linux 用户则建议通过所用发行版的包管理器来安装。
安装前需要了解系统版本要求吗?需要。从 v0.27.0 起,Stash 不再支持 Windows 7/8、Server 2008/2012,需要 Windows 10 或 Server 2016 及以上版本;从 v0.32.0 起,它需要 macOS 12 Monterey 或更高版本。
Stash 怎样为我的文件找到演员、标签和制作公司?它使用抓取源从网站和数据库中获取元数据,主要以 StashDB 作为标准数据来源。StashDB 是一个基于开源 stash-box 软件运行的众包社区数据库,另外还有若干由社区维护的 stash-box 实例,用于小众内容。
我能添加更多抓取源,或者扩展 Stash 的内置功能吗?可以。社区维护的抓取源、插件和主题可以直接在 Stash 的设置菜单中下载和安装,也可以在 CommunityScrapers 仓库中找到。
Stash 实际能整理哪些文件类型?Stash 支持多种视频和图片格式,你可以为内容添加标签,并按演员、标签和制作公司查看统计数据。
遇到问题时,应用内有帮助吗?有。在应用内按下 Shift+? 即可打开应用内手册,此外还有官方文档网站、常见问题解答(FAQ)和社区维基。
Creator
stashapp
Size
65.4 MB
Stars
13.1K
Age
8y
Commits · 90 Days