Table of contents
Welcome to the GuacamoleID guide, where you'll gain insights into the features, internal mechanisms, and usage guidelines of GuacamoleID. Designed for Windows, GuacamoleID empowers you to elevate your device's security standards. Seamlessly harnessing the potential of your webcam, it diligently monitors your facial presence as you interact with your computer. Should you momentarily step away from your device or in case of an unauthorized intruder, GuacamoleID quickly locks the screen, ensuring your confidential information remains secure.
## Installation Process
### Technical requirements
To run GuacamoleID App smoothly the minimum requirements are a computer or a laptop with at least:
* 8 GB RAM
* Eighth-generation Intel Core i5 or it's equivalent
* 500 MB of storage
* Windows 10 or 11 operating system
* An account with administrator access
### Installation process for the GuacamoleID App
To install the GuacamoleID App, make sure to follow the steps below.
1. Download the GuacamoleID installer from the trusted link on our website.
2. Go to the downloads folder on your device, search for the GuacamoleID installer, and double-click on it.
3. A Windows pop-up will request administrator access, click on the Yes button.
4. The installer will ask for a license key. The license key is a unique 16-character code that is provided by Hummingbirds AI to activate the license Fill out the license field, and click on the Next Button.
5. Read and accept the license agreement.
6. Click on the Install button to continue with the process.
7. The installer will ask you to restart your device. Once you restart Windows, GuacamoleID should run automatically and you can continue with the initial app setup.
## Function and utilization of GuacamoleID
### Initial Setup
1. To start the application, double-click on the GuacamoleID icon on your desktop.
2. Read and accept the user agreement.
3. Before continuing, please make sure no other applications are using the computer's webcam.
4. Select the front-facing camera you want to use from the camera list. You should be able to see yourself in the video box. If your camera doesn't show up in the list of available cameras, try clicking on the Refresh button.
5. Next you will need to set a user name. GuacamoleID should auto-fill this field with your Windows name, though you can change it if you want.
6. Next is the face registration process. Keep your face centered 2-3 feet away from the camera. Please note that no other faces should be visible in the frame during the face registration process.
7. Look towards the camera, and position your face in the center of the frame. Once you are in the proper position, a circle will appear.Keep your head still until the circle is filled in. Sometimes you need to move your face closer or farther away from the camera for optimal positioning.
8. Once the face registration process is complete the main menu will pop up on the left-hand side of the screen.
### Main Menu
The main menu allows you to access the key settings and control the GuacamoleID application. You can move the main menu by grabbing the top of the window.
#### Pause GuacamoleID
The pause/start button allows you to pause or resume the facial recognition system. For example, if you are presenting something in a conference room and you are not in front of the camera, or when you are in a pitch-dark environment you can pause the application.
Note: When the GuacamoleID app is paused, the Guacamole virtual camera is still running and you can use your video conferencing apps, i.e. Zoom, Microsoft Teams, Google Meet, and Webex.
#### Active Shoulder Surfing Protection
The setting allows the user to change the application's locking behavior:
1. Enabled: GuacamoleID will lock the screen whenever there is at least one intruder detected on the scene. This option protects the computer against shoulder surfing when you're in a public space.
2. Disabled: GuacamoleID will keep the screen unlocked whenever there is at least one authorized user in the scene. This option disables shoulder-surfing protection and is suitable for when the user works in trusted environments. It also makes it easier to share information on your computer with people who are not registered in GuacamoleID.
#### GuacamoleID Virtual Camera
GuacamoleID is compatible with all major video conferencing solutions, such as Zoom, Google Meet, Microsoft Teams, and Webex. To use the front-facing camera in a meeting while running the application, follow the upcoming steps.
1. Make sure to turn on the "Virtual Camera" by clicking on its button on the sidebar, to join virtual conferences at the same time GuacamoleID is protecting your device.
2. Once this function is activated, go to the camera settings for Google Meet, Zoom, or Microsoft Teams section to set the GuacamoleID virtual camera for the meetings if the virtual camera doesn't appear in the list of available cameras, close all the tabs on the browser and restart the browser.
If the user wishes to deactivate the GuacamoleID Virtual Camera, click again on the "virtual camera" button.
#### Manage Users
The Manage Users button allows you to open an window where you can manage the users that are registered to GuacamoleID. This window allows you to add and delete users. It also allows you to register low light embeddings and depth camera embeddings if you have the correct low light mode selected (see Low Light Mode for more information).
You can add a new user by clicking the "Add User" button. During the registration process, facial recognition will be paused to allow the new user to register their face without being blocked.
This window allows the user to restore the application data, access the camera configuration, activate and deactivate the system tray minimization and debugging functionality, and return to the main menu; make sure to go to the Configuration Menu section to learn more about this Menu.
#### System Tray
This button allows you to hide the GuacamoleID menu in the system tray. As long as the System Tray Switch is enabled, whenever GuacamoleID is executed, it will hide in the system tray.
To show the menu, click on the GuacamoleID icon found in the system tray.
Note: You can enable/disable this feature from the General Menu in the Settings tab.
The Exit button allows you to close GuacamoleID entirely. You can run the application again by clicking
the shortcut on the desktop.
### Settings Window
This window allows the user to change GuacamoleIDs settings.
#### General Settings
The General Settings section provides you with various options to configure and customize the behavior of the GuacamoleID application according to your preferences. Here, you can manage system tray settings, restore factory defaults, and control advanced features.
##### Software Telemetry
By enabling Software Telemetry, you allow GuacamoleID to gather semi-anonymized usage data, including security settings, block/unblock events, pause events, and face registration events. This information aids us in refining and optimizing our application's performance, ensuring a seamless and secure user experience. Your valuable insights contribute to the ongoing improvement of GuacamoleID.
##### System Tray
The System Tray Switch shows or hides the “Minimize to System Tray” button in the main menu. This button allows you to hide the GuacamoleID menu in the system tray. As long as the System Tray Switch is enabled, whenever GuacamoleID is executed, it will hide in the system tray.
To show the menu, click on the GuacamoleID icon found in the system tray.
This function should only be activated if instructed by the developers. Its purpose is to help Hummingbirds AI address any bugs that may arise down the road. The debug system substantially increases CPU usage, so keep this function turned off as long as it isn't needed.
##### Video Display
Enable the Video Display switch to allow GuacamoleID to showcase a dedicated window for the face recognition system's video stream. While activating this feature enhances your interaction with the application, it's worth noting that it marginally increases GuacamoleID's CPU usage.
##### Block Screen
The Block Screen switch offers you the flexibility to activate or deactivate the GuacamoleID block screen system. When this switch is turned off, rest assured that the underlying AI system will continue to function, maintaining its vigilant watch, while GuacamoleID refrains from initiating any blocks.
##### Restore Factory Settings
By restoring the application to the factory settings all locally stored data including your license will be deleted. Follow these steps:
1. On the general section in advanced settings, click on the Restore button.
2. A popup is going to appear to confirm that you want to restore the application, Click on the Confirm button, and the application will automatically close.
##### Load block Windows image
Customize your block window background by loading a personalized image. For optimal results, we suggest utilizing a square PNG image with a black background. Tailoring this visual element adds a touch of individuality to your GuacamoleID experience, allowing you to align the application's appearance with your preferences.
##### Use default block window image
Opt to revert to the default block window image by selecting this option. By doing so, any custom block window image you had previously set will be deleted, and GuacamoleID will seamlessly switch back to using its default block image.
##### Load Custom “Please enable virtual camera” Image
Personalize your GuacamoleID experience by loading a custom image for the "Please enable virtual camera" screen. To ensure optimal display, we recommend creating an image with a resolution of 1920x1080. Craft your image with the relevant message and ensure its readability even when mirrored.
##### Use default “Please enable virtual camera” Image
Opt for the default image by clicking the "Set Default" button, effectively removing any custom "Please Enable Virtual Camera" image you've previously configured. GuacamoleID will revert to using the default image for this purpose.
##### Load Custom “Loading Virtual Camera…” Image
Elevate your user experience by loading a personalized image for the "Loading Virtual Camera..." screen. Crafting an image with a 1920x1080 resolution, containing a fitting message, and ensuring readability when mirrored is recommended.
##### Use default “Loading Virtual Camera…” Image
Opt for the default image by clicking the "Set Default" button, effectively removing any custom "Loading Virtual Camera…" image you've previously configured. GuacamoleID will revert to using the default image for this purpose.
#### Camera Settings
In the Camera settings section, you will find all the configuration options related to the camera that GuacamoleID will use.
##### Set Camera
GuacamoleID performs optimally when the camera is directly facing you. If you have two or more cameras, to change the camera you have to select the available cameras that are in the dropdown. If the camera isn't in the dropdown, try to use the refresh button. When you have selected the camera you want to use, click on the Confirm button.
The camera settings automatically pause the facial recognition system to ensure that the app doesn't accidentally block you. Make sure to close the Settings window when you're done.
#### Security Settings
The Security Settings section has all the functions of GuacamoleID that make the application more secure, or more flexible, depending on the entity's security requirements.
##### Application Sensitivity
The application sensitivity is the main way you can tell GuacamoleID how quickly you'd like it to block your computer. A higher sensitivity will increase security by quickly blocking the device as soon as you walk away, but it may also increase the amount of accidental blocking events. GuacamoleID combines several different layers of machine learning models to try to minimize accidental blocking events, this means that there are several different internal timers that delay the blocking events while the app determines if it should block your screen. Overall these timers can be boiled down to 3 different cases:
1. Intruder timer: This timer is activated when GuacamoleID detects a face that it can't recognize. This is the shortest timer since it suggests that an intruder is accessing a device without permission. This timer's behavior will change depending on whether or not Shoulder Surfing Protection is active.
2. Absent timer: This timer is activated when GuacamoleID doesn't detect any faces in front of the camera.
3. Unverified timer: This timer is activated when GuacamoleID can't verify a person's identity. This normally happens when a person is visible in the camera frame and is looking away from the screen.
Each timer has a different time limit, and the time limit changes depending on the Sensitivity. The following table shows a very brief overview of each timer's behavior.
##### Authentication Mode
The main objective of the authentication modes is to protect GuacamoleID from being used by unauthorized users. GuacamoleID has 3 ways to protect itself from unauthorized use, which are Face Recognition Authentication, Windows Security Authentication, and Multi-Factor Authentication:
1. Face Recognition Authentication (the most convenient option): If this mode is chosen, the application will automatically verify the identity of the person using the GuacamoleID's Face Recognition, when you want to perform an action in the application. If the application cannot recognize your identity, a popup will appear in which you will have the option to verify your identity with the Windows Hello Authentication method.
2. Windows Security Authentication: if this mode is chosen, the application will use Windows Hello Authentication to verify the identity of the person who is trying to use the application. Choosing this mode does not mean that the face Recognition monitoring system is deactivated.
3. Multi-Factor Authentication (the most secure option): If this mode is chosen, the application will use the GuacamoleID Face Recognition Algorithm, plus the Windows Hello Authentication to authenticate the person who is trying to use the application or make a change to the application. This mode is the safest since the person who is using the device needs to be registered in the application, and have the credentials of the device.
##### Facial Recognition Threshold
This setting allows you to increase or decrease GuacamoleID's facial recognition threshold. It sets a minimum similarity to the user's stored facial biometrics. A higher threshold provides increased security. A lower threshold might improve performance in low lighting conditions and can allow the app to unlock your computer faster.
##### RGB Anti-spoofing
Elevate the security of your device with the innovative RGB Anti-spoofing feature. Once your device is unblocked, GuacamoleID employs a sophisticated machine-learning model to discern the authenticity of your face, effectively safeguarding against potential spoofing attempts, and ensuring that only actual individuals are granted access. RGB Anti-spoofing introduces an intricate verification layer that intricately analyzes facial attributes such as texture, depth, and subtle movements. This assessment aids in distinguishing between a live human face and artificial reproductions or images, fortifying the security measures in place.
Note: While this feature enhances security, it may lead to a noticeable increase in unblocking latency due to the additional verification process.
##### User Activity Detection
Activate User Activity Detection to enhance GuacamoleID's awareness when it loses sight of you. In such instances, the application leverages your keyboard and mouse activity as indicators of your presence in front of the computer.
#### Low Light Settings
Enhance your GuacamoleID experience in low-light environments by exploring the Low Light Settings. This feature offers a range of configurable options to ensure optimal performance even when lighting conditions are suboptimal.
##### Low Light Behavior
This setting determines GuacamoleID's different available behaviors in low-light situations. Each option changes the tools that GuacamoleID will use to determine if it should block your computer. GuacamoleID has the following options:
* Off: GuacamoleID will always behave the same way, using your camera to detect and recognize your face. In low-light environments, this option can fail frequently since your face will be poorly illuminated and thus it will be difficult to recognize you.
* Brightness & Bluetooth: With this option, GuacamoleID will use the brightness from your computer screen to try to illuminate your face. GuacamoleID will also overlay a white filter which changes your computer screen color. You can also configure a Bluetooth beacon. As long as the beacon is nearby, GuacamoleID won't block your screen.
* Auto Depth Camera: GuacamoleID will use the depth camera in your Windows Hello-enabled webcam to detect and recognize your face in the dark. GuacamoleID will also use an embedded ambient light sensor to determine when to switch from the normal camera to the depth camera. This option requires you to have compatible hardware. The depth camera needs to be configured separately in the IR camera tab.
* Manual Depth Camera: GuacamoleID will use the depth camera in your Windows Hello-enabled webcam to detect and recognize your face in the dark. You will need to manually enable and disable the depth camera by clicking the IR button in the GuacamoleID sidebar. The depth camera needs to be configured separately in the IR camera tab.
##### Adaptive Brightness
* Max Low Light Brightness
This functionality allows you to control the extent to which GuacamoleID increases your screen's brightness in Low Light Mode in situations where lighting conditions are challenging, it permits you to set an upper threshold on the extent to which GuacamoleID can boost your screen brightness automatically.
* Max Low Light White Filter
By overlaying a white filter atop your active windows, GuacamoleID ensures heightened white values on your screen, thereby illuminating your face in challenging low-light situations. However, it's important to acknowledge that while this filter enhances visibility, it will impact your screens color accuracy.
* Bluetooth Beacon
GuacamoleID can use a Bluetooth low-energy device as a beacon. GuacamoleID will calculate the distance between the beacon and the protected device using the signal strength. When you're in a low-light environment, as long as the Bluetooth beacon is nearby GuacamoleID will never block the protected device. If GuacamoleID detects that the beacon is far away, or if it detects that it has lost its connection with the beacon for an extended period of time, it will fall back on the face verification and adaptive brightness.
## GuacamoleID App FAQ
### What does the GuacamoleID application do?
GuacamoleID revolutionizes your digital security experience with its AI-based facial recognition system, ensuring exclusive access to your system and data for you and your trusted contacts. Whenever you step away from your computer, GuacamoleID intelligently locks the screen and access, eliminating the need for repetitive password entry. The application even guards against prying eyes by detecting intruders attempting shoulder surfing, thereby preserving your privacy.
### How can I ensure the safety of my biometric data?
As a staunch advocate of privacy, GuacamoleID places paramount importance on safeguarding your data. Rest assured that no video recordings are stored by the application, and users' facial biometric data are encrypted and stored locally. This data is never transmitted to the cloud, ensuring that neither videos nor biometric information fall into the hands of external entities.
### In what scenarios is my PC blocked by GuacamoleID?
GuacamoleID triggers screen blocking in three situations:
* Unauthorized Face Detection: If an unrecognized face is detected by GuacamoleID.
* Absent User: If GuacamoleID cannot recognize the authorized user's face for a specified period.
* User Absence: When the authorized user steps away from their laptop, GuacamoleID initiates a block.
### How does GuacamoleID integrate with our legacy Identity and Access Management (IAM) system?
Your organization can continue utilizing the existing legacy IAM system, with a minor tweak to the "Sleep Time" setting to extend it. During the initial period of a working shift, users log in using the legacy system (password, 2FA, MFA). Once logged in, GuacamoleID seamlessly takes over, continuously authenticating the user, and ensuring a harmonious coexistence of both systems.
### Can I use GuacamoleID with multiple users on the same computer?
Yes, GuacamoleID supports multiple users on the same computer. You can easily add trusted users through the "Manage Users" section in the application's main menu. Each user can register their face to ensure personalized and secure access.
### How does GuacamoleID handle changes in my appearance, such as wearing glasses or growing a beard?
GuacamoleID's facial re-identification models are able to recognize you in most situations, even if you are wearing glasses or after growing a beard. However, if you undergo significant changes, such as major hairstyle changes or facial surgeries, it's recommended to re-register your face to ensure optimal performance.
### Does GuacamoleID work with video conferencing applications?
Yes, GuacamoleID is compatible with most major video conferencing solutions such as Zoom, Google Meet, Microsoft Teams, and Webex. The "GuacamoleID Virtual Camera" feature enables you to use your front-facing camera in meetings while the application continues to protect your device.
### Is there a way to speed up the unblocking process?
While GuacamoleID aims to balance security and convenience, there are a couple of settings that you can tweak to reduce the unblocking time:
* You can reduce the facial recognition threshold.
* You can disable the RGB face Anti-spoofing model.
Copyright © 2023