diff --git a/README.md b/README.md index 879931b..21f219f 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,17 @@ These scripts automate the backup process for **Home Assistant** servers, enabli - **Old Backup Cleanup**: Automatically cleans up old backups on both the Home Assistant server and local machine after a specified retention period. - **Notification Support** (Optional): Configure **ntfy** or **Discord** notifications to alert you about the backup status (available in the first script version). -### Two Versions of the Script: +### Three Versions of the Script: -1. **Version 1: Simple Backup with Cleanup** +1. **Version 1** A simpler version that creates a backup, copies it to your local machine, and performs a basic cleanup of old backups locally. No notification system is included in this version. -2. **Version 2: Full Backup and Cleanup with Notifications** +2. **Version 2** This version includes backup creation, local and remote cleanup of old backups, and optional notifications via **ntfy** and **Discord**. It also checks for available disk space before cleaning up old backups. - + +3. **Version 3 (RECOMMENDED)** + This version continues on from 2.0.1 but it has now been ported to Go and has a Go binary + ## Requirements Both scripts require the following to function correctly: @@ -27,33 +30,12 @@ Both scripts require the following to function correctly: - **SSH** access to the Home Assistant server - **`scp`** and **`ssh`** tools - **Home Assistant** installed on the server with the `ha` CLI tool -- **Optional**: Access to a notification service (for Version 2) +- **Optional**: Access to a notification service (for Version 2&3) ## Configuration -Before running either script, you need to set up a few configuration parameters. These include SSH credentials, backup destination paths, and notification settings. +Each version has different configuration files -- **HA_SSH_KEY**: Path to your private SSH key for accessing the Home Assistant server. -- **HA_SSH_USER**: The SSH username (default is `root`). -- **HA_SSH_HOST**: The IP address or hostname of your Home Assistant server. -- **BACKUP_DEST**: Path to the directory where backups will be saved locally. -- **Retention Settings**: You can configure how long old backups are kept before they are deleted (default is 30 days for local and remote backups). -- **Optional**: Set up **ntfy** or **Discord** notifications to receive alerts when backups are created or when errors occur. - -## How to Use - -### Step 1: Configure the Script -Open the script file in a text editor and set the following variables: -- **SSH credentials** (`HA_SSH_KEY`, `HA_SSH_USER`, `HA_SSH_HOST`) -- **Backup destination path** (`BACKUP_DEST`) -- **Notification settings** (optional) - -### Step 2: Make the Script Executable - -After configuring the script, make it executable by running: -``` -chmod +x home_assistant_backup.sh -``` ## Disclaimer @@ -75,6 +57,6 @@ By using or modifying this script, you agree to indemnify and hold harmless the --- -Use of this script is subject to the terms above. If you do not agree with this disclaimer, you should not use the script. +Use of this project is subject to the terms above. If you do not agree with this disclaimer, you should not use it.