mirror of
https://github.com/stashapp/stash.git
synced 2025-12-06 16:34:02 +01:00
docker documentation update (#5721)
- use docker compose instead of deprecated docker-compose - add note for package as docker-cli-compose - add link for reverse proxy - remove obselete version string Co-authored-by: feederbox826 <feederbox826@users.noreply.github.com>
This commit is contained in:
parent
913a58057a
commit
193b175618
2 changed files with 12 additions and 9 deletions
|
|
@ -1,12 +1,14 @@
|
||||||
# Docker Installation (for most 64-bit GNU/Linux systems)
|
# Docker Installation (for most 64-bit GNU/Linux systems)
|
||||||
StashApp is supported on most systems that support Docker and docker-compose. Your OS likely ships with or makes available the necessary packages.
|
StashApp is supported on most systems that support Docker. Your OS likely ships with or makes available the necessary packages.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
Only `docker` and `docker-compose` are required. For the most part your understanding of the technologies can be superficial. So long as you can follow commands and are open to reading a bit, you should be fine.
|
Only `docker` is required. For the most part your understanding of the technologies can be superficial. So long as you can follow commands and are open to reading a bit, you should be fine.
|
||||||
|
|
||||||
Installation instructions are available below, and if your distrobution's repository ships a current version of docker, you may use that.
|
Installation instructions are available below, and if your distributions's repository ships a current version of docker, you may use that.
|
||||||
https://docs.docker.com/engine/install/
|
https://docs.docker.com/engine/install/
|
||||||
|
|
||||||
|
On some distributions, `docker compose` is shipped seperately, usually as `docker-cli-compose`. docker-compose is not recommended.
|
||||||
|
|
||||||
### Get the docker-compose.yml file
|
### Get the docker-compose.yml file
|
||||||
|
|
||||||
Now you can either navigate to the [docker-compose.yml](https://raw.githubusercontent.com/stashapp/stash/develop/docker/production/docker-compose.yml) in the repository, or if you have curl, you can make your Linux console do it for you:
|
Now you can either navigate to the [docker-compose.yml](https://raw.githubusercontent.com/stashapp/stash/develop/docker/production/docker-compose.yml) in the repository, or if you have curl, you can make your Linux console do it for you:
|
||||||
|
|
@ -19,7 +21,7 @@ curl -o docker-compose.yml https://raw.githubusercontent.com/stashapp/stash/deve
|
||||||
Once you have that file where you want it, modify the settings as you please, and then run:
|
Once you have that file where you want it, modify the settings as you please, and then run:
|
||||||
|
|
||||||
```
|
```
|
||||||
docker-compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
Installing StashApp this way will by default bind stash to port 9999. This is available in your web browser locally at http://localhost:9999 or on your network as http://YOUR-LOCAL-IP:9999
|
Installing StashApp this way will by default bind stash to port 9999. This is available in your web browser locally at http://localhost:9999 or on your network as http://YOUR-LOCAL-IP:9999
|
||||||
|
|
@ -29,9 +31,9 @@ Good luck and have fun!
|
||||||
### Docker
|
### Docker
|
||||||
Docker is effectively a cross-platform software package repository. It allows you to ship an entire environment in what's referred to as a container. Containers are intended to hold everything that is needed to run an application from one place to another, making it easy for everyone along the way to reproduce the environment.
|
Docker is effectively a cross-platform software package repository. It allows you to ship an entire environment in what's referred to as a container. Containers are intended to hold everything that is needed to run an application from one place to another, making it easy for everyone along the way to reproduce the environment.
|
||||||
|
|
||||||
The StashApp docker container ships with everything you need to automatically build and run stash, including ffmpeg.
|
The StashApp docker container ships with everything you need to automatically run stash, including ffmpeg.
|
||||||
|
|
||||||
### docker-compose
|
### docker compose
|
||||||
Docker Compose lets you specify how and where to run your containers, and to manage their environment. The docker-compose.yml file in this folder gets you a fully working instance of StashApp exactly as you would need it to have a reasonable instance for testing / developing on. If you are deploying a live instance for production, a reverse proxy (such as NGINX or Traefik) is recommended, but not required.
|
Docker Compose lets you specify how and where to run your containers, and to manage their environment. The docker-compose.yml file in this folder gets you a fully working instance of StashApp exactly as you would need it to have a reasonable instance for testing / developing on. If you are deploying a live instance for production, a [reverse proxy](https://docs.stashapp.cc/guides/reverse-proxy/) (such as NGINX or Traefik) is recommended, but not required.
|
||||||
|
|
||||||
The latest version is always recommended.
|
The latest version is always recommended.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
# APPNICENAME=Stash
|
# APPNICENAME=Stash
|
||||||
# APPDESCRIPTION=An organizer for your porn, written in Go
|
# APPDESCRIPTION=An organizer for your porn, written in Go
|
||||||
version: '3.4'
|
|
||||||
services:
|
services:
|
||||||
stash:
|
stash:
|
||||||
image: stashapp/stash:latest
|
image: stashapp/stash:latest
|
||||||
|
|
@ -27,10 +26,12 @@ services:
|
||||||
- /etc/localtime:/etc/localtime:ro
|
- /etc/localtime:/etc/localtime:ro
|
||||||
## Adjust below paths (the left part) to your liking.
|
## Adjust below paths (the left part) to your liking.
|
||||||
## E.g. you can change ./config:/root/.stash to ./stash:/root/.stash
|
## E.g. you can change ./config:/root/.stash to ./stash:/root/.stash
|
||||||
|
## The left part is the path on your host, the right part is the path in the stash container.
|
||||||
|
|
||||||
## Keep configs, scrapers, and plugins here.
|
## Keep configs, scrapers, and plugins here.
|
||||||
- ./config:/root/.stash
|
- ./config:/root/.stash
|
||||||
## Point this at your collection.
|
## Point this at your collection.
|
||||||
|
## The left side is where your collection is on your host, the right side is where it will be in stash.
|
||||||
- ./data:/data
|
- ./data:/data
|
||||||
## This is where your stash's metadata lives
|
## This is where your stash's metadata lives
|
||||||
- ./metadata:/metadata
|
- ./metadata:/metadata
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue