ioBroker.admin

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.

JSON config schema

The JSON config schema description can be found at JSON config schema.

Using common.localLink

%ip% - ioBroker ip address (address of the admin)
%secure% or %protocol% - read from native.secure the value and use http or https
%web_protocol% - looking for the first instance of web (e.g., web.0) and get native.secure from system.adapter.web.0
%instance% - instance of the adapter
%someField% - get someField from native of this adapter instance
%web.0_bind% - get native.bind from system.adapter.web.0
%native_someField% - get someField from native of this adapter instance

Scheduled restart

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.

Let's Encrypt Certificates

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.

Simple instance's settings page

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

Reverse proxy

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.

Example

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

OAuth2.0 Authentication flow

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&param=true&param2 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.

Used icons

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.

Todo

Add to wizard (very first page): how your statistics will be processed.
Add colors to menu item with the possibility to change turn it off or only icon

Changelog

WORK IN PROGRESS

(foxriver76) added a new tab to the installation wizard which recommends common adapters
(bluefox) applied newest adapter-react-v5 changes and types

6.15.2 (2024-03-07)

(foxriver76) fixed cron dialog

6.15.1 (2024-03-04)

(foxriver76) fixed problem with saving array values in custom config
(foxriver76) fixed issue on deleting objects
(foxriver76) make UI update of controller and admin more verbose

6.15.0 (2024-03-01)

(foxriver76) harmonized the links to adapter documentation (and fallback to english if no explicit doc for sys language provided)
(bluefox) added possibility to delete whole adapter from instance tab if only one instance left
(foxriver76) new dialog for notifications introduced for non-system notifications (system notifications are still on hosts tab)
(foxriver76) the new licenseInformation icon now changes color correctly with the theme

6.14.1 (2024-02-20)

(foxriver76) align items better when adapter tab is used in row mode

6.14.0 (2024-02-19)

(foxriver76) adapters tab is now showing information from licenseInformation
(foxriver76) show important notifications above changelog, so user reads them on update dialog

License

The MIT License (MIT)

ioBroker / ioBroker.admin