User interface for configuration and administration of ioBroker.
This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.
The JSON config schema description can be found at JSON config schema.
%ip%
- ioBroker ip address (address of the admin)%secure%
or%protocol%
- read fromnative.secure
the value and use http or https%web_protocol%
- looking for the first instance of web (e.g.,web.0
) and getnative.secure
fromsystem.adapter.web.0
%instance%
- instance of the adapter%someField%
- get someField fromnative
of this adapter instance%web.0_bind%
- getnative.bind
fromsystem.adapter.web.0
%native_someField%
- get someField fromnative
of this adapter instance
Some adapters are not stable or connection disappears after one or two days. To fix this, there is a scheduled restart setting. To activate scheduled restart, just define CRON condition when to restart adapter.
It is suggested to restart in the night, when no one use the adapter, e.g. 0 3 * * *
- at 3:00 every day.
To manage and update, let's encrypt certificates you need to use iobroker.acme
adapter.
You will have so-called "collections" of certificates. Each collection has its own domains. You can select in configuration of admin adapter if and which collection to use.
The user has the possibility to limit the access to the instance configuration dialog. For that, the option "Allow access only to specific instances" must be activated. It could be found on the "Access to the instances" tab. Additionally, the allowed instances should be selected in the appeared configuration table.
If this option is disabled, the simple configuration page could be accessed under http://IP:8081/configs.html
Please be sure that you forward not only the http/https requests, but the web-socket traffic too. It is essential for communication.
From version 6.1.0 you have the possibility to tune intro page for usage with reverse proxy.
Your ioBroker.admin
runs on port 8081 behind reverse proxy with domain iobroker.mydomain.com
under path /ioBrokerAdmin/
.
And you set up e.g., nginx to forward the requests to the http://local-iobroker.IP:8081
.
The same is with your web instance: https://iobroker.mydomain.com/ioBrokerWeb/ => http://local-iobroker.IP:8082
.
And with rest-api instance: https://iobroker.mydomain.com/ioBrokerAPI/ => http://local-iobroker.IP:8093
.
You can add the following lines into Reverse Proxy tab to let Intro tab run behind reverse proxy properly:
Global path | Instance | Instance path behind proxy |
---|---|---|
/ioBrokerAdmin/ |
web.0 |
/ioBrokerWeb/ |
rest-api.0 |
/ioBrokerAPI/ |
|
admin.0 |
/ioBrokerAdmin/ |
|
eventlist.0 |
/ioBrokerWeb/eventlist/ |
So all links of instances that use web server, like eventlist
, vis
, material
and so on will use https://iobroker.mydomain.com/ioBrokerWeb/
path
There is a possibility to use OAuth2.0 authentication for other services. Admin has an endpoint oauth2_callbacks
.
The calls like http(s)://ip:port/oauth2_callbacks/adapterName.X/?state=ABC&code=123¶m=true¶m2
will be processed and the special message oauth2Callback
will be sent to adapterName.X
instance with query parameters {"state": "ABC", "code": 123, "param": true, "param2": true}
.
As mandatory response the admin expects the object like: {"result": "Show this text to user by success", "error": "ERROR: Result will be ignored"}
. The result or error will be shown to the user. Please send already translated messages.
This project uses icons from Flaticon.
ioBroker GmbH has a valid license for all used icons. The icons may not be reused in other projects without the proper flaticon license or flaticon subscription.
- (bluefox) Showed min/max limits by controlling the values
- (bluefox) Corrected style for tabs
- (foxriver76) only automatically open the host notification dialog if warnings are available
- (foxriver76) improved style of host notification dialog
- (foxriver76) clarified auto upgrade options selection
- (bluefox) Corrected the link in instances, e.g., for vis-2
- (bluefox) Corrected the connection information in the instance tab
- (bluefox) Corrected installation of adapter with the license unequal to MIT
- (bluefox) Corrected width of a side menu
- (bluefox) Allowed the pasting into object JSON editor
- (bluefox) Corrected export from JSON table
- (foxriver76) added
qrCode
component to JSON config - (bluefox) Corrected adding of adapters with licenses (other than MIT)
- (bluefox) Improved license dialog
- (bluefox) Corrected the CRON description
- (bluefox) Corrected the Device Manager Component
The MIT License (MIT)
Copyright (c) 2014-2024 bluefox dogafox@gmail.com