mirror of
https://github.com/danieldemus/openhab-core.git
synced 2025-01-13 06:31:01 +01:00
ef8d0df10b
* Added dashboard support for links to external services. Signed-off-by: Pauli Anttila <pauli.anttila@gmail.com>
35 lines
1.8 KiB
Markdown
35 lines
1.8 KiB
Markdown
# Dashboard
|
|
|
|
The openHAB dashboard is a landing page for the user where all openHAB UIs can be found.
|
|
Dashboard support also links to external services.
|
|
Links can be added to the dashboard by editing the `conf/services/dashboard.cfg` configuration file.
|
|
|
|
## Link Configuration
|
|
|
|
| Parameter name | Type | Description |
|
|
|-----------------------------|---------|-----------------------------------------------------------------------------------------|
|
|
| <unique-name>.link-name | String | Name which is shown in the openHAB dashboard. |
|
|
| <unique-name>.link-url | String | URL to external service. |
|
|
| <unique-name>.link-imageurl | String | URL to image which is shown in the dashboard. |
|
|
|
|
Where `<unique-name>` is link unique identifier (see examples).
|
|
|
|
## Image URL
|
|
|
|
Browser fetch image from image URL. URL can be direct http link or data URIs according to [RFC2397](https://tools.ietf.org/html/rfc2397). If data URIs are used, browser should support them as well. All five major browsers (Chrome, Firefox, IE, Opera and Safari) support data URIs. See e.g. [https://www.base64-image.de](https://www.base64-image.de) to convert images to base64 coded data.
|
|
|
|
## Example configuration file
|
|
|
|
```
|
|
frontail.link-name=openHAB Log Viewer
|
|
frontail.link-url=http://<server-adddress>:9001
|
|
frontail.link-imageurl=../static/image.png
|
|
|
|
nodered.link-name=Node-RED
|
|
nodered.link-url=http://<server-adddress>:1880
|
|
nodered.link-imageurl=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAXwAAACfCAIAAA...QmCC
|
|
|
|
```
|
|
|
|
Note: **nodered** image data URL is not valid (it's shorten for the sake of clarity).
|