^{Internally known as eu.kosy.Kerberos}

Kerberos (Lock screen)

⚠️ Warning: This software is still in a development statues. Use on productive systems is not recommended. There might be major safety and stability problems. Multi monitors systems aren't supported at all.

Kerberos is a simple GTK 4 based lock screen for Wayland compositors. It is tested on Wayfire but should work on similar system as well (check dependencies).

It provides a simple screen shield with a login prompt and allows a custom background image and a few other settings. There is also a possibility to use you on CSS themes for your personal experience.

Installing

At the moment there are no available packages for Kerberos. If you want to install it check the instructions for an installation from the source code.

Dependencies

Build dependencies

• build essentials
• GTK 4 (>= 4.0)
• wayland-client (>= 1.19)
• libpam

Additional runtime dependencies

• wayland compositor
  • [Protocolls required by GTK]
  • wlr-input-inhibitor-unstable-v1
  • idle-inhibit-unstable-v1
• dbus
• swayidle (or simular)

Install from source

# Clone project
git clone https://github.com/KosyTeam/kerberos.git
cd kerberos
# Build and (if desired) generate locales
make
make update-locale
# Install (requires root)
sudo make install

Setup

Kerberos does not provide a graphical interface to change its settings, but this can easily done with gsettings (alternatively dconf-editor could be used). Before doing this please take sure that everything installed without any error.

If using gsettings all commands are in the same format: gsettings set eu.kosy.Kerberos [key] [value]. See table for the specific settings.

Setting	Key	Possible values
Allow shutdown from lock screen	allow-shutdown	true or false
Set the background image to be used	background-image	Absolute path (e.g. /home/user/Images/background.jpg) or '' for default
Use custom theme instead of the integrated	custom-theme	true or false
Set the CSS file containing the custom styling	custom-theme-path	Absolute path (e.g. /home/user/.themes/custom.css)*

*Not setting custom-theme-path will cause the default system theme to be used. This can be very buggy.

Run

It's recommended to start Kerberos with an idle management daemon like swayidle. The command should be executed at startup or login and could look like the following:

swayidle -w \
timeout 300 'kerberos' \
before-sleep 'kerberos'

Please note that because of limitations in GTK 4 in combination with the wlr-layer-shell-unstable-v1-protocol some implementations will prevent further idle actions (like automatic suspend) after the start of Kerberos. For more information see #1.

Of course it's also possible to start Kerberos directly with the kerberos command. It's no problem to call Kerberos multiple times. If there is a running instance nothing will happen.

Notifications

If the Mako notification daemon is reachable via dbus Kerberos will automatically show the number of missed notifications on the bottom of the screen. Other services are not yet supported.

Getting help & Reporting bugs

The simplest way to get help is the Kosy Team Matrix Group alternativly you can also write a e-mail. There will be a solution on the way. If you have found a bug or a feature request than you can use our bug tracker, but please do not ask questions there.

---

Whats Kosy? Kosy Team?

I (mfxbe) use Kosy as a project name for number of applications I've written for personal use with a specific design and structure in mind. Right now Kerberos is the only one being available in public. Other might or might not be released in future.