DOCSEARCHbyAlgolia
Submit Docs

Matheson Steplock Home Assistant Addon Repository

website·Indexed 32 days ago

https://addons.mathesonsteplock.ca/docs

Documentation for a collection of Home Assistant addons, including Tasmota Device Manager (TDM), Remote Backup, rsyslog, and amcrest2mqtt. Includes installation guides, configuration notes, security settings for SSH and rsync, and automation blueprints.

Tokens
2.4K
Snippets
13
Records
20
Agent score
55%

What's inside Matheson Steplock Addons

  3. Configure Remote Backup addon for Synology NAS

    When using a Synology NAS with the Remote Backup addon, observe the following requirements and path differences:

    1. Permissions: For DSM 6.2.x and newer, the user account must be a member of the administrator group to allow SSH access.
    2. Pathing: The required path depends on the protocol used:
      • SCP: Typically requires the full volume path (e.g., /volume1/my_path/).
      • SFTP: Uses a different starting directory; use the relative path (e.g., my_path/).

  4. Set up key-based authentication for Remote Backup

    Using a private key for authentication is recommended over using a remote password. In Home Assistant OS and Supervised mode, encryption files are stored in the /ssl directory instead of the standard ~/.ssh folder. The public key is automatically generated during the key generation process.
    # 1. Navigate to the SSL directory
cd ~/ssl

# 2. Generate a unique ED25519 key
ssh-keygen -f ~/addon_configs/3490a758_remote_backup/something-unique-ed25519 -t ed25519

# 3. Copy the key to the remote server
ssh-copy-id -i ~/addon_configs/3490a758_remote_backup/something-unique-ed25519 user@host

  5. Set up Rclone (Experimental) for remote-backup

    To use Rclone for backups, place your rclone.conf file in the /addon_configs/3490a758_remote_backup/ directory. You can generate this file using the rclone config command on any machine running rclone. When configuring the add-on, set remote_host to the name of the remote defined in your rclone.conf (e.g., backblaze).
    [backblaze]
type = b2
account = xxxxxxxxxx
key = xxxxxxxxxxx

  6. Add the ikifar2012 Home Assistant Addon Repository

    To add the Home Assistant Addon Repository hosted by ikifar2012, use the repository URL: https://github.com/ikifar2012/ha-addons. This can be added manually in the Home Assistant Supervisor add-on store or via a direct redirect link.
    https://github.com/ikifar2012/ha-addons

  7. Map SSH keys to Remote Backup add-on configuration

    After generating and copying an SSH key, map the values in the add-on configuration UI as follows:

    • SSH private key: Enter the filename used during generation (e.g., something-unique-ed25519).
    • username: Enter the user part of the user@host string.
    • remote host: Enter the host part of the user@host string.

  8. Configure remote-backup add-on parameters

    The remote-backup add-on uses the following parameters to manage backups to remote servers via SSH, rsync, or Rclone. Note that some options are only required if the corresponding protocol is enabled.
    # Connection Settings
debug: false # Enable/disable debug mode
remote_host: "example.com" # Hostname/IP for SSH/rsync or Rclone remote name (e.g., backblaze)
remote_port: 22 # Port for SFTP (SSH) and rsync
remote_user: "username" # Authentication username
remote_password: "password" # Optional authentication password
remote_key: "id_rsa" # Optional SSH key filename (must be in /addon_configs/3490a758_remote_backup)
remote_host_key_algorithms: "" # Optional: enable legacy algorithms

# Backup Customization
backup_friendly_name: "My Backup" # Rename snapshot on destination to match HA UI
backup_custom_prefix: "Automated backup" # Prefix for the snapshot date
backup_exclude_folders: ["media", "share"] # Folders to exclude (valid: addons/local, homeassistant, media, share, ssl, all_addon_configs)
backup_exclude_addons: ["core_mariadb"] # Add-ons to exclude by slug (hostname with - replaced by _)
backup_keep_local: "all" # 'all' to keep all, null to remove after transfer, or a number to preserve specific amount
backup_password: "secret" # Optional: encrypts the backup

# Protocol Specifics
ssh_enabled: true
ssh_remote_directory: "/backups/ha" # Required if ssh_enabled is true

rsync_enabled: true
rsync_rootfolder: "/home/user/backups" # Required if rsync_enabled is true
rsync_exclude: "file1,folder2" # Comma separated list of exclusions

  9. amcrest2mqtt configuration options reference

    The following parameters are used to configure the amcrest2mqtt add-on:
    ParameterRequiredDescription
    amcrest_hostYesIP address of your Amcrest device
    amcrest_portNoPort used by your Amcrest device (defaults to 80)
    amcrest_usernameNoUsername used by your Amcrest device (defaults to admin)
    amcrest_passwordYesPassword used by your Amcrest device
    home_assistantNoSet to true to enable Home Assistant integration (defaults to true)
    home_assistant_prefixNoPrefix used by Home Assistant (defaults to 'homeassistant')
    storage_poll_intervalNoHow often to fetch storage data in seconds (defaults to 3600)
    device_nameNoOverride the default device name used in the Amcrest app

  10. Configure Rclone experimental settings for remote-backup

    The remote-backup add-on includes experimental Rclone functionality. Use the following parameters to control Rclone behavior. Note that rclone_remote_host and rclone_remote_directory are only required if the Rclone protocol is enabled.
    {
  "rclone_enabled": true, // Required: Enable/disable rclone function
  "rclone_remote_host": "backblaze", // Optional*: Remote name specified in rsync.conf
  "rclone_copy": false, // Optional: Enable rclone copy mode
  "rclone_sync": false, // Optional: Enable rclone sync mode
  "rclone_restore": false, // Optional: Restore remote files to date-stamped folder in /backup/
  "rclone_remote_directory": "my-bucket/backups" // Optional*: Remote path/bucket name
}

  11. Configure SSH known_hosts for Remote Backup

    To prevent the security risk of the add-on automatically accepting remote host keys, manually add the public key of the remote host to the add-on's known_hosts file. If the warning Missing known_hosts file! appears, the file is currently missing or empty.
    ssh-keyscan -t rsa <remote host> >> /addon_configs/3490a758_remote_backup/known_hosts

  12. Configure the amcrest2mqtt add-on

    The amcrest2mqtt add-on requires the MQTT broker add-on to be installed and configured before use. Configuration is handled via the add-on configuration page in Home Assistant.
    amcrest_host: '192.168.0.x'
amcrest_port: '80'
amcrest_username: 'admin'
amcrest_password: 'my_super_secure_passw0rd'
storage_poll_interval: '3600'
device_name: ''
home_assistant: true
home_assistant_prefix: ''