Skip to content

Getting Started

Get Gaze running in under 10 minutes: install, enroll your face, and verify authentication.

Before you begin

  • Linux desktop with a working webcam (/dev/video*)
  • sudo access
  • Internet connection for first-time model download

Step 1: Install Gaze

Recommended one-line installer:

bash
curl -fsSL https://gaze.gundulabs.com/install.sh | sh

If you prefer manual repo setup, use the installation guide.

Step 2: Check daemon status

bash
systemctl status gazed

If it is not running:

bash
sudo systemctl enable --now gazed

Step 3: Enroll your first face

bash
gaze add-face default

Tips while enrolling:

  • Keep your face centered and well lit.
  • Let it capture multiple angles.
  • Remove strong backlight if possible.

Step 4: Test authentication

bash
gaze auth

For extra details:

bash
gaze auth --verbose

Step 5: Open the GUI (optional)

bash
gaze-gui

Use the GUI to enroll additional face profiles (for example, with glasses and without glasses).

Step 6: Enable lock screen auth

GNOME extension package is installed as gaze-gnome-extension.

bash
gnome-extensions enable gaze@gundulabs.com

On Wayland, log out and back in after installing extension updates.

Note: lock screen and GDM login integration are GNOME-only and require this extension. GDM login face auth is disabled by default due to GNOME keyring behavior. See GNOME Extension for details and optional login enablement.

If something fails

Go to the troubleshooting guide for camera, daemon, PAM, and low-match issues.

Next