From 856281d1fd2d69401088ad9a0ff58e92aeced8ec Mon Sep 17 00:00:00 2001 From: Alexandre CATTEAU Date: Sun, 18 Sep 2022 11:57:20 +0200 Subject: [PATCH] Update README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e7ae01a..d53195b 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,18 @@ The idea is to provide the following features, chosen at install: * a web interface for file management with [File Browser](https://github.com/filebrowser/filebrowser); * a DLNA server with MiniDLNA; * a BitTorrent client with Transmission, which comes with a server web interface; -* an VPN client with OpenVPN; +* a VPN client with OpenVPN; * a FTP server with vsftpd. In addition, Nginx is used to provide HTTPS proxy to File Browser and Transmission ### Requirements The following list of packages must be installed manually (depending on which features are needed): -```transmission-daemon minidlna openvpn nginx``` +```transmission-daemon minidlna openvpn nginx vsftpd``` File Browser must be installed manually at `/usr/local/bin/filebrowser`. A "NAS user" should be defined, owner of the NAS root directory: This user shall run some of above services. -If using Transmission, you need to set a OpenVPN connection config as `vpn`. +If using Transmission, you need to set an OpenVPN connection config as `vpn`. ### File Browser init If using File Browser, it should be initiated first: @@ -28,7 +28,7 @@ sudo -u filebrowser -d /filebrowser.db --username ### Files * `transmission-vpn.sh` is a script which checks if a VPN connection is active and stops Transmission otherwise. -* `variables.conf.template` contains examples variables definitions, and should be copied locally to `variables.conf` +* `variables.conf.template` contains examples of variables definitions, and should be copied locally to `variables.conf` (with any required modifications). * `systemd-templates/` contains Systemd units templates for all the services. * `nginx-blocks/` contains Nginx configuration blocks.