https://github.com/vincentbernat/dashkiosk

Managing dashboards on various displays (especially those running on Android)
https://github.com/vincentbernat/dashkiosk

Last synced: 3 months ago
JSON representation

Managing dashboards on various displays (especially those running on Android)

• Host: GitHub
• URL: https://github.com/vincentbernat/dashkiosk
• Owner: vincentbernat
• License: other
• Archived: true
• Created: 2013-12-28T17:48:53.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-06-04T09:30:03.000Z (over 1 year ago)
• Last Synced: 2024-05-29T05:11:10.542Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 17.9 MB
• Stars: 360
• Watchers: 23
• Forks: 64
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
⚠ **This project is unmaintained**. Due to the rapid decay of the JavaScript

ecosystem, this project was too difficult for me to maintain. As of today,

*Dashkiosk* relies mostly on unmaintained library versions that may not build on

modern systems.

# Dashkiosk

![Build Status](https://github.com/vincentbernat/dashkiosk/workflows/Build/badge.svg)

Dashkiosk is a solution to manage dashboards on multiple screens. It

comes as four components:

 1. A _receiver_ runs in a browser attached to each screen and will

    display the requested dashboards. The receiver is quite dumb, it

    contacts the server and wait for it to tell which URL to display.

 2. A _server_ which will manage the screens by sending them what they

    should display. An administration interface allows the user to

    manage those screens individually or in a group.

    

 3. An _Android app_ that will run the receiver. This is mainly a

    fullscreen webview. There is also a _Firefox app_ fulfilling the

    same purpose.

 4. A _Chromecast custom receiver_ which will run the regular receiver

    if you want to display dashboards using Google Chromecast devices.

The full documentation is available on [ReadTheDocs][].

[ReadTheDocs]: https://dashkiosk.readthedocs.io

A live installation, reset every hour, is publicly available:

 - [administration panel](https://dashkiosk-demo.herokuapp.com/admin)

 - [receiver](http://dashkiosk-demo.herokuapp.com/receiver)

Here is a demonstration video:

[![Dashkiosk demo](https://img.youtube.com/vi/Vb4BvEzoYOU/0.jpg)](https://www.youtube.com/watch?v=Vb4BvEzoYOU "Dashkiosk demo")

# Development

To run the server for development:

    $ grunt serve

# Android receiver

The Android receiver has moved to its

[own repository](https://github.com/vincentbernat/dashkiosk-android).

# Chromecast receiver

The "official" Chromecast receiver has app ID `5E7A2C2C` and is hosted

in the `gh-pages` branch of this repository. To update it:

    $ grunt dist

    $ git worktree add ~/src/dashkiosk-gh-pages gh-pages

    $ cd ~/src/dashkiosk-gh-pages

    $ git rm -r *

    $ rsync -rv --include '*chromecast*' --include '*/' --exclude '*' ~-dashkiosk/dist/public/* .

    $ git add *

    $ git commit -m "Update"

# Docker

There is a `Dockerfile` to run *Dashkiosk* inside Docker. This will

also work with Chromecast devices if your Docker host supports the

`--net=host` option:

    $ docker run --net=host \

                 -v /var/lib/dashkiosk/database:/database \

                 -e "chromecast__enabled=1" \

                 -e "chromecast__receiver=http://:8081/receiver" \

                 -e "port=8081" \

                 ghcr.io/vincentbernat/dashkiosk:latest

To start without Chromecast support, simply run:

    $ docker run -d -p 8080:8080 \

                 -v /var/lib/dashkiosk/database:/database \

                 ghcr.io/vincentbernat/dashkiosk:latest

Using `latest` can be broken from time to time. You may prefer a

stable tag, like `2.7.9` or `2.7`.