Skip to content

Commit c591bfb

Browse files
committed
Rebrand, finally :)
Linux Android Backup -> Open Android Backup
1 parent 9ce150f commit c591bfb

17 files changed

Lines changed: 184 additions & 65 deletions

File tree

.github/test-script.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
adb shell mkdir -p /storage/emulated/0/linux-android-backup-temp
3+
adb shell mkdir -p /storage/emulated/0/open-android-backup-temp
44

55
export unattended_mode="yes"
66
export selected_action="Backup"

.github/workflows/build-companion-unstable.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ jobs:
2222
- run: flutter build apk
2323
working-directory: ${{ env.working-directory }}
2424

25-
- run: cp -v companion_app/build/app/outputs/apk/release/app-release.apk ./linux-android-backup-companion.apk
25+
- run: cp -v companion_app/build/app/outputs/apk/release/app-release.apk ./open-android-backup-companion.apk
2626
- run: sudo apt update && sudo apt install p7zip-full
27-
- run: 7z a -bb3 -tzip -mx9 -x!.*\* -x!website\* -x!companion_app\* Linux_Android_Backup_Unstable_Bundle.zip .
27+
- run: 7z a -bb3 -tzip -mx9 -x!.*\* -x!website\* -x!companion_app\* Open_Android_Backup_Unstable_Bundle.zip .
2828

2929
- uses: "marvinpinto/action-automatic-releases@latest"
3030
with:
3131
repo_token: "${{ secrets.GITHUB_TOKEN }}"
3232
automatic_release_tag: "latest" # we need to keep this tag for legacy scripts to work (and as a fallback)
3333
prerelease: true
34-
title: "Linux Android Backup - Unstable Version"
34+
title: "Open Android Backup - Unstable Version"
3535
files: |
3636
companion_app/build/app/outputs/apk/release/app-release.apk
37-
Linux_Android_Backup_Unstable_Bundle.zip
37+
Open_Android_Backup_Unstable_Bundle.zip

.github/workflows/build-tagged.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ jobs:
2525
- run: flutter build apk
2626
working-directory: ${{ env.working-directory }}
2727

28-
- run: cp -v companion_app/build/app/outputs/apk/release/app-release.apk ./linux-android-backup-companion.apk
28+
- run: cp -v companion_app/build/app/outputs/apk/release/app-release.apk ./open-android-backup-companion.apk
2929
- run: sudo apt update && sudo apt install p7zip-full
30-
- run: 7z a -bb3 -tzip -mx9 -x!.*\* -x!website\* -x!companion_app\* Linux_Android_Backup_${{ github.ref_name }}_Bundle.zip .
30+
- run: 7z a -bb3 -tzip -mx9 -x!.*\* -x!website\* -x!companion_app\* Open_Android_Backup_${{ github.ref_name }}_Bundle.zip .
3131

