!Logo

ioBroker.web

!Number of Installations
!Number of Installations

!Test and Release

Web server on the base of Node.js and express to read the files from ioBroker DB.

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.

Tuning Web-Sockets

On some web-sockets clients, there is a performance problem with communication.
Sometimes this issue is due to the fallback of socket.io communication on a long polling mechanism.
You can set the option Force Web-Sockets to force using only web-sockets transport.

Let's Encrypt Certificates

Read here

Extensions

Web driver supports extensions.
The extension is URL handler, that will be called if such URL request appears.
The extensions look like the normal adapter, but they have no running process
and will be called by web server.

E.g., the user can activate a special proxy adapter and reach other devices (like webcams) in the same web server.
It is required to let all services be available under one web server.

Web extension could and should support unload function, that could return promise if the unload action will take some time.

You can read more about web-extensions here.

Brute-force protection

If authentication is enabled and the user enters 5 times invalid password during one minute, he must wait at least one minute till next attempt.
After the 15th wrong attempt, the user must wait 1 hour.

"Stay logged in" option

If this options is selected, the user stays logged in for one month.
If not, the user will stay logged in for the configured "login timeout".

Access state's values

You can access the normal state values via the HTTP get request.

``
http://IP:8082/state/system.adapter.web.0.alive =>
{"val":true,"ack":true,"ts":1606831924559,"q":0,"from":"system.adapter.web.0","lc":1606777539894}
`

or access files like:

`
http://IP:8082/vis-2.0/javascript.picture.png =>
[IMAGE]
`

"Basic Authentication" option


Allows Login via Basic Authentication by sending 401 Unauthorized with a WWW-Authenticate header.
This can be used for applications like FullyBrowser. When entering the wrong credentials once, you will be redirected
to the Login Page.

User list

You can define the list of users that can access the web server. You can change the access right for logged-in user.

If the user is not in the list, he cannot access the web server.

It is simpler as to set for every object and every state the access rights for the specific user.

Advanced options

$3

If by opening of web port im browser no APP selection should be shown, but some specific application,
the path could be provided here (e.g. /vis/) so this path will be opened automatically.

OAuth2 authentication

The web adapter supports OAuth2 authentication.

To get the tokens, the user must call the URL:

`
http://ip:8082//oauth/token?grant_type=password&username=&password=&client_id=ioBroker&stayloggedin=
`

stayloggedin=true means that the token will be stored in the browser and will be used for the next requests and is optional.

The answer is like:
`json
{
"access_token": "21f89e3eee32d3af08a71c1cc44ec72e0e3014a9",
"expires_in": "2025-02-23T11:39:32.208Z",
"refresh_token": "66d35faa5d53ca8242cfe57367210e76b7ffded7",
"refresh_token_expires_in": "2025-03-25T10:39:32.208Z",
"token_type": "Bearer"
}
`
More info could be found here: https://github.com/ioBroker/webserver?tab=readme-ov-file#oauth2-support

Changelog

$3

* (@GermanBluefox) Corrected the loading of the material adapter

$3

* (@GermanBluefox) Added settings for custom CORS headers
* (@GermanBluefox) Added the possibility to show admin instances on the web welcome page
* (@GermanBluefox) Implemented the new index page

$3

* (@GermanBluefox) Trying to catch an error by the web extension

$3

* (@GermanBluefox) Corrected the login for iobroker.visu app
* (@GermanBluefox) Corrected load of TypeScript Web extensions

$3

* (@GermanBluefox) Corrected the login page
* (@GermanBluefox) Removed the frequent debug output

$3

* (@GermanBluefox) Corrected the problem with the user rights

$3

* (@GermanBluefox) [Breaking change] Removed simple-api as it could be connected as web-extension
* (@GermanBluefox) updated packages
* (@GermanBluefox) removed gulp in a build process
* (@GermanBluefox) Migrated GUI to vite
* (@GermanBluefox) Rewritten in TypeScript
* (@GermanBluefox) Added OAuth2 support
* (@GermanBluefox) Added new 404 and the directory list pages

$3

* (@foxriver76) added new admin icon (svg)

$3

* (bluefox) Corrected call of getObjectView with null parameter
* (bluefox) updated packages
* (bluefox) GUI was migrated to a non-style framework

$3

* (bluefox) Preparations for a custom loading background
* (bluefox) updated packages

$3

* (bluefox) Just some packages were updates

$3

* (klein0r) Extensions may block the web instance
* (klein0r) Fixed directory listing

$3

* (foxriver76) updated the websocket library to increase the maximum file size from 100 MB to 500 MB

$3

* (joltcoke) Corrected the crash if authentication is enabled

$3

* (bluefox) Added the user access list option

$3

* (bluefox) Corrected the start screen

$3

* (bluefox) Added the public accessibility check

$3

* (bluefox) Corrected adapter termination if the alias has no target
* (bluefox) Corrected socket.io connection

$3

* (foxriver76) upgrade socketio and ws dependencies to fix a vis subscribe problem

$3

* (bluefox) upgraded socketio and ws dependencies to correct the error by unsubscribing on client disconnect

$3

* (foxriver76) upgraded socketio and ws dependencies

$3

* (mcm1957) Added missing node16 requirement

$3

* (bluefox) Added the subscribing on the specific instance messages

$3

* (bluefox) Updated packages
* (bluefox) Implemented the possibility to view folder content

$3

* (bluefox) Removed letsencrypt handling from web adapter

$3

* (bluefox) Increased max size of the uploaded file via socket.io to 200MB (from 10MB)

$3

* (bluefox) Allowed deletion of fullcalendar objects

$3

* (bluefox) Allowed reading projects of vis-2-beta

$3

* (bluefox) Added special end-points for app authentication

$3

* (bluefox) Corrected error with publishFileAll` (for future use)

$3

* (bluefox) Corrected GUI error

$3

* (bluefox) Used a new version of socket classes

License

The MIT License (MIT)

Copyright (c) 2014-2025 Bluefox

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.