You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
-
# Linux Android Backup
1
+
# Open Android Backup
2
2
3
-
Linux Android Backup is a tiny shell script & Flutter app that makes securely backing up Android devices easy, without vendor lock-ins or using closed-source software that could put your data at risk. It's based on ADB but doesn't use the deprecated `adb backup` command. Despite its name, this project works on Windows, macOS and Linux.
3
+
Open Android Backup is a tiny shell script & Flutter app that makes securely backing up Android devices easy, without vendor lock-ins or using closed-source software that could put your data at risk. It's based on ADB but doesn't use the deprecated `adb backup` command. This project works on Windows, macOS and Linux.
4
4
5
-
**Important:** I am looking for volunteers who are interested in helping me with maintaining this project as well as fixing bugs. This project is not being abandoned, I just need a helping hand.
**Important:** The `master` branch is reserved for development. If you are looking for a download, please go to Releases or select a tag instead.
8
8
9
9
## Data backed up
10
10
11
11
### Restoreable
12
12
13
13
The following data types can be automatically restored back to the device.
14
14
15
-
- Apps (.apk files of installed apps)
15
+
- Apps (.apk files of installed apps - split APK support is experimental and can be found in the `split-apk-support` branch)
16
16
- Internal storage (pictures, downloads, videos, Signal backups if enabled, etc)
17
17
- Contacts (exported in vCard format)
18
18
@@ -42,7 +42,7 @@ These things are the majority of what most people would want to keep safe, but e
42
42
### Linux
43
43
44
44
1. Install p7zip, adb, curl, bc, pv and optionally secure-delete. If you're on Debian or Ubuntu, run this command: `sudo apt update; sudo apt install p7zip-full adb curl bc pv secure-delete`.
45
-
2.[Download](https://github.com/mrrfv/linux-android-backup/releases/latest) the Linux Android Backup bundle, which contains the script and companion app in one package. You can also grab an experimental build (heavily discouraged) by clicking on [this link](https://github.com/mrrfv/linux-android-backup/archive/refs/heads/master.zip) or cloning.
45
+
2.[Download](https://github.com/mrrfv/open-android-backup/releases/latest) the Open Android Backup bundle, which contains the script and companion app in one package. You can also grab an experimental build (heavily discouraged) by clicking on [this link](https://github.com/mrrfv/open-android-backup/archive/refs/heads/master.zip) or cloning.
46
46
3. Enable [developer options](https://developer.android.com/studio/debug/dev-options#enable) and USB debugging on your device, then run `backup.sh` in a terminal.
47
47
48
48
### macOS
@@ -65,7 +65,7 @@ brew install p7zip pv bash
65
65
### Windows
66
66
67
67
1. Install the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install#install), a compatibility layer allowing you to run Linux applications (such as this one) on Windows. You only need to follow the `Install` step.
68
-
2.[Download](https://github.com/mrrfv/linux-android-backup/releases/latest) the Linux Android Backup bundle, which contains the script and companion app in one package. You can also grab an experimental build (heavily discouraged) by clicking on [this link](https://github.com/mrrfv/linux-android-backup/archive/refs/heads/master.zip) or cloning.
68
+
2.[Download](https://github.com/mrrfv/open-android-backup/releases/latest) the Open Android Backup bundle, which contains the script and companion app in one package. You can also grab an experimental build (heavily discouraged) by clicking on [this link](https://github.com/mrrfv/open-android-backup/archive/refs/heads/master.zip) or cloning.
69
69
3. Open the repository in the file explorer. Right click on a file called `backup-windows.ps1`, and click on "Run with PowerShell". **IMPORTANT: If you see an error after running the script, search for "Developer Settings" in the Settings app, and apply the settings related to PowerShell.**
@@ -76,17 +76,17 @@ Just run `backup.sh` and the script will walk you through the process. This sect
76
76
77
77
### Hooks
78
78
79
-
Linux Android Backup hooks allow you to effortlessly include your own backup steps, such as those that require root or work only on specific devices, without modifying the main script. You can upload these hooks to your own GitHub repositories and share them with others.
79
+
Open Android Backup hooks allow you to effortlessly include your own backup steps, such as those that require root or work only on specific devices, without modifying the main script. You can upload these hooks to your own GitHub repositories and share them with others.
80
80
81
81
**Info for users**
82
82
83
83
After writing or downloading a hook you'd like to use, rename it to `hooks.sh` and place in in the same directory as this script. Next, allow the use of hooks when the script asks you.
84
84
85
85
**Info for the security conscious**
86
86
87
-
Using hooks that you don't trust is a security risk that we don't claim responsibility for! They have the same access over your phone and computer as Linux Android Backup, making it possible for attackers to backdoor or wipe your devices. You must check the contents of the hook you'd like to use before running the script.
87
+
Using hooks that you don't trust is a security risk that we don't claim responsibility for! They have the same access over your phone and computer as Open Android Backup, making it possible for attackers to backdoor or wipe your devices. You must check the contents of the hook you'd like to use before running the script.
88
88
89
-
Linux Android Backup doesn't automatically load hooks, and you have to allow the use of them before they are even touched by the program.
89
+
Open Android Backup doesn't automatically load hooks, and you have to allow the use of them before they are even touched by the program.
90
90
91
91
**Info for developers**
92
92
@@ -122,7 +122,7 @@ There are 8 environment variables that control what the script does without user
122
122
3.`archive_path` - Path to the backup. Works for both Restore and Backup actions.
123
123
4.`archive_password` - Backup password.
124
124
5.`mode` - How the script should connect to the device. Possible values are `Wired` and `Wireless` (case sensitive).
125
-
6.`export_method` - The method Linux Android Backup should use to export data from the device. Possible values are `tar` and `adb` (case sensitive) - the former is fast & very stable but might not work on all devices, and the latter is widely compatible but has stability issues.
125
+
6.`export_method` - The method Open Android Backup should use to export data from the device. Possible values are `tar` and `adb` (case sensitive) - the former is fast & very stable but might not work on all devices, and the latter is widely compatible but has stability issues.
126
126
7.`use_hooks` - Whether to use hooks or not. Possible values are `yes` or `no` (case sensitive).
127
127
8.`data_erase_choice` - Whether to securely erase temporary files or not. Possible values are `Fast`, `Slow` and `Extra Slow` (case sensitive). The value of this variable is ignored if the command `srm` isn't present on your computer.
128
128
@@ -151,6 +151,12 @@ PRs are appreciated.
151
151
- Improve the error handling and design of the mobile app.
152
152
- Export the calendar and other data.
153
153
154
+
## Donations
155
+
156
+
This project is supported entirely by your kind donations. Thanks to your support, it was possible to get a real domain for this script - [openandroidbackup.me](https://openandroidbackup.me). By donating, you are contributing to the development of a community-driven project that respects your privacy and data. Please consider making a donation today and help keep this project alive and growing.
157
+
158
+
If you'd like to support me and this project, you can do so by clicking the Sponsor button on the top of the GitHub page or directly visiting the [Liberapay page](https://liberapay.com/mrrfv/).
159
+
154
160
## License
155
161
156
162
This program is free software: you can redistribute it and/or modify
"The Linux Android Backup companion app allows for backups of data not normally accessible through adb. No data is uploaded to a remote server: it is saved to the internal storage and then read by the script running on your computer.",
218
+
"The Open Android Backup companion app allows for backups of data not normally accessible through adb. No data is uploaded to a remote server: it is saved to the internal storage and then read by the script running on your computer.",
219
219
),
220
220
constText(
221
-
"This app requires the Linux Android Backup script running on your computer."),
221
+
"This app requires the Open Android Backup script running on your computer."),
This is a backup archive created by Linux Android Backup.
2
-
For more information, please visit the project's GitHub repository: https://github.com/mrrfv/linux-android-backup
1
+
This is a backup archive created by Open Android Backup.
2
+
For more information, please visit the project's GitHub repository: https://github.com/mrrfv/open-android-backup
3
3
4
4
"version.txt" is a file containing the version of the script when this backup was created; this data might be used in the future to improve backwards compatibility. Please avoid changing its contents.
0 commit comments