caspervk/borgbackup_on_android
1
0
Fork 0
Code Releases Activity
Project to make BorgBackup run on Android.
43 commits 2 branches 0 tags 65 KiB
Shell 82.3%
Python 10.2%
Diff 7.5%
Find a file
Casper V. Kristensen 5a0b022009
Acquire wake lock before backing up.
2019-03-22 03:27:40 +01:00
sync_file_range_test check for sync_file_range and patch 2017-11-26 00:01:17 +01:00
backup.sh Acquire wake lock before backing up. 2019-03-22 03:27:40 +01:00
borg.sh Fix smalles mistakes.. 2019-03-22 03:08:02 +01:00
borg_ssh_wrapper Add ssh flags to counter ssh asking for a password, even if there is an SSH key for the target server. 2019-03-22 02:55:26 +01:00
borg_sync_file_range.patch Update borg_sync_file_range.patch for borg v1.2.0a5 (2019-03-21). 2019-03-22 01:03:42 +01:00
build.sh Clean repo tests upon completion. 2019-03-22 02:51:40 +01:00
LICENSE Initial commit 2017-07-29 16:58:11 +02:00
README.md Add server configuration to README. 2019-03-22 03:27:17 +01:00

README.md

BorgBackup on Android

Forked from ravenschade/borgbackup_on_android with modifications from GAhlekzis.

Introduction

This project provides build scripts to compile BorgBackup and its dependencies on Android. It uses Termux as a lightweight environment.

You do not need root permission on your phone to use it. However, without root permissions the access to data of other apps or system data is not possible, but you can still access your photos, videos.

If you have root permission on your device, you can use the "sudo" of Termux, tsu, to conveniently gain root permissions in Termux and backup your complete device.

Building Borg

Install Termux from F-Droid, open it, and execute the following:

pkg install git
git clone https://git.caspervk.net/caspervk/borgbackup_on_android
cd borgbackup_on_android
bash build.sh

If virtualenv for Python does not work properly, set selinux to permissive (tsudo /system/bin/setenforce 0).

Warning messages like

WARNING: linker: /data/data/com.termux/files/usr/lib/libacl.so.1.1.0: unused DT entry: type 0xf arg 0x449

are due to the Android linker. More details can be found here.

Tested with:

  • Termux 0.56, 0.66
  • Borg 1.0.12, 1.1.3, 1.2.0a5

Configuration

Install Tasker and Termux:Task for Termux-Tasker integration.

Copy backup script to a folder where Termux:Task can find it

mkdir -p ~/.termux/tasker
cp backup.sh ~/.termux/tasker/backup.sh

Create a repository passphrase (and remember to back it up!!)

head -c 1024 /dev/urandom | base64 > /data/data/com.termux/files/home/borgbackup_on_android/borg-passphrase

Change <server> and <port> in borg.sh to correct values.

Generate keypair for root with empty password

tsudo ssh-keygen -t ed25519
tsudo cat

Add ~/.ssh/id_ed25519.pub to authorized_users on server

command="mkdir -p ~/repos/phone; cd ~/repos/phone; borg serve --restrict-to-path ~/repos/phone",restrict ssh-ed25519 AAA..yX root@phone

Known Issues

Borg starting at 1.1 requires the system call sync_file_range (see https://github.com/borgbackup/borg/pull/985 and https://github.com/borgbackup/borg/issues/1961). The linux subsystem in Windows 10 and some older Android versions (for example Lineage including 14.1) do not yet have this. Lineage 15.0 has this call and should work. I have added a test to the build script that checks if sync_file_range is available. If it is not, then I apply a patch (borg_sync_file_range.patch) that replaces this sync with conventional file syncs.