bc54b94518
This isn't an optimal build: 1. We're using an untagged, rolling Arch Linux base image for our Docker image, meaning that potentially every build uses a different base. The reason for using an Arch base is because Arch is the only system that has new enough versions of wlroots' dependencies. Alpine has this too, but is sufficiently different (e.g. musl and no logind) from other systems such that I'm not sure whether it will be of any benefit. In the future, when wlroots is less bleeding edge, we can switch to tagged releases of e.g. Fedora. 2. We don't have access to hardware, hence we cannot run with wlroots' headless backend. We can solve this by making the hardware available to our container with docker's --device=/dev/dri/renderD128, but we don't have control over this inside our Travis instance. Hence, we need to run with wlroots' x11 backend through xvfb. Still, it's better than nothing and we will at least get to know whether Cage builds and can start up, open a window and close. For good measure, I also threw in Clang's analyses so we'll learn about potential issues here as well. |
||
|---|---|---|
| .travis.yml | ||
| cage.c | ||
| config.h.in | ||
| Dockerfile | ||
| idle_inhibit_v1.c | ||
| idle_inhibit_v1.h | ||
| LICENSE | ||
| meson.build | ||
| meson_options.txt | ||
| output.c | ||
| output.h | ||
| README.md | ||
| seat.c | ||
| seat.h | ||
| server.h | ||
| view.c | ||
| view.h | ||
| xdg_shell.c | ||
| xdg_shell.h | ||
| xwayland.c | ||
| xwayland.h | ||
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.
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
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. To build a release
build, use meson build --buildtype=release.
Cage is based on the annotated source of tinywl and rootston.
Bugs
For any bug, please create an issue on GitHub.
License
Copyright © 2018-2019 Jente Hidskes hjdskes@gmail.com