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.

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:

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.

Changelog

WORK IN PROGRESS

• (foxriver76) show info, if server time differs from client time
• (foxriver76) remove confusion with different names for state (datapoint and state)
• (jogibear9988) fixed link on 404-page being opened inside child view
• (foxriver76) fixed issue if non-text default values are provided to a text jsonConfig component
• (foxriver76) implemented del key shortcut to delete a selected object

6.9.1 (2023-08-22)

• (foxriver76) allow resizing of all columns in objects tab
• (foxriver76) without expert mode users are only allowed to edit objects in 0_userdata.0 and alias.0 namespace
• (foxriver76) fixed keyboard navigation
• (foxriver76) fixed problem with showing controller upgrade instructions if no UI upgrade is supported

6.9.0 (2023-08-21)

• (bluefox) Added possibility to change log direction
• (bluefox) JSON config: Added possibility to filter out internal IP addresses
• (bluefox) JSON config: Added _changed flag for formula in JSON config
• (bluefox) JSON config: Added option reloadBrowser to sendto in JSON config
• (bluefox) JSON config: Allowed positioning of add button on the very top of the table
• (bluefox) JSON config: Trim strings by saving and not by typing
• (bluefox) Added alias creation from object browser
• (bluefox) Allowed to change chart type
• (foxriver76) show a date picker when setting state (role: date/type: number)
• (foxriver76) fixed problem, that creation of folders was not possible
• (foxriver76) adapted text to clarify, that only tarball can be installed from path
• (foxriver76) type string/role date will now also be previewed as a date in objects tab
• (foxriver76) fixed problem with table formatting on history data point viewer
• (foxriver76) fixed problem that could render update dialog with invalid property
• (foxriver76) fixed sentry icon being in wrong position if no compact flag provided

6.8.3 (2023-08-16)

• (foxriver76) added description to adapter rating dialog
• (bluefox) Extended the select component with grouping
• (bluefox) Allowed the sorting of adapters by name and not only by title
• (bluefox) Allowed the set state JSON config component

6.8.0 (2023-08-14)

• (foxriver76) try to find the correct IP for the controller UI multihost slave upgrade
• (foxriver76) admin is now showing update information, while it is stopped during upgrade
• (foxriver76) required Node.js version is 16 as 14 is End-Of-Life
• (foxriver76) fixed downloading folders recursive

6.7.2 (2023-08-09)

• (foxriver76) remove https certificate options
• (foxriver76) prevent error log of not used certificates even-though they are used
• (foxriver76) fixed issue with docker host cards on intro tab
• (foxriver76) fixed issue if adapter readme is opened in new tab
• (bluefox) corrected opening of custom tabs, e.g., for fullcalendar
• (bluefox) allowed downloading of recursive folders

License

The MIT License (MIT)

Copyright (c) 2014-2023 bluefox [email protected]