description

display backups informations (borg & duplicati) so that you can easilly check your backups are running fine.

 

features

• borg
  • view repos infos from multiple servers
  • list repos and their details
  • list archives and their details
  • access raw archive informations
  • optional custom repo directory
• duplicati
  • repo disk usage size
  • list archives (date)

install

requirements

• git
• borg (recent versions), on both client and server
• (recommended) borgmatic on the client, if you use borg_client script
• duplicati-cli on the server
• webserver (recommended Apache >= 2.4)
• PHP (>= 7.4), php-curl, pbp-bcmath, composer
• npm

compatibility

• Linux : tested on debian 12+
• Synology : tested on an old DS216j with DSM 7.1.1-42962 Update 5 (borg part)
  • you can find python, borg, node.js packages in community repo
  • download composer.phar from their website (use php8.0 composer.phar install)
  • you may have to go ssh root to handle repo permissions correctly

create a user (on the server)

adduser <user>
adduser www-data <user>
systemctl restart apache2

web server must have read/write rights to repo directory, so you must handle group carefully :

adduser www-data <user>
chmod -R 2770 <repo>

web ui

git clone https://github.com/olaulau/backup-ui
composer i
npm i

configure

cd backup-ui
cp conf/conf.dist.ini conf/conf.ini
vim conf/conf.ini
	fill-in values

usage

just go to https://<host>/backup-ui/repositories with your browser

borg client script

do all the stuff that client should do :

• run borgmatic commands
• fix permissions
• ask the web ui to update his cache

If you can't or don't wanna use this script, look at it and be sure to do all those things by yourself.
As borgmatic is just a convenient wrapper for borg commands, you can just execute borg by yourself.

install the borg client script (on the client)

cd bin/
rm borg_client.sh
wget https://raw.githubusercontent.com/olaulau/borg-ui/main/script/borg_client.sh
chmod u+x borg_client.sh
crontab -e
	0	*	*	*	*	. /etc/profile; . $HOME/.profile; cd bin; ./borg_client.sh <server> <user_name> <repo_name> >> borg_client.log 2>&1

duplicati update push

either :

• ask for the duplicati gui (client) to query a cache update of his repo on the server
  send-http-url='https://<host>/backup-ui/cache/update/duplicati/<user_name>/<repo_name>'
• query a cache update in a cron every night

   crontab -e
   	12	5	*	*	*	curl https://<host>/backup-ui/cache/update/duplicati/<user_name>/<repo_name>
   	12	5	*	*	*	curl https://<host>/backup-ui_DEV/cache/update/duplicati/<user_name>/<repo_name>
  

technical informations

• all data are locally stored in a file-cache, so thatweb display are fast
• refresh of cache is push by the client script

data structure

server > user > type > repo > archive
if no custom directory is provided, repositories are in thoses paths :
/<home_prefix>/<user>/<type>/<repo>

library used

• fat free framework : PHP framework
• bootstrap : CSS framework
• gabrielelana/byte-units : size unit conversion & display
• chart.js : charts