https://github.com/elcritch/wpe_kiosk
Simple Wrapper to run WebKit Embedded in Kiosk mode
https://github.com/elcritch/wpe_kiosk
Last synced: 5 months ago
JSON representation
Simple Wrapper to run WebKit Embedded in Kiosk mode
- Host: GitHub
- URL: https://github.com/elcritch/wpe_kiosk
- Owner: elcritch
- License: apache-2.0
- Created: 2019-07-02T16:32:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-02T23:48:14.000Z (over 6 years ago)
- Last Synced: 2025-05-02T06:50:33.701Z (5 months ago)
- Language: Elixir
- Size: 21.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WpeKiosk
Simple wrapper around [Cog](https://github.com/Igalia/cog) which is a [WPE](https://webkit.org/wpe/) launcher and webapp container. Runs a fullscreen kiosk-style brwoser with hardware GPU acceleration and multimedia extensions. WebGL works.
```elixir
opts = %WpeKiosk.Options{
cog_bin_path: nil,
homepage: "https://akirodic.com/p/jellyfish/",
init_udev_inputs: true,
startup_delay_ms: 0,
udev_init_delay_ms: 0,
use_cursor: false,
use_touch: true
}
pid = WpeKiosk.start_link(opts)
```
## Limitations
Currently only the bare minimum configuration for Cog is supported. This means the browser can _only_ be run fullscreen.
For example, to browse to a new url you need to stop WpeKiosk pid, and then restart it with a new homepage. For kiosks this shouldn't bee an issue.
## Installation
```elixir
def deps do
[
{:wpe_kiosk, "~> 0.1.0"}
]
end
```
Important! Must use a base image that provides WPE with Cog. A customized Nerves image [wpe_kiosk_rpi3](https://github.com/elcritch/wpe_kiosk_rpi3/) is avialble for the RPi3 which provides cog and can run with out-of-the-box with the official RPi touchscreens.
## Acknowledgements
Modeled on the [webengine_kiosk](https://github.com/fhunleth/webengine_kiosk) by fhunleth.