Managing products

Products define the structure and permissions for your licensable software.

Creating products

Products serve as templates for generating customer licenses. To create a product:

1. Navigate to Products in your project dashboard
2. Click Create product
3. Configure the product settings

Basic information

• Name: Alphanumeric identifier (letters, numbers, underscore only)
• Description: Internal description for product management
• Page markdown: Customer-facing documentation displayed during onboarding

Page markdown

The page markdown field allows you to provide onboarding instructions to customers. This content is displayed when customers access their onboarding links.

Supported markdown features:

• Headers, lists, and basic formatting
• Links to external resources
• Code blocks for installation instructions
• No CSS, JavaScript, or images allowed

License fields

License fields define the customer data collected when issuing product keys.

Preconfigured fields

All products include these standard fields:

• Email: Customer contact email (always required)
• Name: Customer or organization name (always required)
• Notes: Optional description/notes for internal reference

Custom field types

Text: Free-form text input

• Use for names, descriptions, or custom identifiers
• Can set default values and mark as required

Email: Email address validation

• Automatically validates email format
• Useful for customer contact information

Number: Numeric input

• For usage limits, user counts, or numeric configuration
• Supports integers and decimals

Select: Dropdown with predefined choices

• Define available options in the choices field
• Useful for tiers, regions, or feature sets

Checkbox: Boolean true/false

• For feature toggles or agreement confirmations
• Returns boolean values in product keys

Date: Date picker input

• For expiration dates or effective dates
• Stored as ISO date strings

Textarea: Multi-line text input

• For longer descriptions or configuration data
• Supports newlines and formatting

Field configuration

For each field, you can configure:

• Required: Whether customers must provide this field
• Editable: Whether field can be customized per customer
• Default value: Pre-filled value (required for non-editable fields)
• Description: Help text shown to customers

Registry permissions

Products can grant customers access to Docker images through role assignments.

Pull roles

Add pull roles to allow customers to download specific images:

1. Click Add role in the Pull roles section
2. Select from available roles in your project
3. Customers receive these permissions when using their product key

Common pull role patterns:

• pull: Access to all images in the registry
• pull-product-name: Access to specific product images
• pull-tier-basic: Access to basic tier images

Managing existing products

Editing products

1. Select a product from the Products list
2. Click the edit button
3. Modify fields, roles, or markdown content
4. Save changes

Note: Changing product structure affects new product keys only. Existing customer keys retain their original configuration.

Deleting products

1. Select a product from the Products list
2. Click the delete button
3. Type the product name to confirm deletion

Warning: Deleting a product invalidates all associated customer keys. Customers will lose access to licensed features and registry permissions.