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

Add doc

This commit is contained in:
Jean Froment 2022-03-06 23:34:05 +01:00
parent bfacdaa0d7
commit 36304749da
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -34,24 +34,21 @@ seedbox and personal media server.
| Heimdall | yourdomain.com | [linuxserver/heimdall](https://hub.docker.com/r/linuxserver/heimdall)| *latest* | Main dashboard | | Heimdall | yourdomain.com | [linuxserver/heimdall](https://hub.docker.com/r/linuxserver/heimdall)| *latest* | Main dashboard |
| Gluetun | - | [qmcgaw/gluetun](https://hub.docker.com/r/qmcgaw/gluetun)| *latest* | VPN client | | Gluetun | - | [qmcgaw/gluetun](https://hub.docker.com/r/qmcgaw/gluetun)| *latest* | VPN client |
The front-end reverse proxy (Traefik - **check [this guide](doc/traefik_v2.md) if you still have the seedbox with Traefik v1**) routes based on the lowest level subdomain The front-end reverse proxy (Traefik - **check [this guide](doc/traefik_v2.md) if you still have the seedbox with Traefik v1**) routes based on the lowest level subdomain (e.g. `deluge.example.com` would route to deluge). Since this is how the router works, it is recommended for you to get a top level domain. If you do not have one, you can edit your domains locally by changing your hosts file or use a browser plugin that changes the host header.
(e.g. `deluge.example.com` would route to deluge). Since this is how the router
works, it is recommended for you to get a top level domain. If you do not have
one, you can edit your domains locally by changing your hosts file or use a
browser plugin that changes the host header.
Traefik takes care of valid Let's Encrypt certificates and auto-renewal. Traefik takes care of valid Let's Encrypt certificates and auto-renewal.
Note: Plex is also available directly through the `32400` port without going Note: Plex is also available directly through the `32400` port without going through the reverse proxy.
through the reverse proxy.
## Dependencies ## Dependencies
- [Docker](https://github.com/docker/docker) >= 20.10 - [Docker](https://github.com/docker/docker) >= 20.10
- [Docker Compose](https://github.com/docker/compose) >= 2.2 - [Docker Compose](https://github.com/docker/compose) >= 2.2
- [local-persist Docker plugin](https://github.com/MatchbookLab/local-persist): installed directly on host (not in container). This is a volume plugin that extends the default local driver’s functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to always persist, even if the volume is removed via `docker volume rm`. Use *systemd* install for Ubuntu. - [local-persist Docker plugin](https://github.com/MatchbookLab/local-persist): installed directly on host (not in container). This is a volume plugin that extends the default local driver’s functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to always persist, even if the volume is removed via `docker volume rm`. Use *systemd* install for Ubuntu.
- [jq](https://stedolan.github.io/jq/download/) >= 1.5
- [yq](https://github.com/mikefarah/yq/releases) > 4
## Configuration ## Set up for the first time
Before running, please create the volumes which will be statically mapped to the ones on the host: Before running, please create the volumes which will be statically mapped to the ones on the host:
For example: For example:
@ -64,13 +61,19 @@ sudo su -c "mkdir /data && mkdir /data/config && mkdir /data/torrents"
Edit the `.env` file and change the variables as desired. Edit the `.env` file and change the variables as desired.
The variables are all self-explanatory. The variables are all self-explanatory.
## Configuration
The configuration lives in the ``config.yaml`` file.
All you need to know is located in the [Configuration Guide](doc/configuration.md).
## Running & updating ## Running & updating
```sh ```sh
./run-seedbox.sh ./run-seedbox.sh
``` ```
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. All services and synamic configuration will be automatically created without further action from your part.
Make sure you install the dependencies and finish configuration before doing this. Make sure you install the dependencies and finish configuration before doing this.

2
doc/UPGRADE_V2.md
View File

@ -20,7 +20,7 @@ Since there are some breaking changes and a configuration structure migration, a
* Default gluetun configuration is Wireguard "custom" mode, but see below... * Default gluetun configuration is Wireguard "custom" mode, but see below...
* **Support custom services and docker-compose yaml files** * **Support custom services and docker-compose yaml files**
* Place a docker-compose yaml file in ``services/custom/`` directory, add a service in your config.yaml specifying a ``customFile``, and you are set. * Place a docker-compose yaml file in ``services/custom/`` directory, add a service in your config.yaml specifying a ``customFile``, and you are set.
* Support Plex hardware transcoding using a custom-file, already available in the ``services`` directory (just specify a customFile on plex service - see [config.sample.yaml](config.sample.yaml)). * Support Plex hardware transcoding using a custom-file, already available in the ``services`` directory (just specify a ``customFile`` on plex service - see [config.sample.yaml](../config.sample.yaml)).
* More details in the [Configuration Guide](./configuration.md). * More details in the [Configuration Guide](./configuration.md).
* **Support arbitrary Traefik rules** * **Support arbitrary Traefik rules**
* Place a Traefik YAML in ``samples/custom-traefik/`` directory, it will be copied in the Traefik configuration folder. * Place a Traefik YAML in ``samples/custom-traefik/`` directory, it will be copied in the Traefik configuration folder.