Get Started
What is GuacamoleID?¶
GuacamoleID is an application that utilizes facial recognition technology to enhance your computer's security. It automatically locks your screen whenever you step away, preventing unauthorized access and safeguarding your confidential information. With the Cluster Version, you also have the ability to use synchronize you biometric data across multiple devices.
System Requirements¶
The minimum requirements are a computer or a laptop with at least:
- Operating System: Windows 10 or 11
- RAM: Minimum 8 GB
- Processor: Eighth-generation Intel Core i5 or equivalent
- Storage: 500 MB
- Webcam: Required
- User Account: Administrator access for installation
Download and Installation¶
- Download the GuacamoleID installer from the official website using a trusted link.
- Locate the downloaded installer in your Downloads folder and double-click it to initiate the installation.
- Grant administrator access by clicking "Yes" in the Windows pop-up window.
- Enter your unique 16-character GuacamoleID license key provided by Hummingbirds AI.
- Read and accept the license agreement.
- Click "Install" to proceed with the installation.
- The installer will prompt you to restart your device. Once restarted, GuacamoleID should automatically run.
Initial Setup¶
- Double-click the GuacamoleID icon on your desktop to launch the application.
- Read and accept the user agreement.
- Ensure no other applications are using your computer's webcam.
- Select your preferred camera from the available camera list.
- Decide whether you are going to skip the face registration or register a new user.
- Follow the Face Registration process. Center your face and look straight at the camera.
Quick Menu¶
The main menu on the left-hand side of the screen provides access to GuacamoleID's different functions.
| Icon | Action | Description |
|
Exit |
Close the GuacamoleID application. |
Pause/Play |
Pause or resume facial recognition. |
|
![]() |
Active Shoulder Surfing Protection | Enable or turn off screen locking upon detecting unauthorized users (suitable for public spaces). |
![]() |
User List |
Register additional users |
![]() |
Settings |
Access general, camera, security, Low Light settings, and about page. |
![]() |
System Tray | When clicked, the Quick Menu is hidden, and a GuacamoleID System Tray appears in hidden icons on the right part of the Windows taskbar. |
Block Screen¶
GuacamoleID is designed to block access to a device if it detects that its user walks away, or if it detects an intruder is trying to access the device. When GuacamoleID blocks your screen it displays a window (called the Block Screen) that cover all other applications. The Block Screen also detects key presses to send the device to the Windows lock screen as a security measure.



