Skip to content

GUI Guide

On KDE Plasma

gaze-kde adds a Face Unlock entry to System Settings that opens this same app, so you can reach it from where Plasma users expect to find it. See the KDE Plasma guide.

gaze-gui is the easiest way to enroll faces and check auth health.

Launch it:

bash
gaze-gui
  • Enroll a new face profile: Initiates a guided camera capture. If both RGB and IR cameras are configured, it captures from both.
  • View enrolled profiles: The main window lists enrolled faces with green/red RGB and IR badges indicating which capture types are active, along with the total template capture count.
  • Refine profiles: Tap the edit/refine icon on a profile to capture additional samples or add a missing spectrum (e.g. adding IR captures to an existing RGB-only face profile after configuring an IR camera).
  • Test authentication: Check Gaze's recognition with immediate pass/fail visual feedback.
  • Remove profiles: Delete specific face profiles.
  • Configure daemon settings: Change security levels, cameras, liveness settings, and hybrid policies.

Configuration dialog

Open the config dialog from the header-bar settings button.

The dialog mirrors /etc/gaze/config.toml, grouped the same way. Saving writes the file through the daemon, so it needs a polkit authorization.

Security

  • Security level (low, medium, high, maximum, or custom)
  • For custom: detector level, recognizer level, RGB and IR similarity thresholds

Hardware

  • Inference execution provider, either ONNX Runtime directly or through OpenVINO
  • OpenVINO inference device

Both offer only cpu on the released packages. The other values need a build compiled with the openvino-config Cargo feature. See Configuration for what those builds accept.

Cameras

  • RGB camera source, IR camera source, and Force IR Emitter
  • Darkness cutoff, the dark-frame rejection threshold

Enrollment

  • Max templates per face
  • Minimum face size ratio, where lower values allow enrollment from farther away

Liveness Anti-Spoofing

  • Enable liveness spoof prevention, liveness threshold, liveness max seconds

Auth

  • Abort if SSH, abort if lid closed
  • Require confirmation on lock screen, require confirmation for elevated auth
  • Resume grace period and start delay, both in milliseconds
  • Start delay applies to, either every face auth or screen lockers only
  • Hybrid combining policy, used when both RGB and IR are enrolled

Storage

  • Encrypt face templates, which seals enrolled templates with the TPM. See How it works for what that protects against.

Common tasks

  1. Enroll a profile named default.
  2. Run test authentication several times in normal room light.
  3. Add another profile if your appearance varies often (for example, glasses).

When to use GUI vs CLI

  • Use GUI for enrollment and quick pass/fail checks.
  • Use CLI (gaze auth --verbose) when you want detailed authentication metrics and diagnostics.

If the GUI cannot authenticate

Check daemon status:

bash
systemctl status gazed

If stopped:

bash
sudo systemctl enable --now gazed

Then retry from GUI.