Stash is a locally hosted web-based app written in Go which organizes and serves your porn.
- It can gather 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.
- It supports a wide variety of both video and image formats.
- You can tag videos and find them later.
- It provides statistics about performers, tags, studios and other things.
You can watch a SFW demo video to see it in action.
For further information you can read the in-app manual.
The Stash server runs on macOS, Windows, and Linux. Download the latest release here.
Run the executable (double click the exe on windows or run
./stash-linux from the terminal on macOS / Linux) and navigate to either https://localhost:9999 or http://localhost:9999 to get started.
Note for Windows users: 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.
If stash is unable to find or download FFMPEG then download it yourself from the link for your platform:
ffprobe(.exe) files should be placed in
~/.stash on macOS / Linux or
C:\Users\YourUsername\.stash on Windows.
- Download and install Stash and its dependencies
- Run Stash. It will prompt you for some configuration options and a directory to index (you can also do this step afterward)
- After configuration, launch your web browser and navigate to the URL shown within the Stash app.
Note that Stash does not currently retrieve and organize information about your entire library automatically. You will need to help it along through the use of scrapers. The Stash community has developed scrapers for many popular data sources which can be downloaded and installed from this repository.
The simplest way to tag a large number of files is by using the Tagger which uses filename keywords to help identify the file and pull in scene and performer information from our stash-box database. Note that this data source is not comprehensive and you may need to use the scrapers to identify some of your media.
Stash runs as a command-line app and local web server. There are some command-line options available, which you can see by running
For example, to run stash locally on port 80 run it like this (OSX / Linux)
stash --host 127.0.0.1 --port 80
Stash can run over HTTPS with some additional work. First you must generate a SSL certificate and key combo. Here is an example using openssl:
openssl req -x509 -newkey rsa:4096 -sha256 -days 7300 -nodes -keyout stash.key -out stash.crt -extensions san -config <(echo "[req]"; echo distinguished_name=req; echo "[san]"; echo subjectAltName=DNS:stash.server,IP:127.0.0.1) -subj /CN=stash.server
This command would need customizing for your environment. This link might be useful.
Once you have a certificate and key file name them
stash.key and place them in the same directory as the
config.yml file, or the
~/.stash directory. Stash detects these and starts up using HTTPS rather than HTTP.
Themes and CSS Customization
There is a directory of community-created themes on our Wiki, along with instructions on how to install them.
Answers to other Frequently Asked Questions can be found on our Wiki
For issues not addressed there, there are a few options.
- Read the Wiki
- Check the in-app documentation (also available here
- Join the Discord server, where the community can offer support.
Compiling From Source Code
- Revive - Configurable linter
- Go Install:
go get github.com/mgechev/revive
- Go Install:
- Packr2 - Static asset bundler
- Go Install:
go get github.com/gobuffalo/packr/v2/packr2
- Binary Download
- Go Install:
- Yarn - Yarn package manager
yarn install --frozen-lockfilein the
stash/ui/v2.5folder (before running make generate for first time).
NOTE: You may need to run the
go get commands outside the project directory to avoid modifying the projects module file.
- Download and install Go for Windows
- Download and install MingW
- Search for "advanced system settings" and open the system properties dialog.
- Click the
- Under system variables find the
Path. Edit and add
C:\Program Files\mingw-w64\*\mingw64\bin(replace * with the correct path).
- Click the
make command in Windows will be
mingw32-make with MingW.
make generate- Generate Go and UI GraphQL files
make build- Builds the binary (make sure to build the UI as well... see below)
make docker-build- Locally builds and tags a complete 'stash/build' docker image
make pre-ui- Installs the UI dependencies. Only needs to be run once before building the UI for the first time, or if the dependencies are updated
make fmt-ui- Formats the UI source code.
make ui- Builds the frontend and the packr2 files
make packr- Generate packr2 files (sub-target of
ui. Use to regenerate packr2 files without rebuilding UI)
make vet- Run
make lint- Run the linter
make fmt- Run
make fmt-check- Ensure changed files are formatted correctly
make it- Run the unit and integration tests
make validate- Run all of the tests and checks required to submit a PR
make ui-start- Runs the UI in development mode. Requires a running stash server to connect to. Stash port can be changed from the default of
9999with environment variable
Building a release
make generateto create generated files
make uito compile the frontend
make buildto build the executable for your current platform
This project uses a modification of the CI-GoReleaser docker container to create an environment where the app can be cross-compiled. This process is kicked off by CI via the
scripts/cross-compile.sh script. Run the following command to open a bash shell to the container to poke around:
docker run --rm --mount type=bind,source="$(pwd)",target=/stash -w /stash -i -t stashappdev/compiler:latest /bin/bash
Stash can be profiled using the
--cpuprofile command line flag.
The resulting file can then be used with pprof as follows:
go tool pprof
graphviz installed and in the path, a call graph can be generated with:
go tool pprof -svg