mirror of
https://github.com/sergi0g/cup.git
synced 2025-11-12 23:23:48 -05:00
docs: add page about home assistant integration
This commit is contained in:
BIN
docs/src/app/assets/ha-cup-component.png
Normal file
BIN
docs/src/app/assets/ha-cup-component.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
47
docs/src/content/docs/community-resources/home-assistant.mdx
Normal file
47
docs/src/content/docs/community-resources/home-assistant.mdx
Normal file
@@ -0,0 +1,47 @@
|
||||
import Image from "next/image";
|
||||
|
||||
import screenshot from "@/app/assets/ha-cup-component.png";
|
||||
|
||||
# Home Assistant integration
|
||||
|
||||
Many thanks to [@bastgau](https://github.com/bastgau) for creating this integration.
|
||||
|
||||
## About
|
||||
|
||||
The **HA Cup Component** integration for Home Assistant allows you to retrieve update statistics for Docker containers directly from your Home Assistant interface.
|
||||
|
||||
With this integration, you can easily track the status of your Docker containers and receive notifications when updates are available.
|
||||
|
||||
The following sensors are currently implemented:
|
||||
|
||||
<Image
|
||||
src={screenshot}
|
||||
alt="Screenshot of Home Assistant showing a card with update information provided by Cup"
|
||||
/>
|
||||
|
||||
## Installation
|
||||
|
||||
### Via HACS
|
||||
|
||||
1. Open Home Assistant and go to HACS
|
||||
2. Navigate to "Integrations" and click on "Add a custom repository".
|
||||
3. Use https://github.com/bastgau/ha-cup-component as the URL
|
||||
4. Search for "HA Cup Component" and install it.
|
||||
5. Restart Home Assistant.
|
||||
|
||||
### One-click install
|
||||
|
||||
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=bastgau&repository=ha-cup-component&category=Integration)
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Download the integration files from the GitHub repository.
|
||||
2. Place the integration folder in the custom_components directory of Home Assistant.
|
||||
3. Restart Home Assistant.
|
||||
|
||||
## Support & Contributions
|
||||
|
||||
If you encounter any issues or wish to contribute to improving this integration, feel free to open an issue or a pull request in the [GitHub repository](https://github.com/bastgau/ha-cup-component).
|
||||
|
||||
Support the author:
|
||||
[](https://www.buymeacoffee.com/bastgau)
|
||||
Reference in New Issue
Block a user