2023-01-03 21:30:57 +01:00
# Cage: a Wayland kiosk
2018-11-22 19:59:06 +01:00
2019-04-24 20:57:10 +02:00
< img src = "https://www.hjdskes.nl/img/projects/cage/cage.svg" alt = "Cage's logo" width = "150px" align = "right" >
2019-04-23 22:52:35 +02:00
2018-11-22 19:59:06 +01:00
This is Cage, a Wayland kiosk. A kiosk runs a single, maximized
application.
2020-01-26 16:03:05 +01:00
This README is only relevant for development resources and instructions. For a
description of Cage and installation instructions for end-users, please see
2020-02-01 16:17:58 +01:00
[its project page ](https://www.hjdskes.nl/projects/cage ) and [the
2023-08-13 23:35:42 +02:00
Wiki](https://github.com/cage-kiosk/cage/wiki/).
2018-11-22 19:59:06 +01:00
2019-04-23 22:52:35 +02:00
## Release signatures
2023-07-29 10:20:42 +02:00
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
2023-07-29 01:08:56 +02:00
[E88F5E48 ](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48 )
2023-08-13 23:35:42 +02:00
All releases are published on [GitHub ](https://github.com/cage-kiosk/cage/releases ).
2019-04-23 22:52:35 +02:00
2018-11-22 19:59:06 +01:00
## Building and running Cage
2019-02-26 18:33:48 +01:00
You can build Cage with the [meson ](https://mesonbuild.com/ ) build system. It
2020-05-31 15:14:18 +02:00
requires wayland, wlroots, and xkbcommon to be installed. Optionally, install
2024-02-16 16:17:47 +01:00
scdoc for manual pages. Cage is currently based on branch 0.18 of wlroots.
2019-02-26 18:33:48 +01:00
Simply execute the following steps to build Cage:
2018-11-25 22:11:08 +01:00
```
2024-08-21 18:06:34 +02:00
$ meson setup build
$ meson compile -C build
2018-11-25 22:11:08 +01:00
```
2020-02-01 16:17:58 +01:00
By default, this builds a debug build. To build a release build, use `meson
2024-08-21 18:06:34 +02:00
setup build --buildtype=release`.
2020-02-01 16:17:58 +01:00
2024-07-08 19:13:11 +02:00
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.
2019-01-02 21:08:45 +01:00
2020-02-01 16:17:58 +01:00
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
< kbd > Alt< / kbd > +< kbd > Esc< / kbd > to quit. For more configuration options, see
2023-08-13 23:35:42 +02:00
[Configuration ](https://github.com/cage-kiosk/cage/wiki/Configuration ).
2019-12-20 17:04:38 +01:00
2019-01-31 14:49:01 +01:00
Cage is based on the annotated source of tinywl and rootston.
2018-11-22 19:59:06 +01:00
## Bugs
For any bug, please [create an
2023-08-13 23:35:42 +02:00
issue](https://github.com/cage-kiosk/cage/issues/new) on
[GitHub ](https://github.com/cage-kiosk/cage ).
2018-11-22 19:59:06 +01:00
## License
Please see
2023-08-13 23:35:42 +02:00
[LICENSE ](https://github.com/cage-kiosk/cage/blob/master/LICENSE ) on
[GitHub ](https://github.com/cage-kiosk/cage ).
2018-11-22 19:59:06 +01:00
2020-01-11 16:46:18 +01:00
Copyright © 2018-2020 Jente Hidskes < dev @hjdskes .nl >
