Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# Installation
As this repository is not yet added in the default HACS repository you have to add the repository beforehand.

1. Go to the HACS Tab
2. Click on the three dot menu in the top right and select Custom repositories
3. Add ```https://github.com/Ronjar/beszel-ha```
4. Restart HomeAssistant
5. Go to integrations, press Add integration and search for BeszelAPI
6. In the Setup Dialog use the following values
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Ronjar&repository=beszel-ha&category=integration)

1. Install the Beszel API addon via HACS from the link above or by searching for it inside of HACS
2. Restart HomeAssistant
3. Go to integrations, press Add integration and search for BeszelAPI
4. In the Setup Dialog use the following values
- *URL*: The root url / IP of your Beszel instance, like http://beszel.example.com or https://beszel.example.com
- *user*: Either your default admin username / email or (recommended) create another user with the role user and assigning the agents you want to expose to it.
- *password*: The password to the user
7. The API will pull the data and reload every 2 minutes
5. The API will pull the data and reload every 2 minutes

Currently all machines are added, selection will be added later (you can change this yourself by creating a new user in Beszels Pocketbas and adding this user only to the machines you want to be monitored).
Currently all machines are added, selection will be added later (you can change this yourself by creating a new user in Beszel's PocketBase and adding this user only to the machines you want to be monitored).

# Usage
After installing the following entities will exposed as sensors (more to come):
Expand Down