KeyArgo
/
seedbox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README

This commit is contained in:
Serut 2016-02-18 09:20:12 +01:00 committed by Kelvin Chen
parent 07e3a8eec5
commit f5af7251d7
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -20,21 +20,24 @@ Note: Plex is also available directly through the `32400` port without going
through the reverse proxy. You will have to sign in with your plex.tv account through the reverse proxy. You will have to sign in with your plex.tv account
if you do this. if you do this.
## Dependencies
- [Docker](https://github.com/docker/docker) >= 1.10.0
- [Docker Compose](https://github.com/docker/compose) >=v1.6.0
## Running ## Running
```sh ```sh
$ docker-compose pull $ docker-compose pull
$ docker-compose up -d $ docker-compose up -d
``` ```
docker-compose should manage all the volumes and network setup for you. If it
does not, verify that your docker and docker-compose version is updated.
Make sure you install the dependencies and finish configuration before doing Make sure you install the dependencies and finish configuration before doing
this. this.
You may optionally build the images yourself instead of pulling by running You may optionally build the images yourself instead of pulling by running
`./build-all.sh`. `./build-all.sh`.
## Dependencies
- [Docker](https://github.com/docker/docker)
- [Docker Compose](https://github.com/docker/compose) >=v1.6.0
## Configuration ## Configuration
Copy the `config.default` file to `config` and change the variables as desired. Copy the `config.default` file to `config` and change the variables as desired.
The variables are all self-explanatory. The variables are all self-explanatory.
@ -47,6 +50,9 @@ certificates for you.
## Where is my data? ## Where is my data?
All data are saved in the docker volumes `seedbox_config` or All data are saved in the docker volumes `seedbox_config` or
`seedbox_torrents`. `seedbox_torrents`.
You can also replace these docker volumes with static path if you want to
handle manually where files are stored on your server. You can do this by
editing the volumes settings in the `docker-compose.yml` file.
## OpenVPN ## OpenVPN
The OpenVPN container generates a single client key/cert pair by default. The OpenVPN container generates a single client key/cert pair by default.