Add some docs
This commit is contained in:
29
docs/deployment-docker.md
Normal file
29
docs/deployment-docker.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Deployment using Docker
|
||||
|
||||
Using Docker is the most easy and recommended way to run PsiTransfer. There is an
|
||||
[official Container](https://hub.docker.com/r/psitrax/psitransfer/) which is
|
||||
updated whenever a GitHub push occurs.
|
||||
|
||||
```bash
|
||||
docker run -d -v $PWD/data:/data -p 3000:3000 psitrax/psitransfer
|
||||
```
|
||||
The above command starts the PsiTransfer Docker container and
|
||||
* `-d` puts the process into background (daemon mode)
|
||||
* `-v` mounts the data volume into the container
|
||||
* `-p` forwards the traffic from port 3000 into the container
|
||||
|
||||
**Protipp**: There are several [container tags](https://hub.docker.com/r/psitrax/psitransfer/tags/)
|
||||
if you want to use a specific version. E.g. `1` is always the latest stable `1.x.x` and `1.1`
|
||||
correlates with `1.1.x`.
|
||||
|
||||
If you want to customize some PsiTransfer configurations use environment parameters
|
||||
by adding `-e` flags to the `docker run` command.
|
||||
|
||||
```bash
|
||||
docker run -v $PWD/data:/data -p 3000:8080 \
|
||||
-e PSITRANSFER_PORT=8080 \
|
||||
-e PSITRANSFER_DEFAULTRETENTION=3600 \
|
||||
psitrax/psitransfer
|
||||
```
|
||||
|
||||
**Protipp**: By adding `--restart always` Docker will autostart the container after reboots.
|
||||
Reference in New Issue
Block a user