Rooba
/
stash
mirror of https://github.com/stashapp/stash.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An organizer for your porn, written in Go
80 Commits 16 Branches 49 Tags 98 MiB
Go 58.9%
TypeScript 38.2%
SCSS 2.3%
Makefile 0.2%
Dockerfile 0.1%
Other 0.1%
Go to file
Leopere 83ee83c2fa Dockerfile for production. (#44) 
* Stealing good ideas from DockSTARTer

* Pushing an example WIP

* Actually ran and debugged container and it works now.
TODO: We need configurability for this to be more useful.

* Prepped docker-compose for if we get these envvars coded in.

* Removed unnecessary start.sh

* Removed env.example

* Fixed internal directory to conform more.

Resovles https://github.com/stashapp/stash/pull/44#issuecomment-485060195

* Logging options need quotes.

* I decided to use architecture tags since go-releaser can do multiple architectures.

* Compose version version: '3.4'

* No relative pathing on container side of volume
 		2019-04-24 10:10:26 -07:00
.idea Fix json time when unmarshalling 2019-03-09 10:14:55 -08:00
certs Initial commit 2019-02-09 04:32:50 -08:00
docker Dockerfile for production. (#44) 2019-04-24 10:10:26 -07:00
graphql Update GQLGen and break up the schema.graphql file 2019-03-27 12:47:43 -07:00
packrd Added marker / scene audio interface option 2019-04-20 14:48:54 -07:00
pkg Added marker / scene audio interface option 2019-04-20 14:48:54 -07:00
scripts CI Improvements 2019-03-05 13:14:00 -08:00
ui Added marker / scene audio interface option 2019-04-20 14:48:54 -07:00
vendor Update GQLGen and break up the schema.graphql file 2019-03-27 12:47:43 -07:00
.gitignore Initial commit 2019-02-09 04:32:50 -08:00
.goreleaser.yml Added Travis CI 2019-02-10 08:54:32 -08:00
.travis.yml Fixes 2019-03-26 09:45:08 -07:00
LICENSE Initial commit 2019-02-09 04:32:50 -08:00
Makefile Ran formatter and fixed some lint issues 2019-02-14 14:53:32 -08:00
README.md Scenes with a marker missing a primary tag fails to load 2019-04-20 10:32:01 -07:00
go.mod Configuration 2019-04-11 10:55:58 -07:00
go.sum Update GQLGen and break up the schema.graphql file 2019-03-27 12:47:43 -07:00
gqlgen.yml Update GQLGen and break up the schema.graphql file 2019-03-27 12:47:43 -07:00
main-packr.go Initial commit 2019-02-09 04:32:50 -08:00
main.go Config Tweaks 2019-03-23 10:06:37 -07:00
main_test.go Ran formatter and fixed some lint issues 2019-02-14 14:53:32 -08:00
revive.toml Ran formatter and fixed some lint issues 2019-02-14 14:53:32 -08:00

README.md

Stash

Build Status Go Report Card Discord

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.

Usage

CLI

Stash provides some command line options. See what is currently available by running stash --help.

For example, to run stash locally on port 80 run it like this (OSX / Linux) stash --host 127.0.0.1 --port 80

SSL (HTTPS)

Stash supports 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 to be customized for your environment. This link might be useful.

Once you have a certificate and key file name them stash.crt and stash.key and place them in the ~/.stash directory. Stash will detect these and start up using HTTPS rather than HTTP.

FAQ

I'm unable to run the app on OSX or Linux

Try running chmod u+x stash-osx or chmod u+x stash-linux to make the file executable.

I have a question not answered here.

Join the Discord server.

Development

Install

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

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/v2 directory and run yarn build 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 uses a modification 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