BackupFriendPi

An out of the box Raspberry Pi Raspbian distro that runs BackupFriend using Docker and Nginx-proxy as a reverse proxy, with letsencrypt. BackupFriend lets you put a Raspberry Pi in your friend and family, or anywhere else, and backup your files with history, and then access them over a web service, or by physically taking the drive back.

Where to get it?

Official mirror is here

How to use it?

1. Unzip the image and install it to an SD card like any other Raspberry Pi image
2. Configure your WiFi by editing backupfriendpi-wpa-supplicant.txt at the root of the flashed card when using it like a flash drive
3. ssh to sync rdiff-backup is at port at 8022: http://backupfriend:8022
4. Boot the Pi from the SD card
5. Hostname is backupfriend (not raspberrypi as usual), username: pi and inital password is: raspberry
6. After a few mintues you should be able to access http://backupfriend/ or http://backupfriend.local.
7. Default password for the Web UI is admin password admin123.

Configuration notes

• Configure the BackFriend server settings are at /boot/docker-compose/02_backupfriend/docker-compose.yml
• rdiffweb instance also avilable port 8082: http://backupfriend:8082
• You can change the settings of the Backupfriend/nginx-proxy stack in the files located at /boot/docker-compose/backupfriend/ and /boot/docker-compose/01_nginx-proxy/.

Requirements

• A domain pointing to your Pi's IP.
• 2A power supply
• RaspberryPi 2, 3B, 3B+, 4B (not 1 and zero)

Features

• Backupfriend-docker Pre-installed using docker
• Nginx-proxy to manage reverse proxy and certificates if you have a domain to set up (optional, but recommended)

Developing

Requirements

1. Docker or Vagrant, docker recommended
2. Docker-compose - recommended if using docker build method, instructions assume you have it
3. Downloaded Raspberry Pi OS image.
4. Root privileges for chroot
5. Bash
6. sudo (the script itself calls it, running as root without sudo won't work)

Build BackupFriendPi

BackupFriendPi can be built using docker running either on an intel or RaspberryPi (supported ones listed). Build requires about 4.5 GB of free space available. You can build it assuming you already have docker and docker-compose installed issuing the following commands:

git clone https://github.com/guysoft/BackupFriendPi.git
cd BackupFriendPi/src/image
wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'
cd ..
sudo docker-compose up -d
sudo docker exec -it backupfriendpi-build build

Building BackupFriendPi Variants

BackupFriendPi supports building variants, which are builds with changes from the main release build. An example and other variants are available in the folder src/variants/example.

To build a variant use:

sudo docker exec -it backupfriendpi-build build [Variant]

Building Using Vagrant

There is a vagrant machine configuration to let build BackupFriendPi in case your build environment behaves differently. Unless you do extra configuration, vagrant must run as root to have nfs folder sync working.

To use it:

sudo apt-get install vagrant nfs-kernel-server
sudo vagrant plugin install vagrant-nfs_guest
sudo modprobe nfs
cd BackupFriendPi/src/vagrant
sudo vagrant up

After provisioning the machine, its also possible to run a nightly build which updates from devel using:

cd BackupFriendPi/src/vagrant
run_vagrant_build.sh

To build a variant on the machine simply run:

cd BackupFriendPi/src/vagrant
run_vagrant_build.sh [Variant]

Usage

1. If needed, override existing config settings by creating a new file src/config.local. You can override all settings found in src/config. If you need to override the path to the Raspbian image to use for building BackupFriendPi, override the path to be used in ZIP_IMG. By default, the most recent file matching *-raspbian.zip found in src/image will be used.
2. Run src/build_dist as root.
3. The final image will be created in src/workspace

Code contribution would be appreciated!