A Wayland kiosk
Find a file
Jente Hidskes 24cc576377 cage: set CLOEXEC on the file descriptors
As mentioned by @emersion:

By default, pipe creates FDs without the CLOEXEC flag set, which means
they will be leaked to any other child process spawned. Would be nice to
set the CLOEXEC flag to prevent the leak.
2020-02-07 19:04:16 +01:00
.builds CI: build with --werror 2020-01-31 22:58:15 +01:00
cage.c cage: set CLOEXEC on the file descriptors 2020-02-07 19:04:16 +01:00
config.h.in cage: add -v argument to print version 2020-01-26 18:18:49 +01:00
idle_inhibit_v1.c Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00
idle_inhibit_v1.h Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00
LICENSE Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
meson.build meson: don't build with -Werror by default 2020-01-31 22:55:16 +01:00
meson_options.txt Add XWayland support 2019-01-02 20:58:48 +01:00
output.c output: include seat.h 2020-02-03 21:23:39 +01:00
output.h output: include seat.h 2020-02-03 21:23:39 +01:00
README.md README: update build instructions 2020-02-01 16:17:58 +01:00
render.c render: use output backend to get renderer 2020-02-07 19:04:16 +01:00
render.h Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
seat.c Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
seat.h seat: be explicit about output- and layout coordinates 2020-01-05 13:16:01 +01:00
server.h Support multiple outputs 2019-12-26 17:14:57 +01:00
util.c Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
util.h Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
view.c view: maximize dialog if it extends output layout 2020-01-11 17:11:16 +01:00
view.h Render popups separately from their toplevel view when possible 2020-01-11 17:07:33 +01:00
xdg_shell.c Render popups separately from their toplevel view when possible 2020-01-11 17:07:33 +01:00
xdg_shell.h Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00
xwayland.c xwayland: use view's (x,y) coordinate when maximizing 2020-01-11 17:11:16 +01:00
xwayland.h Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00

Cage: a Wayland kiosk builds.sr.ht status

Cage's logo

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 and the Wiki.

Release signatures

Releases are signed with 6EBC43B1 and published on GitHub.

Building and running Cage

You can build Cage with the meson build system. It requires wayland, wlroots and xkbcommon to be installed. 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, first make sure that your version of wlroots is compiled with this option. Then, add -Dxwayland=true to the meson command above. 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.

Cage is based on the annotated source of tinywl and rootston.

Bugs

For any bug, please create an issue on GitHub.

License

Please see LICENSE on GitHub.

Copyright © 2018-2020 Jente Hidskes dev@hjdskes.nl