Installation‐and‐updates

Installation and updates

Requirements

Hass-Cleaner is intended for Home Assistant OS or another installation with Supervisor and Home Assistant App support.

Supported architectures:

• amd64
• aarch64

Install from GitHub

1. Open Home Assistant.

2. Go to Settings → Apps → App store.

3. Open the menu in the top-right corner.

4. Select Repositories.

5. Add:

   https://github.com/dkwolf1/Hass-Cleaner

6. Find Hass-Cleaner in the App store.

7. Install the App.

8. Optionally enable Show in sidebar.

9. Start Hass-Cleaner.

10. Open the web interface.

First launch

On the first launch:

1. Open Hass-Cleaner.
2. Run a scan only.
3. Review the overview and scan results.
4. Export the Markdown report if you want to inspect or share the findings.
5. Do not begin with a large cleanup operation.

The recommended first practical test is one old log file or another clearly rebuildable file.

Updating

When Home Assistant reports an available update:

1. Read the changelog.
2. Preferably create a full Home Assistant backup.
3. Update Hass-Cleaner.
4. Restart the App if required.
5. Run a new scan.

Starting a new scan clears old interface selections so that previous results cannot accidentally be reused.

Releases and packages

GitHub Releases contain version information and release notes. GitHub Container Registry packages contain the actual multi-architecture container images used by Home Assistant.

• GitHub Releases
• Container package