diff --git a/README.md b/README.md index 32fbb62..1c2fbc6 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Check the [Configuration Guide](doc/configuration.md). ### Dependencies - [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 *(2.16+ recommended)* - [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 @@ -117,3 +117,8 @@ All data is saved in the docker volumes `seedbox_config` or `seedbox_torrents`. These volumes are mapped to the `config` and `torrents` folders located in `/data` on the host. You can change these static paths in the docker-compose.yml file. Thanks to the **local-persist** Docker plugin, the data located in these volumes is persistent, meaning that volumes are not deleted, even when using the ```docker-compose down``` command. It would be a shame to loose everything by running a simple docker command ;-) + +# Configure your apps + +- Some indications here (more to come): [Apps Configuration](doc/configuration.md#apps-configuration) +- [TRaSH Guides](https://trash-guides.info/) \ No newline at end of file diff --git a/doc/apps/deluge-flood.md b/doc/apps/deluge-flood.md new file mode 100644 index 0000000..09304bf --- /dev/null +++ b/doc/apps/deluge-flood.md @@ -0,0 +1,15 @@ +# Deluge + Flood configuration + +Here is the recommended configuration for Deluge to work with Flood: + +- In your ``.env`` configuration file, check that both ``FLOOD_PASSWORD`` and ``FLOOD_AUTOCREATE_USER_IN_DELUGE_DAEMON`` variables are set and that ``FLOOD_AUTOCREATE_USER_IN_DELUGE_DAEMON`` is ``true``. +- Check in your ``config.yaml`` that both ``Deluge`` and ``Flood`` are enabled. +- Run the stack: ``./run-seedbox.sh`` +- Wait for services to be up and running. +- Go to Deluge UI (by default ``deluge.yourdomain.com``). +- Open Preferences +- In the "Daemon" menu, select "Allow remote connections". + +![Deluge Daemon Config](img/deluge-remote-connections.png) + +- Save changes and restart Flood: ``docker restart flood`` (if necessary). diff --git a/doc/apps/img/deluge-remote-connections.png b/doc/apps/img/deluge-remote-connections.png new file mode 100644 index 0000000..f2fd6b9 Binary files /dev/null and b/doc/apps/img/deluge-remote-connections.png differ diff --git a/doc/configuration.md b/doc/configuration.md index 22b9100..278f515 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -15,6 +15,7 @@ * [How is VPN handled?](#how-is-vpn-handled) * [Make the services communicate with each other](#make-the-services-communicate-with-each-other) * [How does the configuration work?](#how-does-the-configuration-work) +* [Apps configuration](#apps-configuration) ## General principles @@ -316,3 +317,11 @@ http: ``` This file will be automatically placed in [traefik/custom/](../traefik/custom/) directory (mounted by Traefik container) so the config will dynamically apply. This file is updated on each ``run-seedbox.sh`` execution. + +# Apps configuration + +List of currently available documentation for apps: + +- [Deluge + Flood](apps/deluge-flood.md) + +I also strongly recommend [TRaSH Guides](https://trash-guides.info/) to have a better overview of all *arrs apps configurations. \ No newline at end of file