Bildschirm

Opinionated JavaScript framework for building real-time dashboards

Project Homepage  |  Docs

I'm planning to release v1.0.0 sometime in Q2 2022, however during 0.x.x the API is considered unstable and might change unannounced.

Beginning a real-time web project, like building your own home dashboard, can be a tedious and time-consuming process. Coding lots of boilerplate for authentication, authorization and data communication isn’t fun at all. By the time you get to building the thing you wanted you got bored and moved on to the next. Bildschirm aims to provide all those features out-of-the-box so you can get to creating what matters right away.

Features

• Real-time state sync between server and client (service-based API)
• Plugin API for creating your own services
• Role-based permission API
• Built-in User Management
• HTTP & WebSocket Transports
• Usecases:
  • Home Automation UIs / dashboards
  • Analytics dashboard combining different data sources
• Available plugins for:
  • HomeKit light control
  • Spotify player
  • YouTube downloader (youtube-dl integration)
  • Filebrowser
  • etc.
• Kinda pretty UI (at least I like it... you decide or build your own!)

Installation

$ npm install -g bildschirm

Usage

You can now start the server like you would any binary.

$ bildschirm --version
v2.0.0-rc8

Options

Usage: bildschirm [options]

Options:
  -V, --version       output the version number
  -u, --url <url>     the url Bildschirm is reachable at
  -p, --port <port>   the port to use for Bildschirm
  -h, --help          display help for command

Config

A config file for bildschirm will be created at $HOME_DIR/.bildschirm/config. This can also be used to configure bildschirm. However, options passed as command line arguments override settings in this file.

Screenshots

Changelog

Version 0.3.0

• Completely redesigned dashboard UI
• Introduction of a flexible plugin system
• Authentication is now handled by Bildschirm itself, single-sign-on is no longer required
• Users now have profiles, which will be integrated with a solid permission system
• Tons of bug fixes

Version 0.2.4

• Rewrote logging system

Version 0.2.3

• Added COVID widget to dashboard

Version 0.2.2

• Fixed bahn algorithm skipping not displaying trains with SEV present

Version 0.2.1

• Fixed dashboard layout now being loaded from database correctly

Version 0.2.0

• New Dashboard is now customizeable

Version 0.1.2

• Fixes error preventing the auth proxy from returning properly

Version 0.1.1

• Fixes some minor security issues with dependencies

Version 0.1.0

• The SSO server is now being proxied by default. This can be disabled with the --no-proxy option or by disabling it in the config file.
• Instead of localhost, the default url is now the local ip

FAQ

Running Bildschirm on port 80

On Linux, running an http server on port 80 requires root priviliges. Generally this isn't a problem as you can simply sudo bildschirm -p 80 which works, but this approach falls apart when using systemd.

I found this workaround which seems to be the safest option to use instead:

sudo apt-get install libcap2-bin
sudo setcap 'cap_net_bind_service=+ep' /usr/bin/node # Replace path to node binary

Notes about internal package updating

• public-ip kept at 4.0.4 until we move to ESM
• internal-ip kept at 6.1.0 until we move to ESM
• auto-bind kept at 4.0.0 until we move to ESM
• on-change kept at 3.0.2 until we move to ESM
• passport kept at 0.4 until we're sure, JWT-based caddy login still works

Packages by internal plugins

• db-hafas: bahn
• internal-ip and public-ip: system-info
• @oznu/hap-client: homebridge

Authors

Lukas Mateffy – @Capevace – mateffy.me

Distributed under the MIT license. See LICENSE for more information.

Contributing

1. Fork it (https://github.com/capevace/bildschirm/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request