Welcome to Replicated Docs
Learn how to use the Replicated Platform to secure and distribute your software to enterprise customers
Get started
Add custom license fields
Custom license fields allow you to define application-specific entitlements and add other types of metadata to customer licenses.
Learn more →
Browse product documentation
Vendor Platform
Teams and Accounts
Manage team members, RBAC, API tokens, and more
Applications
Manage your application in the Vendor Portal
Channels and Releases
Create and promote application versions
Customers and Licenses
Manage customer records and license entitlements
Custom Domains
Alias Replicated domains
Insights and Telemetry
Get telemetry and event data from customer instances
Replicated CLI
Use the CLI to manage applications, releases, and more
Vendor API
Integrate Vendor Platform functionality into your workflows
Embedded Cluster
Overview
Distribute a Kubernetes cluster and your application together as a single appliance
Embedded Cluster Config
Embedded Cluster Config resource
Online Installation with Embedded Cluster
Install with internet access using Embedded Cluster
Air Gap Installation with Embedded Cluster
Install in environments without internet access
Perform Updates with Embedded Cluster
Update an application and the cluster infrastructure
Helm CLI Installations
Overview
An introduction to Helm CLI installations for applications distributed with Replicated
Install with the Helm CLI
Install your application using Helm CLI
Install and Update with the Helm CLI in Air Gap Environments
Use Helm in environments without internet access
Enterprise Portal
Overview
Give customers access to releases and instance data
Customize the Enterprise Portal
Configure branding and appearance for customers
Manage Customer Access to the Enterprise Portal
Invite and manage customer portal users
Use the Enterprise Portal
Access and use the Enterprise Portal
Self-Service Sign-ups
Enable self-service access to trial or community licenses for customers
Compatibility Matrix
Overview
Test your application across customer-representative environments
CMX Pricing
Learn about pricing for CMX clusters and VMs
Test in Air Gap Environments
Simulate networks with no outbound internet access
Use CMX VMs
Create and manage virtual machines for testing
Use CMX Clusters
Create and manage Kubernetes clusters for testing
Test in CMX with CI/CD
Automate testing workflows with continuous integration
Replicated Proxy Registry
Overview
Grant proxy access to private images
Add and Manage External Registries
Connect external image registries
Use the Proxy Registry with Embedded Cluster
Proxy images for Embedded Cluster installations
Use the Proxy Registry with Helm CLI Installations
Proxy images for Helm CLI installations
Connect to a Public Registry
Pull images from public registries
Replicated SDK
Overview
In-cluster service and API to integrate key Replicated functionality into your application
Install the Replicated SDK
Install alongside an application or as a standalone component
Development Mode
Develop against the SDK API to test changes locally
Replicated SDK API
API reference for Replicated SDK endpoints
Customize the Replicated SDK
Customize RBAC, set environment variables, add tolerations, and more
Troubleshoot
Overview
Learn about troubleshooting tools for customer environments
Define Preflight Checks
Verify that customer environments meet application requirements
Add and Customize Support Bundles
Configure support bundles for troubleshooting
Generate Support Bundles
Collect support bundles in customer environments
Inspect Support Bundles
Analyze support bundles to troubleshoot issues
Submit a Support Request
Contact Replicated support for assistance