- Clean Linux machine (Ubuntu 22/24) meeting hardware requirements
- Root and SSH access to the machine
- A domain name for Zylon (e.g., zylon.company.com)
- Ability to reboot the machine when needed
- Machine has
curlinstalled
- Full, unrestricted internet access on the target machine
- Firewall allows outbound connections to Docker registries and package repositories
- Either:
- Port 80 and 443 open for Let’s Encrypt automatic SSL certificate generation, OR
- Valid SSL certificate ready for manual configuration
Installing Zylon
Install Zylon CLI
Estimated time: 2 minThe Zylon CLI will speed up the time it takes to get everything ready, it will take care of installing drivers, updating Zylon and configuring the system.
To install it, SSH into the machine where you want to install Zylon and run:Verify the installation:
Root access is required for CLI operations as it manages system-level dependencies and configurations.
Verify Zylon minimum requirements
Ensure your machine meets the hardware requirements for Zylon.To validate automatically if your installation meets the minimum requirements, run:Address any issues reported before proceeding with the installation. You will not be able to continue until all preflight checks pass.
Are you having issues with network connectivity? Consider moving to a Semi-Airgap Installation or Airgap Installation.
Zylon requires all checks to pass before providing installation support.
Configure Zylon
Estimated time: 10minZylon is configured using a YAML file located at This opens an interactive prompt to guide you through configuration options.View Current ConfigurationYou can edit the configuration file directly using your preferred text editor (e.g., For detailed information about all available configuration options, see the Configuration Guide.
/etc/zylon/zylon-conf.yaml.Generate Initial ConfigurationUse the CLI to generate an initial configuration file:If for any reason you got stuck during the interactive prompt, you can skip it by adding the You will need to manually edit
-y flag to auto-generate a default configuration:/etc/zylon/zylon-conf.yaml afterward to set your desired configuration based on the manual configuration section.- Auto Configuration
- Manual Configuration
If you executed You can
sudo zylon-cli config init, all configuration is set.
Review /etc/zylon/zylon-conf.yaml to confirm settings. You can know more information about which settings are required in Manual Configuration section.If you need to re-run the configuration wizard, execute:
nano, vim):Install Zylon
Estimated time: 15min to 1hour, depending on system performance and network speed.Run the installation command with your desired version:Replace
<version> with your target version (e.g., 1.50.0).What Gets InstalledThe installation process handles:- System dependencies (gcc, git, etc.)
- Kubernetes distribution (k0s)
- NVIDIA drivers and CUDA (if applicable)
- Container runtime and tools (kubectl, helm)
- Zylon container images
- AI models from your configuration
- SSL certificate generation (if using Let’s Encrypt)
Create Organization
Estimated time: 5 minAfter Zylon is installed and running, create your organization and root administrator account.Prepare InformationYou’ll need:The command will wait if Zylon is not fully ready.Login CredentialsAfter seeding, use these credentials to log in:The root admin email is always
- Organization name: Your company or team name (can be changed later)
- Admin password: Secure password for root administrator (can be changed later)
- Use alphanumeric characters due to encoding limitations with special symbols
- Email regex: Pattern to auto-allow users to join
- For
name@company.comemails, use:.*@company\.com - For SSO (Microsoft Entra, Google), you can use:
.*
- For
Running the seed command will WIPE ALL DATA. Only run this once during the initial Zylon setup.
admin@zylon.ai and cannot be changed.After first login, you can create additional administrators and configure SSO authentication.
Configure SSL (Optional)
Estimated time: 10 minFor VPN or private cloud deployments, you need to manually install SSL certificates.Remove Automatic Certificate GenerationEdit Prepare Certificate FilesKubernetes requires the certificate split into two files:Import Certificate into KubernetesApply ChangesReload the Zylon configuration:VerifyAccess your Zylon instance at
Skip this step if using Let’s Encrypt automatic certificates (default for public-facing instances).
/etc/zylon/zylon-conf.yaml and remove these lines:tls.crt- The certificate filetls.key- The private key file
.pfx file, convert it:https://zylon.your-company.com and confirm:- The connection uses HTTPS
- The browser shows a valid certificate
- No certificate warnings appear
Updating Zylon
Updates follow the same process as installation:Migrating to Online
If you have an existing Zylon installation (semi-airgap or airgap) and want to migrate it to a fully online environment, follow this guide. This process preserves your data, and configuration, while transitioning to online operation.Migration differs from fresh installation:
- Your existing configuration and data will be preserved
- Organization and users already exist
- Ensure connectivity: Verify that the target machine has full internet access.
- Update configuration: Run
sudo zylon-cli config init --forceto update the configuration for online operation. - Refresh configuration: Execute
sudo zylon-cli syncto apply the new configuration settings. - Verify operation: Confirm that all services are functioning correctly with internet access.
Next Steps
After completing the installation, consider the following next steps to optimize your Zylon deployment:- Configure AI Presets to optimize for your hardware
- Configure Backups for data protection
- Review User Manual to get started