40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# NAS Server
|
|
|
|
This repository contains files used to set up our NAS server on Debian. Target is Bullseye.
|
|
|
|
### Introduction
|
|
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 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```
|
|
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`.
|
|
|
|
### File Browser init
|
|
If using File Browser, it should be initiated first:
|
|
```
|
|
sudo -u <nas-user> filebrowser -d <nas>/filebrowser.db --username <admin>
|
|
```
|
|
|
|
### 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`
|
|
(with any required modifications).
|
|
* `systemd-templates/` contains Systemd units templates for all the services.
|
|
* `nginx-blocks/` contains Nginx configuration blocks.
|
|
##### Installation
|
|
* `install.sh` script copies Systemd units to their destination, with correct values.
|
|
|
|
### TODO
|
|
* RAS
|