mirror of https://github.com/stashapp/stash.git
README update
This commit is contained in:
parent
a0c73e8004
commit
5b5a72364f
42
README.md
42
README.md
|
@ -4,11 +4,49 @@
|
|||
|
||||
See a demo [here](https://vimeo.com/275537038) (password is stashapp).
|
||||
|
||||
TODO
|
||||
TODO: This is not match the features of the Rails project quite yet. Consider using that until this project is complete.
|
||||
|
||||
## Setup
|
||||
|
||||
TODO
|
||||
TODO: This is not final. There is more work to be done to ease this process.
|
||||
|
||||
### OSX / Linux
|
||||
|
||||
1. `mkdir ~/.stash` && `cd ~/.stash`
|
||||
2. Download FFMPEG ([macOS](https://ffmpeg.zeranoe.com/builds/macos64/static/ffmpeg-4.0-macos64-static.zip), [Linux](https://www.johnvansickle.com/ffmpeg/old-releases/ffmpeg-4.0.3-64bit-static.tar.xz)) and extract so that just `ffmpeg` and `ffprobe` are in `~/.stash`
|
||||
3. Create a `config.json` file (see below).
|
||||
4. Run stash with `./stash` and visit `http://localhost:9998` or `https://localhost:9999`
|
||||
|
||||
### Windows
|
||||
|
||||
1. Create a new folder at `C:\Users\YourUsername\.stash`
|
||||
2. Download [FFMPEG](https://ffmpeg.zeranoe.com/builds/win64/static/ffmpeg-4.0-win64-static.zip) and extract so that just `ffmpeg.exe` and `ffprobe.exe` are in `C:\Users\YourUsername\.stash`
|
||||
3. Create a `config.json` file (see below)
|
||||
4. Run stash with `./stash` and visit `http://localhost:9998` or `https://localhost:9999`
|
||||
|
||||
### Config.json
|
||||
|
||||
Example:
|
||||
|
||||
*OSX / Linux*
|
||||
```
|
||||
{
|
||||
"stash": "/Volumes/Drobo/videos",
|
||||
"metadata": "/Volumes/Drobo/stash/metadata",
|
||||
"cache": "/Volumes/Drobo/stash/cache",
|
||||
"downloads": "/Volumes/Drobo/stash/downloads",
|
||||
}
|
||||
```
|
||||
|
||||
*Windows*
|
||||
```
|
||||
{
|
||||
"stash": "C:\\Videos",
|
||||
"metadata": "C:\\stash\\metadata",
|
||||
"cache": "C:\\stash\\cache",
|
||||
"downloads": "C:\\stash\\downloads",
|
||||
}
|
||||
```
|
||||
|
||||
# Development
|
||||
|
||||
|
|
Loading…
Reference in New Issue