3232
- uses: "marvinpinto/action-automatic-releases@latest"
3333
with:
3434
repo_token: "${{ secrets.GITHUB_TOKEN }}"
3535
prerelease: false
36-
title: "Linux Android Backup Stable - ${{ github.ref_name }}"
36+
title: "Open Android Backup Stable - ${{ github.ref_name }}"
3737
files: |
3838
companion_app/build/app/outputs/apk/release/app-release.apk
39-
Linux_Android_Backup_${{ github.ref_name }}_Bundle.zip
39+
Open_Android_Backup_${{ github.ref_name }}_Bundle.zip

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Linux Android Backup
1+
# Open Android Backup
22

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.
44

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.
5+
![Demo](https://github.com/mrrfv/open-android-backup/raw/c86602f9e5dbc501e0eacc43fe781c352998e712/.github/images/demo.gif)
66

7-
![Demo](https://github.com/mrrfv/linux-android-backup/raw/c86602f9e5dbc501e0eacc43fe781c352998e712/.github/images/demo.gif)
7+
**Important:** The `master` branch is reserved for development. If you are looking for a download, please go to Releases or select a tag instead.
88

99
## Data backed up
1010

1111
### Restoreable
1212

1313
The following data types can be automatically restored back to the device.
1414

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)
1616
- Internal storage (pictures, downloads, videos, Signal backups if enabled, etc)
1717
- Contacts (exported in vCard format)
1818

@@ -42,7 +42,7 @@ These things are the majority of what most people would want to keep safe, but e
4242
### Linux
4343

4444
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.
4646
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.
4747

4848
### macOS
@@ -65,7 +65,7 @@ brew install p7zip pv bash
6565
### Windows
6666

6767
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.
6969
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.**
7070

7171
![Powershell Developer Settings](.github/images/windows-powershell-developer-settings.png)
@@ -76,17 +76,17 @@ Just run `backup.sh` and the script will walk you through the process. This sect
7676

7777
### Hooks
7878

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.
8080

8181
**Info for users**
8282

8383
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.
8484

8585
**Info for the security conscious**
8686

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.
8888

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.
9090

9191
**Info for developers**
9292

@@ -122,7 +122,7 @@ There are 8 environment variables that control what the script does without user
122122
3. `archive_path` - Path to the backup. Works for both Restore and Backup actions.
123123
4. `archive_password` - Backup password.
124124
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.
126126
7. `use_hooks` - Whether to use hooks or not. Possible values are `yes` or `no` (case sensitive).
127127
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.
128128

@@ -151,6 +151,12 @@ PRs are appreciated.
151151
- Improve the error handling and design of the mobile app.
152152
- Export the calendar and other data.
153153

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+
154160
## License
155161

156162
This program is free software: you can redistribute it and/or modify

backup-windows.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Write-Output "This script lets you use linux-android-backup on Windows."
1+
Write-Output "This script lets you use open-android-backup on Windows."
22
Write-Output "Please ensure that you've installed the Windows Subsystem for Linux and a distro (Ubuntu or Debian) prior to running this script."
3-
Write-Output "If not, close this window, and refer to the README for instructions (https://github.com/mrrfv/linux-android-backup#windows=)"
3+
Write-Output "If not, close this window, and refer to the README for instructions (https://github.com/mrrfv/open-android-backup#windows=)"
44
Write-Output "If sudo asks you for your account password, don't enter your Windows password!"
55
Write-Output ""
66
Write-Output "Warning: WSL 2 is required. WSL will be updated to fix potential issues with the GUI."

backup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ fi
7575
if command -v srm &> /dev/null
7676
then
7777
if [ ! -v data_erase_choice ]; then
78-
cecho "Linux Android Backup creates a temporary folder that contains all the data exported from your device."
78+
cecho "Open Android Backup creates a temporary folder that contains all the data exported from your device."
7979
cecho "Leftovers from this folder might remain on your storage device, even after a successful backup or restore."
8080
cecho "The options below allow you to securely erase this data, making it harder for law enforcement and other adversaries to view your files."
8181
cecho "Your choice will also apply to cleanups, i.e. if the script has previously crashed without removing the files."

companion_app/android/app/src/main/AndroidManifest.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<application
1111
android:requestLegacyExternalStorage="true"
12-
android:label="Linux Android Backup Companion"
12+
android:label="Open Android Backup Companion"
1313
android:name="${applicationName}"
1414
android:icon="@mipmap/ic_launcher">
1515
<activity

companion_app/lib/main.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class MyApp extends StatelessWidget {
1818
@override
1919
Widget build(BuildContext context) {
2020
return MaterialApp(
21-
title: 'Linux Android Backup',
21+
title: 'Open Android Backup',
2222
theme: ThemeData(
2323
primarySwatch: Colors.green,
2424
),
@@ -79,7 +79,7 @@ class _HomeState extends State<Home> {
7979

8080
// Recreate the temp directory if it already exists.
8181
final Directory directory =
82-
Directory("/storage/emulated/0/linux-android-backup-temp");
82+
Directory("/storage/emulated/0/open-android-backup-temp");
8383
if (await directory.exists()) {
8484
await directory.delete(recursive: true);
8585
}
@@ -89,7 +89,7 @@ class _HomeState extends State<Home> {
8989
for (var i = 0; i < contacts.length; i++) {
9090
final String vCard = contacts[i].toVCard(withPhoto: true);
9191
final File file = File(
92-
"/storage/emulated/0/linux-android-backup-temp/linux-android-backup-contact-$i.vcf");
92+
"/storage/emulated/0/open-android-backup-temp/open-android-backup-contact-$i.vcf");
9393
file.writeAsString(vCard);
9494
setState(() {
9595
contactsExported = i + 1;
@@ -121,7 +121,7 @@ class _HomeState extends State<Home> {
121121
String csv = const ListToCsvConverter().convert(processedMessages);
122122

123123
final File smsFileExport = File(
124-
"/storage/emulated/0/linux-android-backup-temp/SMS_Messages.csv");
124+
"/storage/emulated/0/open-android-backup-temp/SMS_Messages.csv");
125125
smsFileExport.writeAsString(csv);
126126

127127
// Show a dialog if the export is complete
@@ -203,7 +203,7 @@ class _HomeState extends State<Home> {
203203
Widget build(BuildContext context) {
204204
return Scaffold(
205205
appBar: AppBar(
206-
title: const Center(child: Text('Linux Android Backup Companion')),
206+
title: const Center(child: Text('Open Android Backup Companion')),
207207
),
208208
body: SingleChildScrollView(
209209
child: Padding(
@@ -215,10 +215,10 @@ class _HomeState extends State<Home> {
215215
style: TextStyle(fontSize: 22, fontWeight: FontWeight.bold),
216216
),
217217
const Text(
218-
"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.",
219219
),
220220
const Text(
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."),
222222
// data export section
223223
const Text(
224224
"Export Data",

companion_app/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: companion_app
2-
description: Companion app for Linux Android Backup, an easy-to-use tool to backup and restore Android devices.
2+
description: Companion app for Open Android Backup, an easy-to-use tool to backup and restore Android devices.
33

44
# The following line prevents the package from being accidentally published to
55
# pub.dev using `flutter pub publish`. This is preferred for private packages.

extras/backup_archive_info.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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
33

44
"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

Comments
 (0)