Update README

This commit is contained in:
Alexandre CATTEAU 2022-06-06 16:01:00 +02:00
parent ff3093119c
commit 0efdf8ee11

View File

@ -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