Add and apply prettier pre-commit hook

This commit is contained in:
Max Winterstein
2021-09-18 22:12:17 +02:00
parent 50c2e44b7f
commit 2b6ff89517
23 changed files with 197 additions and 147 deletions

View File

@@ -1,28 +1,36 @@
# Changelog
## [0.8.0] - 2021-02-26
- Introduce `eval` configuration option (see *Documentation* for more)
- Introduce `eval` configuration option (see _Documentation_ for more)
## [0.7.0] - 2021-02-13
- Added some more ports to be possibly exposed
- Added some more ports to be possibly exposed
## [0.6.0] - 2021-02-12
- Use Pre-build containers (no more unused docker images, yay).
**🚨 !!Important Update Notice!! 🚨**
The Update progress might fail when the installed version is <1.4.0.
Copy your *Configuration* to your clipboard and Uninstall/Install manually.
Copy your _Configuration_ to your clipboard and Uninstall/Install manually.
## [0.5.0] - 2021-01-04
- Fix two superflous warnings
## [0.4.0] - 2020-12-30
- Change from sha image tag to v5.1.0
## [0.3.0] - 2020-12-30
- Added some ports for free use (e.g. `simple api`)
## [0.2.0] - 2020-12-30
- Fix permission bug in dockerfile
## [0.1.0] - 2020-12-30
- Initial release

View File

