Borgmatic - SynoCommunity/spksrc GitHub Wiki
-
Log into the web interface
-
Go to Package Center
-
Go to the Community tab
-
Search for
Borg
-
Click Install
-
Click Agree when asked about 3rd party software
Step 2 - Create Hidden Shared Folder for Borg Config Files and Certificates
- Open the DSM Control Panel and choose Shared Folder
- Click Create and enter a name and description. Ensure the following is set:
- Hide this shared folder in "My Network Places"
- Hide sub-folders and files from users without permissions
- Enable Recycle Bin
In the new folder created in Step 2, create your borgmatic.yml
config file.
A sample configuration can be found on the official borgmatic website.
To create and edit this file in-browser, you can add the Text Editor package by Synology in Package Center.
You can also create a borgmatic configuration file. Just run the following command in an interactive ssh session or with a scheduled task that you run manually (similar to Step 5 and 6 below).
/usr/local/bin/borgmatic config generate -d /volume1/Backup/fake-data/borgmatic.yml
If you have any private keys for uploading files to remote repos, they can be placed in the folder created above.
- In DSM Control Panel, go to Task Scheduler.
- Click Create > Scheduled Task > User-defined script.
- On the General Tab, name the job and ensure that the User is set to root.
- On the Schedule Tab, set whatever works for your setup.
- On the Task Settings tab, under Run command > User-defined script, add your borgmatic command. Below is a sample command:
/usr/local/bin/borgmatic --config /volume1/Backup/fake-data/borgmatic.yml
- Click OK.
- To test out the task, in DSM Control Panel, go to Task Scheduler.
- Click the task you created and then click Run, then OK.
There will not be any visual output, however if you add --log-file /path/to/file.log --log-file-verbosity 2
you can have the output of the command shown in the log file.
To see current config options after an update of borgmatic run borgmatic config generate like
/usr/local/bin/borgmatic config generate -d /volume1/Backup/fake-data/borgmatic-config-new.yml
To create btrfs snapshots you need the findmnt
tool.
You must install the synocli-misc
package (SynoCli misc. Tools by SynoCommunity) to have findmnt
available.
You find some information in the request Add findmnt for borgmatic, but btrfs support on synology is limited:
Unfortunately, the btfs function in borgmatic is currently on subvolumes, so it is currently somewhat useless on the synology if you want to back up shared folders.