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*) sudoaccess- Internet connection for first-time model download
Step 1: Install Gaze
Recommended one-line installer:
curl -fsSL https://gaze.gundulabs.com/install.sh | shIf you prefer manual repo setup, use the installation guide.
Step 2: Check daemon status
systemctl status gazedIf it is not running:
sudo systemctl enable --now gazedStep 3: Enroll your first face
gaze add-face defaultTips while enrolling:
- Keep your face centered and well lit.
- Let it capture multiple angles.
- Remove strong backlight if possible.
Step 4: Test authentication
gaze authFor extra details:
gaze auth --verboseStep 5: Open the GUI (optional)
gaze-guiUse 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.
gnome-extensions enable gaze@gundulabs.comOn 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
- Tune behavior in the configuration guide
- Learn commands in the CLI guide
- Use the desktop app via the GUI guide
- Review PAM setup in PAM
- Review lock/login behavior in GNOME Extension