Skip to content

Instantly share code, notes, and snippets.

@aka-z

aka-z/backup-synology-through-rsnapshot.md

Forked from frankkusters/backup-synology-through-rsnapshot.md
Created December 8, 2020 13:46
Show Gist options
  • Save aka-z/658c94a9d0a52495d3910ef06ad1dffb to your computer and use it in GitHub Desktop.
Save aka-z/658c94a9d0a52495d3910ef06ad1dffb to your computer and use it in GitHub Desktop.
Download ZIP
Installing and configuring SSH, rsync and rsnapshot to let a LaCie Network Space 2 make backups of a Synology DS215j
Raw
1-readme.md

Introduction

I need a backup solution for my Synology DS215j NAS. My requirements are:

  • a backup solution that pulls data from the Synology DS, so that it is not possible for malware on the DS to corrupt the backups.
  • a restore solution that is really easy to use for everyone else in my house.
  • highly frequent backups. With modern storage technologies, it's unnecessary to lose more than an hour's worth of work.

Also, I have a LaCie Network Space 2 lying around, which is perfectly up to this task. Let's install and configure rsnapshot!

Note: proficiency with Linux is assumed!

Installing software on the Network Space 2

The NS2 does not have the ability to create backups from another NAS (for example through rsync) through its web interface. Therefore, I need to install a backup utility through SSH.

  1. Update the firmware. The latest release (as of February 10th, 2015) fixes the Shellshock vulnerability. It would be a shame to have our little backup server hacked.

  2. Disable software updates. This is so that our modifications will be left alone. Be sure to update manually once in a while.

  3. Enable SSH (the procedure for firmware 2.2.8 should be fine).

  4. As suggested in the manual for step 3, set up login with SSH keys.

  5. Install ipkg. Some small details differ. See install-ipkg.sh below.

  6. Install rsnapshot: ipkg install rsnapshot.

Setting up passwordless SSH from the NS2 to the Synology DiskStation

To be able to make backups of the entire system, including DSM configuration and any other modifications, the NS2 needs SSH access with root permissions.

  1. Enable the User Home Service on the DS.

  2. Generate a public key on the NS2.

  3. Enable SSH with SSH keys (this is a Synology-specific manual). Use the NS2 key from /root/.ssh/id_rsa.pub.

  4. Enable the rsync daemon on the DS. Otherwise you'll get strange rsync errors on the NS2.

Configuring rsnapshot

Edit /opt/etc/rsnapshot.conf. Make sure backups are stored in /shares/MyShare, as /shares/OpenShare is readable by everyone on the network - we don't want that. We'll open up MyShare later.

My rsnapshot.conf is shown below. The excludes in the configuration are inspired by this Stack Exchange question.

For added security

