Deprecate convenience script

mrrfv · Jan 1, 2024 · bd6622a · bd6622a
1 parent d386a22
commit bd6622a
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -140,27 +140,9 @@ $ archive_password="456" ./backup.sh
 
 ## Convenience Script
 
-If you'd like to quickly run the latest version of Open Android Backup without having to follow the usage instructions, you can use the convenience script. It's a **work in progress**, but it should work on most systems.
+The `get.openandroidbackup.me` convenience script is deprecated starting January 1st 2024 due to potential security implications associated with running unverified code from the internet as well as its limited support for various system configurations. Please use the official usage instructions instead.
 
-Please note that there are **security risks** associated with running scripts from the internet. It's recommended that you review the script before running it. If you don't trust me or Cloudflare, you can always download the script and run it manually.
-
-### Linux or macOS
-
-Run the following command in your terminal:
-
-```bash
-curl -fsSL get.openandroidbackup.me | bash
-```
-
-### Windows
-
-Run the following command in PowerShell:
-
-```powershell
-irm https://get.openandroidbackup.me/ | iex
-```
-
-The same path is used because the server automatically detects your operating system based on the user agent and serves the correct script.
+Removal of the script is planned for April 2024, although it may stay up for longer if it's still being used by a significant number of people.
 
 ## Building companion app
 

diff --git a/convenience-scripts/README.md b/convenience-scripts/README.md
@@ -4,6 +4,12 @@ These scripts allow you to quickly run the latest version of Open Android Backup
 
 ## get.openandroidbackup.me
 
+### Deprecated
+
+This convenience script has been deprecated and will stop functioning in April 2024. Please use the official usage instructions instead.
+
+## Usage
+
 You can access the convenience script from this domain. It automatically detects your operating system based on the user agent and serves the correct script.
 
 ### Linux or macOS

diff --git a/convenience-scripts/index.html b/convenience-scripts/index.html
@@ -9,6 +9,7 @@
     <style>body { font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif; background-color: #ebebeb; padding: 1em; }</style>
 </head>
 <body>
+    <p>Warning: The Open Android Backup convenience script has been deprecated and will stop functioning in April 2024. Please use the official usage instructions instead. Read the GitHub repository's README for more information.</p>
     <p>This is meant to be downloaded and run from a terminal. See <a href="https://github.com/mrrfv/open-android-backup">here</a> for information about Open Android Backup.</p>
 </body>
 </html>
diff --git a/convenience-scripts/invalid_ua.sh b/convenience-scripts/invalid_ua.sh
@@ -1 +1,2 @@
-echo "Could not detect your operating system based on your user agent. Please run this script in PowerShell on Windows or curl/wget on Linux or macOS, using the default UA."
+echo "Warning: This convenience script has been deprecated and will stop functioning in April 2024. Please use the official usage instructions instead. Read the GitHub repository's README for more information."
+echo "Could not detect your operating system based on your user agent. Please run this script in PowerShell on Windows or curl/wget on Linux or macOS, using the default UA."
diff --git a/convenience-scripts/linux_mac.sh b/convenience-scripts/linux_mac.sh
@@ -1,5 +1,10 @@
 #!/bin/bash
 
+echo "Warning: This convenience script has been deprecated and will stop functioning in April 2024. Please use the official usage instructions instead. Read the GitHub repository's README for more information."
+
+# Sleeping to ensure the user doesn't just ignore the warning
+sleep 5
+
 echo "Detected operating system: Linux or macOS"
 echo "If you are running this script in WSL, please run it in Windows instead."
 echo "Sleeping for 5 seconds to allow you to cancel..."

diff --git a/convenience-scripts/windows.ps1 b/convenience-scripts/windows.ps1
@@ -2,6 +2,10 @@ echo "Detected operating system: Windows"
 echo "Sleeping for 5 seconds to allow you to cancel..."
 sleep 5
 
+# It makes more sense to put the deprecation warning after the OS detection, since the echo command is different in PowerShell.
+Write-Output "Warning: This convenience script has been deprecated and will stop functioning in April 2024. Please use the official usage instructions instead. Read the GitHub repository's README for more information."
+sleep 5
+
 Write-Output "Open Android Backup - Windows Convenience Script"
 Write-Output "This script lets you use open-android-backup on Windows."
 Write-Output "Please remember that this script hasn't been fully tested, and may contain bugs."