Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Hjdskes/cage
A Wayland kiosk
https://github.com/Hjdskes/cage
compositor kiosk wayland
Last synced: about 2 months ago
JSON representation
A Wayland kiosk
- Host: GitHub
- URL: https://github.com/Hjdskes/cage
- Owner: cage-kiosk
- License: mit
- Created: 2018-11-22T18:58:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T09:46:53.000Z (6 months ago)
- Last Synced: 2024-04-13T13:06:38.987Z (5 months ago)
- Topics: compositor, kiosk, wayland
- Language: C
- Homepage: https://www.hjdskes.nl/projects/cage
- Size: 367 KB
- Stars: 956
- Watchers: 22
- Forks: 67
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotic-tooling - cage - This is Cage, a Wayland kiosk. A kiosk runs a single, maximized application. (User Interaction / Graphical User Interface)
- awesome-robotic-tooling - cage - This is Cage, a Wayland kiosk. A kiosk runs a single, maximized application. (Interaction / Graphical User Interface)
README
# Cage: a Wayland kiosk
This is Cage, a Wayland kiosk. A kiosk runs a single, maximized
application.
This README is only relevant for development resources and instructions. For a
description of Cage and installation instructions for end-users, please see
[its project page](https://www.hjdskes.nl/projects/cage) and [the
Wiki](https://github.com/cage-kiosk/cage/wiki/).
## Release signatures
Releases up to version 0.1.4 are signed with [6EBC43B1](http://keys.gnupg.net/pks/lookup?op=vindex&fingerprint=on&search=0x37C445296EBC43B1). Releases from 0.1.5 onwards are signed with
[E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48)
All releases are published on [GitHub](https://github.com/cage-kiosk/cage/releases).
## Building and running Cage
You can build Cage with the [meson](https://mesonbuild.com/) build system. It
requires wayland, wlroots, and xkbcommon to be installed. Optionally, install
scdoc for manual pages. Note that Cage is developed against the latest tag of
wlroots, in order to not constantly chase breaking changes as soon as they
occur.
Simply execute the following steps to build Cage:
```
$ meson build
$ ninja -C build
```
By default, this builds a debug build. To build a release build, use `meson
build --buildtype=release`.
Cage comes with compile-time support for XWayland. To enable this, make sure
that your version of wlroots is compiled with this option. Note that you'll
need to have the XWayland binary installed on your system for this to work.
You can run Cage by running `./build/cage APPLICATION`. If you run it from
within an existing X11 or Wayland session, it will open in a virtual output as
a window in your existing session. If you run it at a TTY, it'll run with the
KMS+DRM backend. In debug mode (default build type with Meson), press
Alt+Esc to quit. For more configuration options, see
[Configuration](https://github.com/cage-kiosk/cage/wiki/Configuration).
Cage is based on the annotated source of tinywl and rootston.
## Bugs
For any bug, please [create an
issue](https://github.com/cage-kiosk/cage/issues/new) on
[GitHub](https://github.com/cage-kiosk/cage).
## License
Please see
[LICENSE](https://github.com/cage-kiosk/cage/blob/master/LICENSE) on
[GitHub](https://github.com/cage-kiosk/cage).
Copyright © 2018-2020 Jente Hidskes