Rooba
/
stash
mirror of https://github.com/stashapp/stash.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
stash/README.md

2.9 KiB
Raw Blame History

Stash

Build Status Go Report Card

Stash is a Go app which organizes and serves your porn.

See a demo here (password is stashapp).

Install

Stash supports macOS, Windows, and Linux. Download the latest release here.

Simply run the executable (double click the exe on windows or run ./stash-osx / ./stash-linux from the terminal on macOS / Linux) and navigate to either https://localhost:9999 or http://localhost:9998 to get started.

Note for Windows users: Running the app might present a security prompt since the binary isn't signed yet. Just click more info and then the run anyway button.

FFMPEG

If stash is unable to find or download FFMPEG then download it yourself from the link for your platform:

The ffmpeg(.exe) and ffprobe(.exe) files should be placed in ~/.stash on macOS / Linux or C:\Users\YourUsername\.stash on Windows.

FAQ

Does stash support multiple folders?

Not yet, but this will come in the future.

Development

Install

  • Revive - Configurable linter go get github.com/mgechev/revive

Environment

macOS

TODO

Windows

  1. Download and install Go for Windows
  2. Download and install MingW
  3. Search for "advanced system settings" and open the system properties dialog.
    1. Click the Environment Variables button
    2. Add GO111MODULE=on
    3. Under system variables find the Path. Edit and add C:\Program Files\mingw-w64\*\mingw64\bin (replace * with the correct path).

Commands

  • make build - Builds the binary
  • make gqlgen - Regenerate Go GraphQL files
  • make vet - Run go vet
  • make lint - Run the linter

Building a release

  1. cd into the UI directory and run ng build --prod to compile the frontend
  2. cd back to the root directory and run make build to build the executable for your current platform

Cross compiling

This project makes use of this 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