@@ -1,6 +1,7 @@
# Home Assistant Add-on: ioBroker
## Installation
After installation, and successful startup, the ioBroker instance should be available at port `8081`.
If your HA instance is running with SSL support, the `OPEN WEB UI` button might not work correctly.
@@ -8,12 +9,14 @@ If your HA instance is running with SSL support, the `OPEN WEB UI` button might
It might be up and running while the `Info` tab is not aware of this right now. Page reload might help.
## Updating `js-controller`
The bundled `js-controller` is not (always) the most recent version. (Thanks to *tintim* [#21](1)).
Updating can be archived manually via `portainer` or by using the [`eval` setting](#eval-(string)).
The bundled `js-controller` is not (always) the most recent version. (Thanks to _tintim_ [#21](1)).
Updating can be archived manually via `portainer` or by using the [`eval` setting](<#eval-(string)>).
Manually:
Jump into the container via `portainer` and run line by line:
```bash
maintenance on
iobroker update
@@ -21,31 +24,35 @@ iobroker upgrade self
curl -sL https://iobroker.net/fix.sh | bash
```
## Configuration
### `eval` (string)
Allows to pass some bash commands to run every time before the start of ioBroker.
This can be used e.g. to upgrade the `js-controller`.
Example:
```yaml
eval: "iobroker update && iobroker upgrade self"
```
You might want to disable this after a run.
*Only use when you know what you are doing!*
_Only use when you know what you are doing!_
## TODO
* Get the panel integration working (if this is possible)
* Use some official base image (maybe running the buanet dockerfile onto office image work)
- Get the panel integration working (if this is possible)
- Use some official base image (maybe running the buanet dockerfile onto office image work)
## Technical notes
The `buanet` docker image contains some pretty useful startup script.
To ensure data stays persistent across restarts I simply softlink `/data` to `/opt/iobroker`.
I removed some check that was not compatible with the symlink and not needed in our case.
I added the unmodified version as a reference.
[1]: https://github.com/MaxWinterstein/homeassistant-addons/issues/21
[1]: https://github.com/MaxWinterstein/homeassistant-addons/issues/21

View File

@@ -1,8 +1,9 @@
### 🚨 Important Information 🚨
* This addon recently switched to pre-build images. The Update progress might fail when the installed version is <0.6.0.
Copy your *Configuration* to your clipboard and Uninstall/Install manually.
* I do not guarantee that your ioBroker configuration will not get deleted! This is some experimental release!
- This addon recently switched to pre-build images. The Update progress might fail when the installed version is <0.6.0.
Copy your _Configuration_ to your clipboard and Uninstall/Install manually.
- I do not guarantee that your ioBroker configuration will not get deleted! This is some experimental release!
---
# Home Assistant Add-on: ioBroker
@@ -15,12 +16,11 @@
<a href="https://www.buymeacoffee.com/MaxWinterstein" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
This is a pretty basic implementation of ioBroker as Home Assistant Add-on.
This is a pretty basic implementation of ioBroker as Home Assistant Add-on.
It is meant to provide some playground.
Mostly created as playfield for: https://blog.fuzzymistborn.com/controlling-eufy-security-devices-with-iobroker/
and https://community.home-assistant.io/t/eufy-camera-integration/121758
and https://community.home-assistant.io/t/eufy-camera-integration/121758
See the Documentation (DOCS.md) for more info.

View File

@@ -1,7 +1,7 @@
{
"build_from": {
"aarch64": "buanet/iobroker:v5.1.0-aarch64",
"amd64": "buanet/iobroker:v5.1.0-amd64",
"armv7": "buanet/iobroker:v5.1.0-armv7hf"
}
}
"build_from": {
"aarch64": "buanet/iobroker:v5.1.0-aarch64",
"amd64": "buanet/iobroker:v5.1.0-amd64",
"armv7": "buanet/iobroker:v5.1.0-armv7hf"
}
}

View File

@@ -1,46 +1,46 @@
{
"name": "ioBroker",
"version": "0.8.0",
"image": "maxwinterstein/homeassistant-addon-iobroker-{arch}",
"webui": "http://[HOST]:[PORT:8081]/",
"slug": "iobroker",
"description": "Open source automation platform",
"ingress": false,
"ingress_port": 8081,
"panel_icon": "mdi:iobroker",
"arch": ["armv7", "aarch64", "amd64"],
"startup": "application",
"boot": "auto",
"options": {
"eval" : ""
},
"schema": {
"eval" : "str?"
},
"ports": {
"8081/tcp": 8081,
"8082/tcp": null,
"8083/tcp": null,
"8084/tcp": null,
"8085/tcp": null,
"8086/tcp": null,
"8087/tcp": null,
"8088/tcp": null,
"8089/tcp": null
},
"ports_description": {
"8081/tcp": "Admin interface",
"8082/tcp": "reserved for addition addons",
"8083/tcp": "reserved for addition addons",
"8084/tcp": "reserved for addition addons",
"8085/tcp": "reserved for addition addons",
"8086/tcp": "reserved for addition addons",
"8087/tcp": "reserved for addition addons",
"8088/tcp": "reserved for addition addons",
"8089/tcp": "reserved for addition addons"
},
"stage": "experimental",
"url": "https://github.com/MaxWinterstein/homeassistant-addons/",
"hassio_role": "default",
"hassio_api": true
}
"name": "ioBroker",
"version": "0.8.0",
"image": "maxwinterstein/homeassistant-addon-iobroker-{arch}",
"webui": "http://[HOST]:[PORT:8081]/",
"slug": "iobroker",
"description": "Open source automation platform",
"ingress": false,
"ingress_port": 8081,
"panel_icon": "mdi:iobroker",
"arch": ["armv7", "aarch64", "amd64"],
"startup": "application",
"boot": "auto",
"options": {
"eval": ""
},
"schema": {
"eval": "str?"
},
"ports": {
"8081/tcp": 8081,
"8082/tcp": null,
"8083/tcp": null,
"8084/tcp": null,
"8085/tcp": null,
"8086/tcp": null,
"8087/tcp": null,
"8088/tcp": null,
"8089/tcp": null
},
"ports_description": {
"8081/tcp": "Admin interface",
"8082/tcp": "reserved for addition addons",
"8083/tcp": "reserved for addition addons",
"8084/tcp": "reserved for addition addons",
"8085/tcp": "reserved for addition addons",
"8086/tcp": "reserved for addition addons",
"8087/tcp": "reserved for addition addons",
"8088/tcp": "reserved for addition addons",
"8089/tcp": "reserved for addition addons"
},
"stage": "experimental",
"url": "https://github.com/MaxWinterstein/homeassistant-addons/",
"hassio_role": "default",
"hassio_api": true
}