adminconf/nas-server
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Alexandre CATTEAU
2022-09-18 11:57:20 +02:00
parent 321f92e962
commit 856281d1fd
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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 web interface for file management with [File Browser](https://github.com/filebrowser/filebrowser);
* a DLNA server with MiniDLNA; * a DLNA server with MiniDLNA;
* a BitTorrent client with Transmission, which comes with a server web interface; * 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. * a FTP server with vsftpd.
In addition, Nginx is used to provide HTTPS proxy to File Browser and Transmission In addition, Nginx is used to provide HTTPS proxy to File Browser and Transmission
### Requirements ### Requirements
The following list of packages must be installed manually (depending on which features are needed): 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`. 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. 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 ### File Browser init
If using File Browser, it should be initiated first: If using File Browser, it should be initiated first:
@@ -28,7 +28,7 @@ sudo -u <nas-user> filebrowser -d <nas>/filebrowser.db --username <admin>
### Files ### Files
* `transmission-vpn.sh` is a script which checks if a VPN connection is active and stops Transmission otherwise. * `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). (with any required modifications).
* `systemd-templates/` contains Systemd units templates for all the services. * `systemd-templates/` contains Systemd units templates for all the services.
* `nginx-blocks/` contains Nginx configuration blocks. * `nginx-blocks/` contains Nginx configuration blocks.