From 0efdf8ee11aea59153c037b8145af8fa7af4b314 Mon Sep 17 00:00:00 2001 From: Alexandre CATTEAU Date: Mon, 6 Jun 2022 16:01:00 +0200 Subject: [PATCH] Update README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97143c7..9499111 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,17 @@ An FTP server is installed on the device, providing network access to authorized ### Setup ##### Installation * `setup.sh` is a script automating the installation and configuration of required software. +* `variables.conf.template` contains examples variables definitions, and should be copied locally to `variables.conf` + (with any required modifications). * `srv-nas.mount` is a systemd unit which, when started, will try to mount DATA drive. +##### DL server +* `transmission-daemon.service` is a replacement for default Transmission service file, with more settings. +* `transmission-vpn.sh` is a script which checks if a VPN connection is active and stops Transmission otherwise. +* `transmission-vpn.service` is a service unit for above script. +* `transmission-vpn.timer` is a timer which runs regularly above script. +* `variables.conf.template` contains examples variables definitions, and should be copied locally to `variables.conf` + (with any required modifications). +* `install.sh` script copies Systemd units to their destination, with correct values. ### TODO -* When new conf-sync will be available, adapt script. +* Add TLS cert generation to DL setup