Skip to content
Webian Shell Kiosk - A graphical shell for the web (kiosk version)
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
chrome
services
snap
.gitignore
LICENSE
README.md
chrome.js
main.js
package-lock.json
package.json
services.js

README.md

Webian Shell Kiosk

A graphical shell for the web (kiosk version).

This application is for interactive kiosks and digital signage which can be remotely controlled over the Internet.

It acts as both a web client and a web server in order to render web content and expose system services via the Web of Things.

Getting Started

To get started hacking on Webian Shell Kiosk first make sure that you have Git, NodeJS and NPM installed.

Then simply clone the Shell Kiosk repository from GitHub and run it.

$ git clone https://github.com/webianproject/shell-kiosk.git
$ cd shell-kiosk
$ npm install
$ npm start

The kiosk client should then start up full screen and the remote web interface should be running at http://localhost:8080

The web client uses Electron and the web server uses NodeJS.

Install on Ubuntu Core

$ sudo snap install --edge webian-shell-kiosk  
$ sudo snap connect webian-shell-kiosk:browser-sandbox :browser-support
$ sudo snap connect webian-shell-kiosk:x11-plug webian-shell-kiosk:x11
$ sudo snap restart webian-shell-kiosk

Copyrights, Trademarks and Licensing

© Ben Francis 2019

Webian is not affiliated with Firefox which is a registered trademark of the Mozilla Foundation, or Debian which is a registered trademark of SPI.

Webian Shell Kiosk is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Webian Shell Kiosk is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Webian Shell Kiosk in the LICENSE file. If not, see http://www.gnu.org/licenses/.

You can’t perform that action at this time.