Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 357049aa7b | |||
| d85ef5621c | |||
| faac180212 | |||
| 76d8a45f37 | |||
| d68d322df6 | |||
| 113c951028 | |||
| 2a4ab676ec | |||
| c0a04f505e | |||
| a63006bb07 | |||
| f8e678215d | |||
| f745f8ec1e |
21
CHANGELOG.md
21
CHANGELOG.md
@@ -11,6 +11,27 @@ Sections:
|
||||
|
||||
---
|
||||
|
||||
## 0.6.8 – Performance & Cache Stabilization (2026-01-19)
|
||||
|
||||
### Fixed
|
||||
- Fixed excessive GitHub API requests causing rate limiting
|
||||
- Fixed missing persistence of repository versions and metadata
|
||||
- Fixed background enrichment re-running after Home Assistant restart
|
||||
|
||||
### Changed
|
||||
- Repository metadata (versions, README, descriptions) is now fetched once in the background
|
||||
- Cached data is reused and only refreshed on explicit user interaction
|
||||
- Improved separation between startup refresh and on-demand updates
|
||||
|
||||
### Improved
|
||||
- Significantly reduced Home Assistant startup time
|
||||
- Greatly reduced GitHub API usage
|
||||
- More reliable version selection for GitHub and HACS repositories
|
||||
|
||||
### Notes
|
||||
- Background tasks may still appear in DEBUG logs (expected behavior)
|
||||
- No functional UI changes in this release
|
||||
|
||||
## [0.6.7] - 2026-01-19
|
||||
|
||||
### Fixed
|
||||
|
||||
51
README.md
51
README.md
@@ -1,3 +1,50 @@
|
||||
# bahmcloud_store
|
||||
# Bahmcloud Store (BCS) for Home Assistant
|
||||
|
||||
Bahmcloud Store for installing costum_components to Homeassistant
|
||||
Bahmcloud Store (BCS) is a provider-neutral store for Home Assistant custom integrations.
|
||||
It allows you to browse, install, update, downgrade, uninstall and restore integrations
|
||||
directly from the Home Assistant UI.
|
||||
|
||||
This README is intended for **end users**.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Option A: Home Assistant OS / Supervised (Add-on – recommended)
|
||||
|
||||
1. Open **Settings → Add-ons → Add-on Store**
|
||||
2. Add the Bahmcloud Add-on repository
|
||||
`https://git.bahmcloud.de/bahmcloud/addons`
|
||||
3. Install **Bahmcloud Store Installer**
|
||||
4. Start the add-on
|
||||
5. Restart Home Assistant
|
||||
|
||||
Installed to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
|
||||
---
|
||||
|
||||
### Option B: Manual Installation (Container / Core)
|
||||
|
||||
1. Download the latest release
|
||||
2. Copy `custom_components/bahmcloud_store` to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
3. Restart Home Assistant
|
||||
|
||||
---
|
||||
|
||||
## Repository Sources
|
||||
|
||||
- **BCS Official**
|
||||
- **HACS**
|
||||
- **Custom**
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Developer documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_DEVELOPER.md
|
||||
|
||||
Full technical documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_FULL.md
|
||||
|
||||
115
README_DEVELOPER.md
Normal file
115
README_DEVELOPER.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Bahmcloud Store – Developer Documentation
|
||||
|
||||
For contributors and maintainers.
|
||||
|
||||
## Architecture
|
||||
|
||||
Repositories:
|
||||
1) Installer Add-on (HAOS/Supervised) ```https://git.bahmcloud.de/bahmcloud/addons```
|
||||
2) Core Integration ```https://git.bahmcloud.de/bahmcloud/bahmcloud_store```
|
||||
3) Store Index (`store.yaml`) ```https://git.bahmcloud.de/bahmcloud/ha_store```
|
||||
|
||||
### Integration Layout
|
||||
|
||||
custom_components/bahmcloud_store/
|
||||
- __init__.py: setup, panel registration, schedule background after HA started
|
||||
- core.py: index merge, enrichment, install/update/uninstall, backups, restore, caching
|
||||
- providers.py: GitHub/GitLab/Gitea repo info + latest version helpers
|
||||
- metadata.py: read bcs.yaml / hacs.json / hacs.yaml
|
||||
- storage.py: persistent storage (installed, custom, repo cache, hacs cache)
|
||||
- views.py: HTTP API endpoints
|
||||
- update.py: UpdateEntity implementation
|
||||
- repairs.py: (optional) Repairs flow for restart
|
||||
- panel/: UI (panel.js, styles.css, etc.)
|
||||
- manifest.json
|
||||
|
||||
## Runtime Model
|
||||
|
||||
- RepoItem (merged)
|
||||
- Installed repos (storage)
|
||||
- Repo cache (persisted enrichment)
|
||||
- HACS meta cache (mapping owner/repo → name/description)
|
||||
|
||||
## Background
|
||||
|
||||
- Heavy work only after `homeassistant_started`
|
||||
- Refresh: if index unchanged → installed-only refresh + schedule enrichment
|
||||
- Opening a repo triggers `ensure_repo_details()` and persists to cache
|
||||
|
||||
## Providers
|
||||
|
||||
- GitHub: API/releases/tags/atom + raw readme
|
||||
- GitLab: API releases/tags + raw readme
|
||||
- Gitea: API releases/tags + raw readme
|
||||
- Custom: API or HTTPS Request to your Git Provider
|
||||
|
||||
## Metadata
|
||||
|
||||
- Prefer `bcs.yaml`, fallback `hacs.json` / `hacs.yaml`
|
||||
- Populate name/description/category/author/maintainer
|
||||
|
||||
## HTTP API (excerpt)
|
||||
|
||||
Base: /api/bcs
|
||||
|
||||
- GET /api/bcs
|
||||
- POST /api/bcs?action=refresh
|
||||
- GET /api/bcs/readme?repo_id=...
|
||||
- GET /api/bcs/versions?repo_id=...
|
||||
- POST /api/bcs/install?repo_id=...&version=...
|
||||
- POST /api/bcs/update?repo_id=...&version=...
|
||||
- POST /api/bcs/uninstall?repo_id=...
|
||||
- GET /api/bcs/backups?repo_id=...
|
||||
- POST /api/bcs/restore?repo_id=...&backup_id=...
|
||||
- (optional) POST/DELETE custom_repo
|
||||
|
||||
## Update Entities
|
||||
|
||||
- Unique id bcs:<repo_id>
|
||||
- Compare installed ref vs latest ref
|
||||
- Dispatcher signal on refresh/install/update
|
||||
|
||||
## Storage
|
||||
|
||||
- JSON in HA `.storage`
|
||||
- async read/write helpers
|
||||
- repo cache applied on startup
|
||||
|
||||
## Contributing to **BCS Official**
|
||||
|
||||
1) Add pull request to `https://git.bahmcloud.de/bahmcloud/ha_store` (with your integration added to) `store.yaml`)
|
||||
2) Add entry:
|
||||
```yaml
|
||||
- name: Your Integration Name
|
||||
url: https://your-git-hoster.com/your-org/your-repo
|
||||
category: Category (actually only "Integrations" are supported)
|
||||
```
|
||||
3) (Recommended) Add `bcs.yaml` to your repo:
|
||||
```yaml
|
||||
name: Your Integration Name
|
||||
description: One-liner for the store (optional, store information are also catched from git repository)
|
||||
category: Integrations (actually only supported)
|
||||
author: Your Name
|
||||
maintainer: Your Handle
|
||||
```
|
||||
4) Open PR; validation checks: reachable, has `custom_components/<domain>/manifest.json`, sensible metadata
|
||||
5) Merge → appears in **BCS Official** after refresh
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
- Async I/O, no blocking event loop
|
||||
- Respect provider rate limits
|
||||
- Clean logging around refresh/install/update/restore
|
||||
- Keep UI responsive; throttle updates
|
||||
|
||||
---
|
||||
|
||||
## Planed Features
|
||||
|
||||
- Add Downloads and install for category "Dashboard"
|
||||
- Add Downloads and install for category "Template"
|
||||
- Add Downloads and install for category "Theme"
|
||||
- Add Downloads and install for category "Blueprint"
|
||||
-
|
||||
|
||||
|
||||
217
README_FULL.md
Normal file
217
README_FULL.md
Normal file
@@ -0,0 +1,217 @@
|
||||
# Bahmcloud Store – Full User Guide
|
||||
|
||||
This guide explains **all features** of Bahmcloud Store (BCS) for Home Assistant.
|
||||
It is written for users and admins who want a complete, practical reference.
|
||||
|
||||
> BCS lets you install & manage custom integrations from **GitHub/GitLab/Gitea** and your own sources, with backups, restore, and version pinning.
|
||||
|
||||
---
|
||||
|
||||
## Contents
|
||||
- Concepts
|
||||
- Sources (BCS / HACS / Custom)
|
||||
- UI Overview
|
||||
- Finding Integrations
|
||||
- Installing
|
||||
- Selecting Versions / Downgrading
|
||||
- Updating
|
||||
- Uninstalling
|
||||
- Backups & Restore
|
||||
- Custom Repositories
|
||||
- HACS Repositories
|
||||
- Update Entities in Home Assistant
|
||||
- Background Caching & Performance
|
||||
- Restart Required
|
||||
- Troubleshooting
|
||||
- FAQ
|
||||
|
||||
---
|
||||
|
||||
## Concepts
|
||||
|
||||
- **Sources**:
|
||||
- **BCS Official** → entries from index (`store.yaml`) made and added from Bahmcloud
|
||||
- **HACS** → official HACS integrations list (toggleable)
|
||||
- **Custom** → manual entries you add locally
|
||||
- **Install location**: `/config/custom_components/<domain>`
|
||||
- **Backup**: BCS keeps pre‑update copies in `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||
|
||||
---
|
||||
|
||||
## Sources (BCS / HACS / Custom)
|
||||
|
||||
Each repository card shows a **source badge**:
|
||||
- **BCS Official** – from Bahmcloud index
|
||||
- **HACS** – from HACS official list (enable with the toggle)
|
||||
- **Custom** – added by you
|
||||
|
||||
You can **filter by source** with the **Source** dropdown (All / BCS Official / HACS / Custom).
|
||||
|
||||
---
|
||||
|
||||
## UI Overview
|
||||
|
||||
Top bar:
|
||||
- **Search** (name/description)
|
||||
- **Source** filter (All/BCS Official/HACS/Custom)
|
||||
- **Category** filter (actually only Integrations are supported)
|
||||
- **State-Filter** filter (All/Installed/Not installed/Update available/Custom repos)
|
||||
- **Sort** (name (A-Z)/Updates first/Installed first)
|
||||
- **HACS official** toggle (on/off)
|
||||
|
||||
Repository card:
|
||||
- Name, description, badges (source, installed/update), category
|
||||
- Buttons: **Install / Update / Uninstall**
|
||||
- **Readme** expandable
|
||||
- **Open** to see details (available versions, metadata)
|
||||
|
||||
---
|
||||
|
||||
## Finding Integrations
|
||||
|
||||
1. Use **Search** to filter by keywords.
|
||||
2. Combine with **Category** and **Source**.
|
||||
3. Sort to surface desired results.
|
||||
|
||||
Descriptions and latest versions are filled progressively by a background process; opening a repo loads details on demand.
|
||||
|
||||
---
|
||||
|
||||
## Installing
|
||||
|
||||
1. Open a repository.
|
||||
2. Optionally select **Install version** (default: **Latest**).
|
||||
3. Click **Install** and wait for confirmation.
|
||||
4. Follow the **Restart required** prompt. (or use restart toggle in HomeAssistant Settings)
|
||||
|
||||
**What happens internally**
|
||||
- BCS downloads the repository ZIP for the selected version (release/tag/branch).
|
||||
- It extracts all integrations found under `custom_components/<domain>` and deploys them.
|
||||
- It saves the **installed version (ref)** to track updates reliably, even if the repo’s own `manifest.json` is wrong/outdated.
|
||||
|
||||
---
|
||||
|
||||
## Selecting Versions / Downgrading
|
||||
|
||||
- Use the **Install version** dropdown in the detail view.
|
||||
- Choose **Latest** or a previous **release/tag**.
|
||||
- Installing a chosen ref **pins** the integration to that ref (no surprise updates).
|
||||
- You can upgrade again later by selecting **Latest** and clicking **Update**.
|
||||
|
||||
---
|
||||
|
||||
## Updating
|
||||
|
||||
- The **Update** button appears when `latest_version` differs from your **installed version (ref)**.
|
||||
- Updates are also available via **Home Assistant → Settings → Updates** (native Update entity).
|
||||
- Clicking **Update** runs the same safe pipeline as **Install** (with backup).
|
||||
|
||||
**Tip:** Opening a repository detail view forces an immediate check for the latest version for that repo.
|
||||
|
||||
---
|
||||
|
||||
## Uninstalling
|
||||
|
||||
- Click **Uninstall** on the repository.
|
||||
- BCS removes the integration folders under `custom_components/<domain>`.
|
||||
- The installed state is cleared in the Store.
|
||||
- Restart Home Assistant if prompted.
|
||||
|
||||
---
|
||||
|
||||
## Backups & Restore
|
||||
|
||||
Before an update/install over existing files, BCS creates a backup:
|
||||
|
||||
```
|
||||
/config/.bcs_backups/<domain>/<timestamp>/
|
||||
```
|
||||
|
||||
**Restore**:
|
||||
1. Open the repository in store.
|
||||
2. Select **Restore…**.
|
||||
3. Pick one of the **last backups** (up to retention limit). (Version details are showed in ())
|
||||
4. Confirm – BCS restores files and reconciles installed version to the restored ref.
|
||||
5. Restart Home Assistant if prompted.
|
||||
|
||||
If the old backup lacks metadata, BCS best‑effort derives the installed version from the backup’s `manifest.json`, or marks the ref as `restored:<timestamp>` so updates remain possible.
|
||||
|
||||
---
|
||||
|
||||
## Custom Repositories
|
||||
|
||||
You can add any public repository (GitHub/GitLab/Gitea/Any other Git Hoster). BCS will attempt to detect:
|
||||
- provider & default branch
|
||||
- latest version (release/tag/atom)
|
||||
- repo metadata (prefer `bcs.yaml`, fallback `hacs.json/hacs.yaml`)
|
||||
- readme (common filenames)
|
||||
|
||||
**Add an custom repository**(typical flows):
|
||||
- From the Store UI
|
||||
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||
2. Go to tab "Manage"
|
||||
3. Add Repository URL (Example: ``https://git.bahmcloud.de/bahmcloud/bahmcloud_store``) and (optional) Name you want to show up (will be grabbed from GIT Repository)
|
||||
4. Repository show up in Custom Repositories-list and in "Store" Tab, if available
|
||||
|
||||
**Remove an custom repository**(typical flows):
|
||||
- From the Store UI
|
||||
1. If you start up Bahmcloud Store, you are on tab "Store"
|
||||
2. Go to tab "Manage"
|
||||
3. Your repository you want to remove (if its custom) show up in the list
|
||||
4. Press "Remove" Button to delete from Store (Attention: If you Remove installed Repository, you won´t be able to Uninstall from Store, you have to remove by your own (Delete Folder from ```config/custom_components/*```))
|
||||
|
||||
Custom repos get the **Custom** badge and can be filtered via **Source**.
|
||||
|
||||
---
|
||||
|
||||
## HACS Repositories
|
||||
|
||||
Enable the **HACS official** toggle to include official HACS integrations.
|
||||
|
||||
- BCS downloads the HACS integration list and maps **human‑readable names/descriptions** from HACS metadata.
|
||||
- HACS entries are **not** part of your BCS-Official Repositories (avoid duplicate entries).
|
||||
|
||||
With many HACS repos, metadata loads in the background; names/descriptions appear progressively and are cached.
|
||||
|
||||
---
|
||||
|
||||
## Update Entities in Home Assistant
|
||||
|
||||
BCS exposes update entities for installed repos:
|
||||
- Found under **Settings → Updates**
|
||||
- Clicking **Install** triggers BCS update pipeline
|
||||
- Shows **installed** and **latest** versions (BCS ref logic)
|
||||
|
||||
---
|
||||
|
||||
## Background Caching & Performance
|
||||
|
||||
- **Fast initial list**: index + local cache only
|
||||
- **Background enrichment**: provider info, latest version, metadata, description, readme (best effort)
|
||||
- **On‑demand**: opening a repo triggers immediate enrichment; data is **persisted** to cache
|
||||
- **Persistent cache**: survives HA restarts; speeds up subsequent runs
|
||||
- **Refresh**: immediately rechecks installed repos and key metadata
|
||||
|
||||
---
|
||||
|
||||
## Restart Required
|
||||
|
||||
After install, update, or restore, BCS raises a **Restart required** item in Home Assistant (Repairs). You can restart directly from there.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **New release but no update**: Open the repo detail once; ensure it’s a **release/tag** (commits alone don’t change the ref).
|
||||
- **Descriptions/Latest missing**: Wait for background enrichment or open the repo detail (forces enrichment). Cached afterwards.
|
||||
(You also can Install new version by selecting in Version tab)
|
||||
- **Slow startup**: BCS schedules heavy work after HA started. Keep indexes reasonable.
|
||||
|
||||
---
|
||||
|
||||
## FAQ
|
||||
|
||||
- **Backups path?** `/config/.bcs_backups/<domain>/<timestamp>/`
|
||||
- **Install path?** `/config/custom_components/<domain>`
|
||||
- **Downgrade?** Yes, pick an older version and install.
|
||||
- **Restart needed?** Yes, after install/update/restore.
|
||||
@@ -42,6 +42,9 @@ HACS_CACHE_TTL_SECONDS = 60 * 60 * 24 # 24h
|
||||
# - persists across restarts
|
||||
# - keeps UI populated (name/description/latest) without blocking startup
|
||||
REPO_CACHE_TTL_SECONDS = 6 * 60 * 60 # 6h
|
||||
# Release/tag lists change rarely and can be expensive for some providers (e.g. GitHub rate limits).
|
||||
# Cache them longer and refresh only on-demand (when the user opens the version selector).
|
||||
VERSIONS_CACHE_TTL_SECONDS = 7 * 24 * 60 * 60 # 7d
|
||||
|
||||
|
||||
class BCSError(Exception):
|
||||
@@ -572,6 +575,12 @@ class BCSCore:
|
||||
if isinstance(cached, dict):
|
||||
ts = int(cached.get("ts") or 0)
|
||||
|
||||
# Background enrichment should be a one-time best-effort pass.
|
||||
# If we already attempted it once for this repo, do not keep retrying on every refresh.
|
||||
# On-demand (opening repo details / version selector) can still refresh and persist.
|
||||
if bool(cached.get("bg_done")):
|
||||
return False
|
||||
|
||||
# Missing key fields -> enrich.
|
||||
if not r.latest_version:
|
||||
return True
|
||||
@@ -634,10 +643,20 @@ class BCSCore:
|
||||
await self._enrich_one_repo(r)
|
||||
except Exception:
|
||||
_LOGGER.debug("BCS background enrich failed for %s", repo_id, exc_info=True)
|
||||
# Mark as attempted so we don't keep hammering the provider.
|
||||
async with self._repo_cache_lock:
|
||||
cached = self._repo_cache.setdefault(str(repo_id), {})
|
||||
if isinstance(cached, dict):
|
||||
cached["bg_done"] = True
|
||||
cached["bg_done_ts"] = int(time.time())
|
||||
return
|
||||
|
||||
async with self._repo_cache_lock:
|
||||
self._update_repo_cache_from_repo(repo_id, r)
|
||||
cached = self._repo_cache.setdefault(str(repo_id), {})
|
||||
if isinstance(cached, dict):
|
||||
cached["bg_done"] = True
|
||||
cached["bg_done_ts"] = int(time.time())
|
||||
updated += 1
|
||||
|
||||
# Process sequentially but allow limited concurrency.
|
||||
@@ -792,7 +811,43 @@ class BCSCore:
|
||||
repo = self.get_repo(repo_id)
|
||||
if not repo:
|
||||
return []
|
||||
return await fetch_repo_versions(self.hass, repo.url)
|
||||
|
||||
# Prefer cached version lists to avoid hammering provider APIs (notably GitHub unauthenticated
|
||||
# rate limits). We refresh on-demand when the user opens the selector.
|
||||
cached = None
|
||||
cached_ts = 0
|
||||
async with self._repo_cache_lock:
|
||||
cached = self._repo_cache.get(str(repo_id)) if isinstance(self._repo_cache, dict) else None
|
||||
if isinstance(cached, dict):
|
||||
cached_ts = int(cached.get("versions_ts", 0) or 0)
|
||||
|
||||
now = int(time.time())
|
||||
if isinstance(cached, dict) and cached.get("versions") and (now - cached_ts) < VERSIONS_CACHE_TTL_SECONDS:
|
||||
return list(cached.get("versions") or [])
|
||||
|
||||
try:
|
||||
versions = await fetch_repo_versions(self.hass, repo.url)
|
||||
except Exception:
|
||||
versions = []
|
||||
|
||||
# If the provider fetch returned only the basic fallbacks ("Latest" + "Branch") but we have
|
||||
# a previously cached richer list, keep using the cached list.
|
||||
if (
|
||||
isinstance(cached, dict)
|
||||
and cached.get("versions")
|
||||
and len(list(cached.get("versions") or [])) > 2
|
||||
and len(versions) <= 2
|
||||
):
|
||||
return list(cached.get("versions") or [])
|
||||
|
||||
# Persist whatever we got (even if small) to avoid repeated calls when rate-limited.
|
||||
async with self._repo_cache_lock:
|
||||
entry = self._repo_cache.setdefault(str(repo_id), {}) if isinstance(self._repo_cache, dict) else {}
|
||||
if isinstance(entry, dict):
|
||||
entry["versions"] = versions
|
||||
entry["versions_ts"] = now
|
||||
await self._persist_repo_cache()
|
||||
return versions
|
||||
|
||||
def _add_cache_buster(self, url: str) -> str:
|
||||
parts = urlsplit(url)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"domain": "bahmcloud_store",
|
||||
"name": "Bahmcloud Store",
|
||||
"version": "0.6.7",
|
||||
"version": "0.6.8",
|
||||
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
||||
"platforms": ["update"],
|
||||
"requirements": [],
|
||||
|
||||
Reference in New Issue
Block a user