mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-24 13:36:29 +01:00
67 lines
3.1 KiB
Markdown
67 lines
3.1 KiB
Markdown
# Home assistant add-on: Joal
|
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
|
|
![Supports
|
|
Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
|
|
|
|
## About
|
|
|
|
An open source command line RatioMaster with WebUI.
|
|
This addon is based on the [docker image](https://hub.docker.com/r/anthonyraymond/joal) from Anthony Raymond.
|
|
All credits for the app go to Anthony Raymond, please visit his repository here : https://github.com/anthonyraymond/joal
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.
|
|
|
|
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Make sure that the two ports are open on your router
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
|
|
|
|
## Configuration
|
|
|
|
You'll need to open the options and encode the secret token lrMY24Byhx (or modify it)
|
|
```yaml
|
|
secret_token: lrMY24Byhx #you can encode your own token here that will be used to identify in the app
|
|
ui_path: joal #the path where Joal will be accessible
|
|
run_duration: 12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...)
|
|
```
|
|
|
|
Methods of connection:
|
|
1. Via ingress (accessible from within the app)
|
|
``` yaml
|
|
Address : until I make it automatic, you need to get the Ingress URL from the addon log. #Example from my config : `192.168.178.69:8123/api/hassio_ingress/POVP6iOh67KUz_LQQJg4lOC-DJi7FNXutaz_7kNiFWM/`
|
|
Port : your HA port #usually 8123)
|
|
Prefix : defined in "ui_path" addon options #_(default : joal)_
|
|
Secret token : defined in "secret_token" addon options #_(default : lrMY24Byhx)_
|
|
```
|
|
|
|
2. From the local network, by accessing directly accessing the url ("joal" must be replaced by whatever your "ui_path" is set to in the addon options): `http://homeassistant.local:8081/joal/ui`
|
|
``` yaml
|
|
Address : homeassistant.local #_(or your direct url, or your external url if you have opened the port on your router)_
|
|
Port : defined in addon options #_(default : 8081)_
|
|
Prefix : defined in "ui_path" addon options #_(default : joal)_
|
|
Secret token : defined in "secret_token" addon options #_(default : lrMY24Byhx)_
|
|
```
|
|
|
|
## Support
|
|
For HA : create an issue on github
|
|
For Joal : see the upstream repo here https://github.com/anthonyraymond/joal
|
|
|
|
## Illustration
|
|
|
|
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
|
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
|
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|