mirror of
https://github.com/YunoHost-Apps/zwave-js-ui_ynh.git
synced 2024-09-03 18:06:00 +02:00
65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Zwave-JS-UI for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/zwave-js-ui)  
|
|
[](https://install-app.yunohost.org/?app=zwave-js-ui)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Zwave-JS-UI quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
*** !! WORK IN PROGRESS !! - DO NOT INSTALL YET ***
|
|
|
|
### Features
|
|
|
|
Aims to integrate zwave-js-ui natively in Domoticz_ynh
|
|
|
|
**Shipped version:** 8.4.1~ynh1
|
|
## Disclaimers / important information
|
|
|
|
|
|
|
|
*** !! WORK IN PROGRESS !! - DO NOT INSTALL YET ***
|
|
|
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
|
* requiring a full dedicated domain => Due to the fact that is is compiled with the path and I don't want to recompile it each time
|
|
* architectures not supported ?
|
|
* not-working single-sign on or LDAP integration ?
|
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
|
* etc...
|
|
|
|
* Other infos that people should be aware of, such as:
|
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
|
* how to configure / administrate the application if it ain't obvious
|
|
* upgrade process / specificities / things to be aware of ?
|
|
* security considerations ?
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://zwave-js.github.io/zwave-js-ui/#/>
|
|
* Official user documentation: <https://www.domoticz.com/wiki/Zwave-JS-UI>
|
|
* Official admin documentation: <https://zwave-js.github.io/zwave-js-ui/#/>
|
|
* Upstream app code repository: <https://github.com/zwave-js/zwave-js-ui>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_zwave-js-ui>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/zwave-js-ui_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade zwave-js-ui -u https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|