Raw
install-ipkg.sh
cd /opt
feed=http://ipkg.nslu2-linux.org/feeds/optware/cs05q3armel/cross/stable
# This path no longer exists.
#feednative=http://ipkg.nslu2-linux.org/feeds/optware/cs05q3armel/native/unstable
ipk_name=`wget -qO- $feed/Packages | awk '/^Filename: ipkg-opt/ {print $2}'`
wget $feed/$ipk_name
tar -xOvzf $ipk_name ./data.tar.gz | tar -C / -xzvf -
mkdir -p /opt/etc/ipkg
echo "src cross $feed" > /opt/etc/ipkg/feeds.conf
#echo "src native $feednative" >> /opt/etc/ipkg/feeds.conf
export PATH=/opt/bin:$PATH
ipkg update
# I don't want mldonkey.
#ipkg install mldonkey
Raw
rsnapshot.conf
#################################################
# rsnapshot.conf - rsnapshot configuration file #
#################################################
# #
# PLEASE BE AWARE OF THE FOLLOWING RULES: #
# #
# This file requires tabs between elements #
# #
# Directories require a trailing slash: #
# right: /home/ #
# wrong: /home #
# #
#################################################
#######################
# CONFIG FILE VERSION #
#######################
config_version 1.2
###########################
# SNAPSHOT ROOT DIRECTORY #
###########################
# All snapshots will be stored under this root directory.
snapshot_root /shares/MyShare/
# If no_create_root is enabled, rsnapshot will not automatically create the
# snapshot_root directory. This is particularly useful if you are backing
# up to removable media, such as a FireWire drive.
#
#no_create_root 1
#################################
# EXTERNAL PROGRAM DEPENDENCIES #
#################################
# LINUX USERS: Be sure to uncomment "cmd_cp". This gives you extra features.
# EVERYONE ELSE: Leave "cmd_cp" commented out for compatibility.
#
# See the README file or the man page for more details.
#
cmd_cp /opt/bin/cp
# uncomment this to use the rm program instead of the built-in perl routine.
cmd_rm /opt/bin/rm
# rsync must be enabled for anything to work.
cmd_rsync /opt/bin/rsync
# Uncomment this to enable remote ssh backups over rsync.
cmd_ssh /opt/bin/ssh
# Comment this out to disable syslog support.
#cmd_logger /path/to/logger
# Uncomment this to specify a path to "du" for disk usage checks.
cmd_du /opt/bin/du
#########################################
# BACKUP INTERVALS #
# Must be unique and in ascending order #
# i.e. hourly, daily, weekly, etc. #
#########################################
interval hourly 24
interval daily 7
interval weekly 4
interval monthly 12
interval halfyearly 10
############################################
# GLOBAL OPTIONS #
# All are optional, with sensible defaults #
############################################
# If your version of rsync supports --link-dest, consider enable this.
# This is the best way to support special files (FIFOs, etc) cross-platform.
# The default is 0 (off).
#
link_dest 1
# Verbose level, 1 through 5.
# 1 Quiet Print fatal errors only
# 2 Default Print errors and warnings only
# 3 Verbose Show equivalent shell commands being executed
# 4 Extra Verbose Show extra verbose information
# 5 Debug mode More than you care to know
#
verbose 2
# Same as "verbose" above, but controls the amount of data sent to the
# logfile, if one is being used. The default is 3.
loglevel 3
# If you enable this, data will be written to the file you specify. The
# amount of data written is controlled by the "loglevel" parameter.
logfile /opt/var/log/rsnapshot
# The include and exclude parameters, if enabled, simply get passed directly
# to rsync. If you have multiple include/exclude patterns, put each one on a
# seperate line. Please look up the --include and --exclude options in the
# rsync man page for more details.
#
#include ???
#include ???
#exclude ???
#exclude ???
exclude /dev
exclude /proc
exclude /run
exclude /sys
exclude /tmp
# The include_file and exclude_file parameters, if enabled, simply get
# passed directly to rsync. Please look up the --include-from and
# --exclude-from options in the rsync man page for more details.
#
#include_file /path/to/include/file
#exclude_file /path/to/exclude/file
# Default rsync args. All rsync commands have at least these options set.
#
#rsync_short_args -a
#rsync_long_args --no-o --delete --relative --delete-excluded
# ssh has no args passed by default, but you can specify some here.
#
#ssh_args -p 22
# Default arguments for the "du" program (for disk space reporting).
# The GNU version of "du" is preferred. See the man page for more details.
#
#du_args -csh
# If this is enabled, rsync won't span filesystem partitions within a
# backup point. This essentially passes the -x option to rsync.
# The default is 0 (off).
#
#one_fs 0
# If enabled, rsnapshot will write a lockfile to prevent two instances
# from running simultaneously (and messing up the snapshot_root).
# If you enable this, make sure the lockfile directory is not world
# writable. Otherwise anyone can prevent the program from running.
#
lockfile /opt/var/run/rsnapshot.pid
###############################
### BACKUP POINTS / SCRIPTS ###
###############################
# LOCALHOST
#backup /home/ localhost/
#backup /etc/ localhost/
#backup /opt/etc/ localhost/
#backup /usr/local/ localhost/
#backup /etc/passwd localhost/
#backup /home/foo/My Documents/ localhost/
#backup /foo/bar/ localhost/ one_fs=1, rsync_short_args=-urltvpog
#backup_script /usr/local/bin/backup_pgsql.sh localhost/postgres/
# EXAMPLE.COM
#backup [email protected]:/home/ example.com/
backup [email protected]:/ ./
# CVS.SOURCEFORGE.NET
#backup_script /usr/local/bin/backup_rsnapshot_cvsroot.sh cvs.sourceforge.net/
# RSYNC.SAMBA.ORG
#backup rsync://rsync.samba.org/rsyncftp/ rsync.samba.org/rsyncftp/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment