Home Assistant Discourse Backup Sync

Home Assistant Add-on for automated Discourse backup sync

2025
ActiveOpen Source
Screenshot of add-on options page

Configuration Options

Home Assistant Discourse Backup Sync Logo

Project Logo

A Home Assistant Add-on that connects to a Discourse community forum server via API to automatically retrieve and download backup files to the local disk. It allows the user to configure a retention schedule, ensuring older backups are pruned to save space. The add-on is automatically built and deployed to GitHub Container Registry (GHCR) using GitHub Actions.

Technologies Used

language

PythonBashJavaScriptHTML

platform

DockerHome Assistant

devops

GitHub Actions

Challenges

Integrating with the Home Assistant Add-on structure. Implementing reliable API communication with the Discourse server, including handling authentication and large file transfers. Configuring automated build and deployment to GHCR.

Key Learnings

Building **Docker containers** specific to the **Home Assistant Add-on** specification. Utilizing **Python's `requests` library** for secure API interaction and file transfer. Setting up multi-stage builds and **GitHub Actions** workflows for Continuous Integration/Continuous Deployment (CI/CD).

Project Details

Difficulty
intermediate

Related Projects

Back to all projects