Synology NAS on KnightLi Blog

Build a Git Server on Synology NAS and Back It Up with Hyper Backup

Wed, 07 Dec 2022 00:00:00 +0000

Synology NAS can be used as a lightweight private Git server. For personal projects or a small team, this is often enough: repositories stay inside the LAN, access can be managed through NAS accounts, and the data can be backed up with Synology’s built-in tools.

This note records the basic setup idea and the backup workflow with Hyper Backup.

Install Git Server

Open Package Center on Synology DSM and install the Git Server package.

After installation, open Git Server and allow the required users to use Git over SSH. The NAS account must have SSH access and permission to the folder where repositories are stored.

Prepare A Repository Directory

Create a shared folder or a subdirectory for Git repositories, for example:

`1`	`/volume1/git`

Inside this directory, create bare repositories:

`1`	`git init --bare project.git`

A bare repository does not contain a working tree. It is suitable for use as a remote repository.

Connect From A Client

From another machine, clone the repository through SSH:

`1`	`git clone user@nas-ip:/volume1/git/project.git`

You can also add it as a remote in an existing local project:

1
2

git remote add origin user@nas-ip:/volume1/git/project.git
git push -u origin master

If SSH uses a non-standard port, specify it in the SSH configuration or use a custom remote URL.

Permissions

Make sure the repository directory belongs to the correct user or group. If multiple users need access, assign them to a shared group and grant read/write permission to the Git folder.

When push fails, check these items first:

whether SSH login works;
whether the user is allowed in Git Server;
whether the folder permission is writable;
whether the repository was initialized as bare;
whether the remote URL is correct.

Back Up With Hyper Backup

After repositories are stored on the NAS, configure Hyper Backup to back up the Git directory.

In Hyper Backup:

Create a new backup task.
Select the destination, such as another disk, another NAS, rsync server or cloud storage.
Select the Git repository folder.
Configure the schedule.
Enable version retention if needed.

This protects the repository data against disk failure, accidental deletion or wrong pushes.

Restore Notes

When restoring, recover the whole bare repository directory. After restoration, test with:

`1`	`git clone user@nas-ip:/volume1/git/project.git`

If cloning works, the repository is usable again.

Summary

Synology Git Server is simple, but it is enough for many private repositories. The important points are SSH access, correct folder permissions, bare repositories and a reliable Hyper Backup task.

Use FRP to Access Synology DS File, DS Photo and Remote Desktop Without a Public IP

Sat, 10 Oct 2020 00:00:00 +0000

FRP is a high-performance reverse proxy tool. It can expose services inside a private network to the public Internet and supports TCP, HTTP and HTTPS forwarding. This makes it useful when the home network has no public IP address, but you still want to access services such as Synology DS File, DS Photo or a Windows remote desktop.

Project address:

`1`	`https://github.com/fatedier/frp`

Install The FRP Server

Download a release from the FRP project page. The original setup used FRP 0.34.1 on Ubuntu 20.04 as an example:

1
2

wget https://github.com/fatedier/frp/releases/download/v0.34.1/frp_0.34.1_linux_arm64.tar.gz
tar -zvxf frp_0.34.1_linux_arm64.tar.gz

After extraction, the package contains the server, client, sample configuration files and systemd service files:

frp_0.34.1_linux_amd64
├── frpc
├── frpc_full.ini
├── frpc.ini
├── frps
├── frps_full.ini
├── frps.ini
├── LICENSE
└── systemd
    ├── frpc.service
    ├── frpc@.service
    ├── frps.service
    └── frps@.service

Copy the binaries, configuration files and service files to the system:

copy frp_0.34.1_linux_amd64/frpc /usr/bin/
copy frp_0.34.1_linux_amd64/frps /usr/bin/
copy frp_0.34.1_linux_amd64/*.ini /etc/fpr/
copy frp_0.34.1_linux_amd64/systemd/* /etc/systemd/system

If /etc/fpr/ does not exist, create it first.

Server Configuration

The server-side frps.ini can be configured like this:

[common]
bind_port = 10100
vhost_http_port = 10101
token = XXXXXX

dashboard_port = 10109
dashboard_user = admin
dashboard_pwd = XXXXXX

log_file = /var/log/frps.log
log_level = debug
log_max_days = 3

bind_port is used for communication between the FRP server and clients. vhost_http_port receives public HTTP traffic. If Nginx is used in front of FRP, Nginx should proxy traffic to this port.

More options are available in frps_full.ini.

Start, stop, restart and enable the FRP server:

systemctl start frps
systemctl stop frps
systemctl restart frps
systemctl status frps
systemctl enable frps

Optional Nginx Proxy

If port 80 is already handled by Nginx, proxy the required domains to the FRP HTTP virtual host port:

server {
    listen 80;
    server_name dsphoto.youdomain.com dsfile.youdomian.com frp.yourdomian.com;
    location / {
        proxy_pass http://127.0.0.1:10101;
        proxy_set_header Host $host:80;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        proxy_connect_timeout 7d;
        proxy_send_timeout 7d;
        proxy_read_timeout 7d;
    }
    if ($http_user_agent ~* "360Spider|JikeSpider|Spider|spider|bot|Bot|2345Explorer|curl|wget|webZIP|qihoobot|Baiduspider|Googlebot|Googlebot-Mobile|Googlebot-Image|Mediapartners-Google|Adsbot-Google|Feedfetcher-Google|Yahoo! Slurp|Yahoo! Slurp China|YoudaoBot|Sosospider|Sogou spider|Sogou web spider|MSNBot|ia_archiver|Tomato Bot|NSPlayer|bingbot") {
        return 403;
    }
}

FRP Client Configuration

Client installation is similar to the server side. The client uses frpc, the configuration file is frpc.ini, and the service is frpc.

Example client configuration:

[common]
server_addr = frp.yourdomain.com
server_port = 10100
token = XXXXXX
log_file = /tmp/frpc.log
log_level = info
log_max_days = 3
tcp_mux = true
protocol = tcp
login_fail_exit = false
user = admin

[DSphoto]
type = http
local_ip = 192.168.68.200
local_port = 80
custom_domains = dsphoto.yourdomain.com

[DSfile]
type = http
local_ip = 192.168.68.200
local_port = 5000
custom_domains = dsfile.yourdomain.com

[DSM]
type = tcp
local_ip = 192.168.68.200
local_port = 5000
remote_port = 5000

[MSTC]
type = tcp
local_ip = 192.168.68.168
local_port = 3389
remote_port = 3389

DSphoto exposes the Synology photo service. DSfile exposes DS File over HTTP. DSM exposes the DSM management port through TCP. MSTC forwards Windows Remote Desktop.

After the client connects successfully, access the configured domains or ports from the public network.