Home
This documentation provides an overview of the Agora License Manager and its enhanced features for robust protection and flexibility.
The Agora License Manager streamlines the management of software licenses by monitoring usage, ensuring the number of users or installations remains within the allowed limits, and license activation, renewal, and deactivation. It helps prevent unauthorized software usage while ensuring compliance with licensing agreements, and keeping everything organized and secure.
- Auto Faveo Licenser offers a centralized location to track all your licenses. The user-friendly dashboard provides dedicated sections for different license categories.
- It tracks end-user identities, including activation dates and the number of licenses currently in use. Additionally, the dashboard gives you a clear overview of when your licenses, support, and updates will expire.
The admin can view and update their profile section by navigating to the Profile tab at the top right corner.
- First Name: Displays the admin’s first name (e.g., Mark).
- Last Name: Shows the admin’s last name (e.g., Henry).
- Username: The admin's username used for login (e.g., admin@techworld.com).
- Email Address: The admin’s email address (e.g., admin@techworld.com).
- Timezone Settings: Indicates the admin’s current time zone (e.g., (GMT+05:30) Asia/Kolkata).
- Phone Number: Displays the admin’s contact number (e.g., 9876543210 with country code 91).
- Change Password: Allows the admin to update their password.
- Old Password: Field for entering the current password.
- New Password: Field for entering a new password.
- Confirm Password: Field to confirm the new password.
- Setup 2-Step Verification: Option to enable two-step verification using an authenticator app for added security. When 2FA is enabled, users must enter a secret code that can be accessed on their phones using 2FA authentication apps such as Authy or Google authenticator whenever they log in.
Products are the foundation for creating and managing software licenses. The Products Section allows you to create new products, review the complete list of products, see a list of all existing products, and identify any products that have been suspended.
The New Product feature in License Manager is responsible for creating, managing, and tracking software licenses for newly launched products. They represent individual software applications or suites that are offered to customers. By creating new product entries, you can effectively track and control the distribution and usage of these products.
Steps to create a new product:
- Navigate to the sidebar navigation of your dashboard.
- Create your product using
Products > Add New Product.
Key Fields and Their Significance
| First Name | Description |
|---|---|
| Product Name | The official name of the software product |
| Product Status | Indicates whether the product is currently active (available for licensing) or inactive (discontinued or temporarily unavailable) |
| Product SKU | The Product SKU (Stock Keeping Unit) is a unique identifier assigned to the product, often used for management and tracking. Integers, texts, and special characters can be included |
| Product Homepage URL | The web address of the product's official homepage/ website provides more information and resources |
| Product Download URL | The Product Download URL is a direct link to where the product can be downloaded |
| Product Version | The specific version or release number of the current version of the product |
| Product Description | The Product Description field provides a detailed overview of the product, outlining its features, uses, and benefits |
In the All Products Section, you can view a list of all the products you have created/added.
Click on the desired product to edit its details. You can modify product details without impacting current installations. Setting the product status to Inactive will deactivate all licenses associated with that product.
- Navigate to the sidebar navigation of your dashboard.
- To update existing products, go to
Products > All Products > View Products. After making modifications, click "update" to save your changes.
Note: For instance, if 5 clients have active licenses for a specific product, deactivating it will make all 5 licenses unavailable. This option should be used only if you want to restrict users from accessing the product for any reason.
By clicking the view icon for a product, you can access a page that displays details about the number of installations, versions, and licenses issued for the specific product.
Clicking the product view icon, you'll see information about:
- Installations: How many times the software has been installed, where it's installed (domain, IP, the license code, its status) and when it was installed. This helps you track where the software is being used.
- Versions: Different versions of the software, when they were released, if they've been upgraded, and their status. This helps you keep track of software updates and ensure everyone uses the latest version.
- Licenses: How many licenses are currently active, when they expire, their status, and other details. This helps you manage your licenses and see how many are being used.
If a product is no longer in development, support, or usage, you can choose to suspend it.
- To do this, click on the suspend icon. Once the suspension is complete, the product will move to the Suspended Products section
Products > Suspended Products. - A confirmation box will appear on your screen.
- To confirm the suspension, click on the suspend button.
Suspending a product means temporarily restricting its availability for licensing or use for a specified duration. Once a product is suspended, its status will change to inactive.
- Restoring a suspended product involves reactivating it after it has been temporarily made unavailable.
- You can easily do this by clicking on the restore icon.
- A confirmation box will appear to verify your confirmation to restore the record.
- To activate the product for use again, click on the restore button.
- Although the details of the product will not be entirely erased, deleting a suspended product will result in its permanent associated removal.
- You can delete a product by clicking on the delete button.
- A confirmation box will pop up to seek your approval for this action. Click on the delete button to permanently delete the record.
This allows you to manage and create different versions of a software product.
When you introduce a new version, you can define its specific characteristics, track its installations and upgrades, and control access to it.
Steps to create a new version:
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Versions > Add New Version.
Key Fields and Their Significance:
| Field Name | Description |
|---|---|
| Product | Specify the parent product to which this version belongs |
| Version Number | The unique identifier for this specific version. typically follows a format such as 1.0.0 or 2.1.3, indicating major, minor, and patch updates |
| Installation Archive | This field is for uploading the full installation archive file path. It contains all the necessary files and scripts needed for a fresh installation for this |
| Upgrade Archive | You can specify the archive file path specifically for upgrading an existing installation. This is usually smaller than the installation archive as it only includes the updated files needed for the upgrade. This file contains the upgrade package for users who are already on an older version |
| Installation MySQL Query | This field is for adding the SQL queries that need to be executed during the initial installation. These queries typically create necessary tables and insert default data |
| Upgrade MySQL Query | This section is for entering SQL queries that run during an upgrade process. These queries update existing database tables and structures to accommodate new features or fixes introduced in the new version |
| Installation Raw MySQL Query | In this field, raw SQL queries can be entered for more complex installations that might require custom queries not covered by standard SQL setups. This is typically used for advanced installations |
| Upgrade Raw MySQL Query | This field is used for raw SQL queries during the upgrade process. These queries help modify the database when upgrades need specific changes that aren't handled by standard queries |
| Version Changelog | A detailed list of changes and improvements is included in this version |
| Installations Limit | This field specifies the maximum number of times this version of the product can be installed |
| Upgrades Limit | The maximum number of this field defines how many upgrades a user can perform under the license for this version |
| Comments | Additional notes or comments about this version for future reference |
| Version status | This field lets you define the current status of the version. It can be set to statuses such as "Active," "Inactive," or "Deprecated". This helps control which versions are available to users |
| Version Expiration Date | This specifies the date when the version will no longer be available for use or available for licensing |
Consider the example below of a New Version Entry.
| Field Name | Description |
|---|---|
| Product | Acme Software |
| Version Number | 3.2.0 |
| Installation Archive | AcmeSoftware_3.2.0_Setup.exe |
| Upgrade Archive | AcmeSoftware_3.2.0_Upgrade.exe |
| Installation MySQL Query | / ... SQL query for installation ... / |
| Upgrade MySQL Query | / ... SQL query for upgrade ... / |
| Installation Raw MySQL Query | / ... Raw SQL query for installation ... / |
| Upgrade Raw MySQL Query | / ... Raw SQL query for upgrade ... / |
| Version Changelog | Added new features Auto-assignment, OS Compatibility, Security Updates, and Bug Fixes |
| Installations Limit | 30 |
| Upgrades Limit | 50 |
| Comments | Not for production use yet. |
| Version status | Inactive |
| Version Expiration Date | 2024-12-31 |
This section shows a list of both new and existing product versions. It provides a data table containing details such as version number, product name, release date, upgrade counts, callback counts, status, and actions to edit, view, or delete versions that are no longer in use.
- Version: Shows the product version linked to the license, helping track its usage by customers.
- Product: Identifies the product the license is issued for, distinguishing between different software/services.
- Release Date: Displays the product version's release date, useful for managing updates and licenses.
- Upgrades Count: This field shows the number of times users have upgraded to this specific version from an older version.
- Callbacks Count: Displays the number of times a license has called back to the server for validation or checking status. It helps track license activity and ensures the license is being used within the agreed terms.
- Status: Indicates the current status of the license, such as Active, or Inactive. This gives an immediate overview of the license's validity and usability.
Provides admin functionalities such as viewing more details, editing the license, or taking actions like revoking or renewing the license. This gives the admin control over license management and updates.
- Edit: Click on the edit icon to modify details, such as the release date or changelog.
- View: Click on the view icon to access more detailed information about the version, including installation and upgrade packages.
- Delete: Remove the version record from the system permanently.
After creating a product, add a new client who will use the licensed product.
Steps to create a new contact:
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Contacts > New Contactsto register new user details.
- First Name: Enter the user's first name, which will be part of their profile and used for identification.
- Last Name: Provide the user's last name for complete identification within the system.
- Email Address: This unique email will be used for communication and license verification. It must be distinct for each user.
- Username: Choose a username that the user will use to log into the system.
- Status: Set the user's account status to either Active (user can access the system) or Inactive (user access is restricted).
- Role: Assign the user a role—either Client (to use licensed products) or Admin (to manage licenses and users).
Important Notes: If you deactivate a product, all its licenses will be disabled. This means that no one can use this product anymore. Only deactivate a product if you don't want anyone to be able to use it. For instance, if 5 clients have active licenses, all of those licenses will no longer be usable. It's best to create a client's profile before issuing a license. However, if you don't have the client's details (like name or email) or prefer to issue an anonymous license, you can simply skip this step.
Under this section, you can see a list of all current and new users. If a user is already part of the system, their information is in the Contacts list. The table displays user details such as their role, creation date, email verification status, and agent status.
- The edit icon allows you to easily modify a user's details to keep their information up-to-date and accurate.
- You can change details like name, email, role, and other relevant information as needed.
- Clicking the view button takes you to a page that provides a comprehensive overview of the user's information.
- This page displays the number of installations and license records associated with the user. This helps you track software usage and ensure compliance.
In the License Manager, a license is essential for controlling and managing the usage of a product or service. Here are some key roles of a license in a license manager:
- Authorization: Licenses confirm that a user is allowed to access and use the software or service.
- Usage Tracking: They monitor who is using the software and how frequently it’s being used.
- Compliance Enforcement: Licenses help ensure that users follow the terms, preventing unauthorized use or sharing.
- Expiration Management: Licenses often come with expiration dates, which the license manager tracks to ensure they are followed.
Steps to create a new license:
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Licenses > New Licensesto create a license.
- Product: Select the product for which the license is being issued.
- License Code: Provide or generate a unique license code. This is a mandatory field if the client's profile is not available.
- Client: Choose or search for the client associated with the license. If the license is being issued without a client profile, the License Code field must be filled in.
- Order Number: Enter the order number related to the purchase. This field is optional but recommended for better tracking.
- Licensed IP: Specify the IP address(es) where the licensed software can be installed and used. If specified, the application will only work on the given IP address. Changing the IP will cause the license check to fail. You may leave this blank if it’s not required.
- Licensed Domain(s): Enter the website or domain(s) where the licensed software can be used. If specified, the application will only function on the entered domain. Format as example.com or example.com/path (do not include a trailing slash). If using example.com, the application works on example.com and any subdirectory. If using example.com/path, the application works only on that specific path.
- License Expiration Date: Set the license's expiration date. The license will cease to be valid after this date unless renewed.
- Updates Expiration Date: Define the end date for updates eligibility.
- Support Expiration Date: Set the date when the client’s support eligibility expires.
- Always Require Domain: Choose whether the license will always require a domain to be valid.
- Installations Limit: Set a limit for the number of allowed installations.
- Comments (Optional): Add any additional comments or notes regarding this license. This field is optional but can be useful for internal use.
- License Status: Set the license status. Choose Active to make the license usable or Inactive to deactivate it.
Important Notes:
- If you have the client’s details, choose both the client and product from the list.
- If you don’t have the client’s name and email (and can’t create a profile), select the product and enter a unique license code. This code will allow anyone with it to activate their copy of the protected script.
- A client profile or a license code is required to proceed with creating the license.
- You can specify multiple IPs and/or domains by separating them with commas (,).
- Even if updates and/or support expiration dates are set, the application will continue to function as long as the license remains active. However, updates and support will not be available after the specified expiration dates.
- The application will only function if both the IP and domain match. For example, if IP 1.1.1.1 and domain example.com are set, but example.com resolves to IP 1.1.1.2, the application will not work.
You can edit all the issued/existing licenses in this section. It will display a list of licenses, showing each record in the data table.
Click on the edit icon to make any necessary changes. However, be aware of these points:
A Few Things to Keep in Mind
- Changing some details might affect existing installations. Let's say the software is installed on "clientdomain.com" and you change the licensed domain to a specific path like "clientdomain.com/path." In this case, the existing installation won't work anymore.
- Updates are crucial for certain changes. If something like a client's IP address changes, you'll need to update the license so they can keep using the software.
Here's a helpful analogy: Imagine a client has three separate keys for three different rooms (software products). Deactivating one key (license) only restricts access to that specific room (product), while the other two keys (active licenses) will still allow access to their respective rooms (products).
Important Notes:
- You can't change the product or owner after a license is issued.
- Need a license for a different product? Just deactivate the old one (optional) and create a new one.
- Setting the license status to Inactive will deactivate this license.
- Deactivating a license stops access to that specific product, but won't affect other active licenses the client has.
You will find here a list of the applications/products that have been installed, along with detailed records for each one.
Steps to view all the installations:
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Installations > All Installations.
Only the IP address and license status can be changed. Modifications should only be made if the client's IP address has changed and license verification has failed. Installation details should not be modified otherwise. Deactivating or deleting an existing installation will cause license verification to fail, and the client will need to reinstall the protected application.
- Domain: The domain field specifies the website or server domain where the licensed software is installed.
- IP Address: This field represents the IP address of the server where the software is installed. It helps in validating the installation by ensuring that the license is used only on the authorized server.
- Status: This field indicates whether the license is currently in use.
- Active: The license is currently being used by the installation.
- Inactive: The license is not in use, and the installation is either paused or deactivated.
- Disable IP Address Verification: This option allows you to disable the verification of the installation's IP address.
- Yes: Disables IP address verification, allowing the software to be used regardless of the server's IP address.
- No: Keeps IP address verification on, making sure the software only works on the specified server's IP address.
The Callback Manager page displays the list of All Callbacks.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Callbacks > All Callbacks.
The license callbacks will display the list of changes or actions that are triggered related to a software license, such as activation, deactivation, or renewal. They ensure the system is updated with the latest licensing information and that the software complies with the licensing terms.
These callbacks are triggered when the software receives updates, such as new features or version changes. They ensure that the system and other connected services are informed about the updates.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Callbacks > All Callbacks.
Reports provide important data related to the management and performance of licenses. Each report offers specific insights based on different aspects of the licensed software and its usage.
- Navigate to the sidebar navigation of your dashboard.
- Go to the Reports option.
This report provides an overview of all the licenses issued and managed within the system. It includes details such as license status (active, inactive), expiration dates, the domains or IP addresses associated with each license, and license types.
This report provides information about the system's performance and health, identifies who accessed or generated the report, records the date and time of the report, and the system's status. The System Report in the License Manager provides:
- Report: System details like performance, resource usage, deletions and configurations.
- User: This displays the list of users or administrators who generated the report.
- Report Date Time: When the report was created.
- Status: The system's current condition (e.g., Success, Error). It helps track system health, user actions, and report timing.
This report helps monitor the updated history and status of software products. The Update Report displays the following data:
- Report: Details about the updates applied to the software, including version numbers and descriptions of changes or enhancements.
- Product: The specific product or software that received the update.
- Report Date Time: The date and time when the update was applied or the report was generated.
- Status: The current state of the update (e.g., Successful, Failed, Pending), indicating whether the update was applied correctly or if there were issues.
This includes information on suspicious activity, unauthorized installations, or attempts to access the software.
- Report: A description or identifier for the specific cracking incident, providing context for the report.
- License Code: The unique code associated with the license that was targeted in the cracking attempt. This helps identify which license was compromised or attempted to be cracked.
- Report Date Time: The date and time when the cracking incident was reported or detected. This is useful for tracking the timeline of incidents.
- Status: The current status of the report, indicates whether the incident is under investigation, resolved, or if further action is needed.
The "Customize Notifications" feature in the Server Notification section of Faveo License Manager enables you to display custom alerts in your application for various events, such as failed license checks or expired licenses. When a specific license event occurs, an alert message will be displayed. The notification details are pre-configured by default.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Server Settings > Customize Notificationsto modify notifications.
License Status Notifications
- Invalid Product: Alert users that the product associated with the license is not recognized or valid.
- Inactive Product: Alerts users that the product is currently inactive and may require reactivation or troubleshooting.
- Valid License: Confirms that the license is valid and active, assuring users.
- Invalid License: Indicates that the license being used is not valid, prompting users to check their license information.
- Invalid IP: Warns users that the IP address being used does not match the one specified in the license agreement.
- Invalid Domain: Informs users that the domain being used is not authorized under the current license.
- Domain Required: Indicates users that a domain is required for the license to function properly but is currently missing.
- Domain in Use: Alerts users that the specified domain is already associated with another active license.
- Suspended License: Indicates that the license has been suspended, potentially due to a violation of terms or other issues.
- Expired License: Alert users that the license has expired and needs to be renewed for continued use.
- Expired Updates: Alerts users that the software updates associated with the license have expired, which may affect functionality.
- Expired Support: Informs users that the support services linked to the license have expired, potentially affecting access to assistance.
- Cancelled License: Inform users that the license has been cancelled and is no longer valid.
Installation and License Management Notifications
- Maximum Installations Limit Reached: Alerts users that the maximum number of installations allowed for the license has been reached, preventing further installations.
- Non-Existing Installation: Indicates that the installation associated with the license cannot be found or does not exist.
- Invalid License Signature: Warns users that the digital signature of the license is invalid, indicating a possible issue with authenticity.
- Host Banned: Notifies users that the host associated with the license has been banned, preventing usage.
General Error Notification
- Unknown Error: Alerts users to an unspecified error that has occurred, requiring further investigation.
Configuration options in the License Manager allow administrators to manage and control various aspects of how licensed software operates. These settings control integrations, appearance, localization, and system status.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Software Settingsoptions.
1. Google Site Key (V3):
- This is the public key used to integrate Google reCAPTCHA V3 into your license manager's forms (e.g., login pages, and registration forms) to help detect bot activity.
- To obtain this key:
- Go to the Google https://www.google.com/recaptcha
- Sign in and register your domain by selecting reCAPTCHA v3 as the type.
- Once registered, Google will provide you with a Site Key.
- Enter this key into the Google Site Key (V3) field.
2. Google Secret Key:
- This is the private key used on the server side to validate CAPTCHA responses sent by users.
- This key is also provided when you register your site on the Google reCAPTCHA platform (as described above).
- Enter this Secret Key in the Google Secret Key field.
3. Status (Active/Inactive):
- The Recaptcha Status in the License Manager indicates whether Google's reCAPTCHA feature is enabled (active) or disabled (inactive) on your system.
- Active: If it is active, then protect the system from unauthorized activities by requiring users to complete verification challenges.
4. Agora Invoicing URL:
- Specify the URL of your Agora invoicing system, which will be integrated to manage payments, invoicing, and billing-related activities for licenses.
5. Timezone Settings:
- This setting determines the time zone used by the license management system. Select the correct time zone from the dropdown menu to ensure accurate timestamps and reports
6. Date Format Settings:
- Select your desired date format from the dropdown list. Example format:
m-d-Y (Month-Day-Year), such as09-23-2024
7. Time Format Settings:
- Choose your preferred time format from the dropdown list. It can be set to either
12-houror24-hourformat.
8. Logo and Favicon Settings:
- These settings let administrators upload and manage the branding elements for the license manager interface. The changes made under this section
will be visible on the browser and can be seen by browsing the system. Changes made will be reflected in the admin and client panels.
- Use Default: Uses the default logos and favicon.
- Favicon (Change Icon): Upload a custom favicon for the browser tab.
- Admin Panel Logo (Change Logo): Upload a custom logo for the admin panel.
- Client Panel Logo (Change Logo): Upload a custom logo for the client-side panel.
1. Whitelisted Access Only: Restricts access to the faveo license manager to only those IP addresses or domains that are specified as whitelisted.
- Disabled: Anyone can attempt to access the system.
- Enabled: Only whitelisted IPs or domains can access the system.
2. Banned Hosts: Blocks specific hosts (IP addresses or domains) that have been banned from accessing the license manager.
- Disabled: No hosts are banned.
- Enabled: A list of banned hosts is maintained, preventing their access.
3. Auto Ban Failed Login Hosts: Automatically bans IP addresses or hosts after a certain number of failed login attempts. You can specify the value from the drop-down list.
- For example, 3 Attempts: After 3 failed login attempts, the host is banned. (This value can typically be adjusted.)
4. Forget Failed Attempts: Resets or "forgets" the failed login attempt count after a certain number of attempts or a set period, allowing users to retry after failure without a permanent ban.
- For example, 3 Attempts: Failed login attempts are reset after 3 attempts, preventing permanent lockout. Specify the value from the drop-down.
The Email Settings section of the License Manager offers configuration options for managing notifications and communication within the system. The Faveo License Manager specifically sends emails for two actions: an email is sent when a new contact is created by the admin, and another is triggered when an admin initiates a password reset.
- Driver: Choose the transfer protocol you want to use for outgoing emails. Common options include SMTP and PHP mail.
- Email: The email address that will be used to send notifications. Ex: support@gmail.com.
- From Name: The name that will appear in the "From" field of the emails.
- Encryption: The type of encryption to be used for the email connection. Common options include SSL and TLS.
- Port: The port number to be used for the email connection.
- Password: The password for the email account.
- Host: The SMTP server hostname.
- Password: You can specify the password to the email login to authenticate.
- If you have enabled 2FA on your email account, use the specific App Password to configure the email account.
Article Link: Refer to the following article to configure your Two-Step Verification and obtain an App Password: Configuring Two-Factor Authentication (2FA) for a Gmail account in Faveo
It uses scheduled cron jobs to perform these cleanups regularly for automatically managing and removing outdated data to optimize system performance and storage. The system will not run as expected if Cron is not set properly.
- Callback Cleanup: Removes old callback logs based on the specified time interval, such as every week.
- Crack Reports Cleanup: Deletes outdated crack reports according to the set time frame, like every week.
- License Reports Cleanup: Removes old license reports that document license activities and statuses as per the defined schedule, such as every week.
- System Reports Cleanup: Cleans up system reports that monitor the health and performance of licensed systems based on the time interval specified, like every week.
- Installation Status Logs: Deletes outdated installation logs that track the status of licensed software installations according to the specified schedule, for example, every week.
- Remove Callbacks Older Than: Automatically removes callback logs older than the specified number of days (default: 90 Days).
- Remove Crack Reports Older Than: Deletes crack reports older than the specified number of days (default: 90 Days).
- Remove System Reports Older Than: Clears system reports that are older than the set period (default: 60 Days).
- Remove License Reports Older Than: Cleans up license reports that are older than the specified duration (default: 180 Days).
These settings ensure that old logs and reports are cleaned up regularly, keeping the system efficient and well-maintained.
Navigate to the sidebar navigation of your dashboard. Navigate to the Debugger Settings option.
- To troubleshoot errors and to understand the reason the Debugging mode is enabled in the system.
- When enabled, this mode activates detailed logging, which records error messages, operational data, and other relevant information.
API Keys are unique identifiers used to authenticate and authorize access to the license management system's API. They enable communication between the license manager and external applications or services by ensuring that only authorized users or systems can interact with the API.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
API Keysoption.
This field initiates the process of creating a new API key for use with the license manager.
- API Secret: Required field for entering a unique secret key for authentication; it must be kept confidential.
- IP Address: Optional field to specify an allowed IP address for API access, enhancing security.
-
Permissions To Add Products: Indicates whether the selected users or roles have permission to add new products through the API.
- Active: Users can add new products.
- Inactive: Users cannot add new products.
- Permissions To Edit Products: A similar dropdown for specified users or roles who can edit existing products are Active or Inactive, through the API.
- Permission to Add Clients: Field to select users or roles that can add new clients via the API.
- Permissions To Edit Clients: Specifies who can edit client information through the API.
- Permissions To Add Licenses: Allows selection of users or roles authorized to add new licenses via the API.
- Permissions To Edit Licenses: Similar specification for who can edit existing licenses through the API.
- Permissions To Add Installations: Let the administrator choose users or roles that can add new installations via the API.
- Permissions To Use Search: Specifies users or roles authorized to perform search operations via the API.
- API Key Status: Dropdown to indicate the API key's current status (e.g., Active, Inactive), controlling its usability.
- Description: Required field for entering a brief description of the API key's purpose or permissions for identification.
The View API Keys section in the License Manager provides an overview of all existing API keys along with their associated details.
- API Secret: The unique key used for authentication.
- Description: A brief explanation of the API key's purpose.
- IP Address: Shows the allowed IP address associated with the API key, indicating which addresses can use it.
- Permissions: Indicates what actions the key can perform (e.g., add/edit products, clients, licenses, installations, search).
- Status: Whether the key is active or inactive.
- Actions: Available actions like editing or deleting the key.
The Banned Hosts feature in the License Manager is used to prevent specific IP addresses from accessing the system. This enhances security by blocking potentially malicious or unauthorized users.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Banned Hosts > New Banned Hostoption.
- IP Address: Enter the IP address that you want to ban. By banning a host, the system will deny access to any requests originating from that address.
- **Comments: **The optional field enables administrators to add notes or comments about the reason for banning the host. This can be helpful for record-keeping and understanding the context of the ban.
This section allows administrators to view existing banned hosts. To modify a banned host, click on the IP address. To delete a banned host, check the corresponding IP address and click the 'Submit' button.
Navigate to the sidebar navigation of your dashboard. Go to the WhiteList IP > WhiteList option.
The New Whitelist feature in the License Manager allows administrators to add IP addresses that are permitted to access the system.
- IP Address: Required field where the administrator enters the specific IP address that should be whitelisted. The specified address will be granted access to the license manager.
- Comments: Specify the additional notes or comments about the reason. This can be helpful for record-keeping and understanding the context of the ban.
The Whitelist section in the License Manager displays a list of authorized IP addresses that are allowed to access the system.
Banned IP addresses enhance security by blocking specific IPs from accessing the Faveo Licenser, while whitelisted IP addresses allow only trusted IPs to gain access.
The Extra Tools section in the License Manager provides additional functionalities that enhance the overall management and operation of the licensing system.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Extra Toolsoption.
It is the process of defining how licenses are handled and verified within the system, ensuring that all necessary parameters are properly set up for effective license control.
- Product: Specifies the name of the product for which the license is being generated (e.g., "MyApp Pro"). This helps in identifying and managing licenses specific to that product.
- License Verification Period: Specify the duration (in days) for which the license is considered valid before requiring re-verification (e.g., 30 days). This helps ensure that users regularly confirm their license status.
- License Storage Type: Indicates where the license data will be stored, such as in a database or file storage. This affects how the license information is managed and accessed.
- License File Location: Specifies the file path where the license file will be stored. This is crucial for the system to locate and verify the license file during checks.
- MySQL Table Name: Specify the name of the database table used for storing license information (e.g., "licenses"). This is important for the organization and retrieval of license data in a database.
- Delete Cancelled License: Specify whether cancelled licenses should be permanently removed from the system. Selecting "Yes" helps keep the database clean and prevents clutter.
- Delete Cracked License: Specifies whether licenses identified as cracked should be deleted from the system. Setting this to "Yes" helps maintain the integrity of the licensing process.
- GOD Mode: When the God Mode option is enabled by selecting "Yes", it activates enhanced monitoring for any suspicious activity. If the system detects any unusual behaviour, it will automatically erase all data to safeguard against suspicious activity. Conversely, selecting "No" for this option disables this protective measure, meaning the system such as data erasure, in response to detecting any suspicious activity.
Exception Logs provide detailed information about errors and exceptions that occur during operation, helping administrators maintain system performance. Here are the key components of exception logs.
- Navigate to the sidebar navigation of your dashboard.
- Go to the
Extra Tools > Exception Logsoption.
- Category: Identifies the type of error (e.g., database, API), helping administrators understand the issue context.
- File: Specifies the file where the exception occurred, aiding in pinpointing the problem source.
- Line: Indicates the exact line number in the code where the error originated, helping developers and admins to identify the root cause.
- Message: Describes the error, providing insights for diagnosing the issue and determining necessary actions.
- Trace: Contains a stack trace showing the sequence of function calls leading to the exception, aiding in understanding how the error occurred. Clicking "Read More" will display the details.
- Created At: Records the timestamp of when the exception was logged, useful for tracking issues and correlating them with other events.