User Guide
Guide for using the WiLicensor Server web interface.
Getting Help
Every page in WiLicensor has a ? help button that provides contextual documentation.
- Click the ? button to open help for the current page
- Help appears in a modal overlay without leaving your current work
- Click outside the modal or press Esc to close
For complete documentation, click Docs in the navigation menu.
Getting Started
Logging In
- Navigate to the server URL
- Click Login
- Authenticate with your credentials
- You'll be redirected to the Dashboard
Dashboard
The Dashboard provides an overview of your license system:
- Total Keys: Total number of license keys in the system
- Active: Keys currently in use
- Trials: Active trial licenses
- Products: Number of products configured
Quick Actions
- View Keys: Jump to the Keys management page
- View Products: Jump to Products management
- Settings: Access system settings
Recent Keys
Shows the 5 most recently created or modified keys with:
- Name
- Product
- Type (trial, lifetime, subscription, demo)
Keys Management
Viewing Keys
The Keys page displays all license keys in a searchable, sortable table:
| Column | Description |
|---|---|
| ID | Unique key identifier |
| Key | Encrypted license key |
| Machine ID | Bound machine identifier |
| Name | Licensee name |
| Licensee email | |
| Product | Associated product |
| Type | License type |
| End | Expiration date (if applicable) |
| Condition | Current status |
| Settings | Key-specific settings |
Adding a Key
- Click the Add button
- Fill in the form:
- Key: Auto-generated or manual entry
- Machine ID: Leave empty for unbound keys
- Machine Name: Optional machine identifier
- Type: Select from dropdown (trial, lifetime, demo, subscription)
- Product: Select target product
- Name: Licensee name
- Email: Licensee email
- End: Expiration date (optional)
- Condition: Key status
- Settings: Custom settings (JSON format)
- Click Add Key
Editing a Key
- Click the Edit icon on any key row
- Modify the desired fields
- Click Save
Deleting a Key
- Click the Delete icon on any key row
- Confirm deletion
Key Conditions
| Condition | Description |
|---|---|
activated |
Key has been activated on a machine |
purchased |
Key purchased but not yet activated |
deactivated |
Key manually deactivated |
expired |
Key has passed its end date |
ok |
Key is valid and ready for use |
auto |
Automatically managed by the system |
Key Types
| Type | Description |
|---|---|
trial |
Time-limited trial license |
lifetime |
Permanent license, no expiration |
subscription |
Recurring subscription license |
demo |
Demonstration license |
Settings Format
Key settings use JSON key-value format without outer braces:
"nextSync": "7", "GracePeriodDays": "5"
Common settings:
settings: Base settings valuenextSync: Days between sync checksGracePeriodDays: Grace period after expirationcustomMessage: Custom message for the user
Products Management
Viewing Products
The Products page lists all configured products:
| Column | Description |
|---|---|
| ID | Product identifier |
| Name | Product name |
| Trial Days | Default trial period length |
Adding a Product
- Click the Add button
- Enter:
- Name: Product name (must be unique)
- Trial Days: Number of days for trial licenses (0 = no trial)
- Click Add Product
Editing a Product
- Click the Edit icon on any product row
- Modify name or trial days
- Click Save
Settings
Auto-add Unknown Project
When enabled, the system automatically creates products when an unknown product name is received via the API.
Machine Changes Per Day
Limits how many times a license key can be transferred to a different machine in a single day. Helps prevent license abuse.
Default: 2 changes per day
Theme
Click Switch Theme to toggle between light and dark mode. Your preference persists across sessions.
Search
Global Search
Use the search bar in the header to find keys or products:
- Enter search term (name, email, key, product name, etc.)
- Press Enter or click the search icon
- Results show matching Keys and Products in separate sections
Search Tips
- Searches are case-insensitive
- Partial matches are supported
- Searches across all fields: key, machine ID, name, email, condition, settings
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
Esc |
Close open modal |
Enter |
Submit form (when focused) |
API Integration
For API documentation and client library integration, see:
- API Documentation
- C# Client Library
- Python Client Library
- JavaScript Client Library
- Configuration Guide
Troubleshooting
For common issues and solutions, see Troubleshooting Guide.
Last Updated: 2025-12-20