中文文档 | English

Self-Deployed Lightweight Cloud is a lightweight KVM remote cloud platform tailored for individuals and small businesses. This project is developed based on rttys, designed for users who need to quickly build a remote access platform while prioritizing data security.

• Device Management - Online device list monitoring
• Script Deployment - Convenient script-based device addition
• Remote SSH - Web SSH remote connections
• Remote Control - Web remote desktop control
• Batch Operations - Batch command execution capabilities
• Rapid Deployment - Quick self-deployment with simple operations
• Data Security - Private deployment with full data control
• Dedicated Bandwidth - Exclusive bandwidth for self-hosted deployments
• Lightweight Design - Optimized for small businesses and individual users
• Enterprise Authentication - Supports both LDAP and OIDC login methods for enterprise users.

The following mainstream operating systems have been tested and verified

• Ubuntu 18.04 / 20.04 / 22.04 / 24.04
• Debian 11 / 12

• AlmaLinux 8 / 9
• Rocky Linux 8 / 9
• CentOS Stream 9

If your server provider uses a cloud security group (e.g., AWS, Aliyun, etc.), please make sure the following ports are open:

⚠️ Important: These ports will be used by GLKVM Cloud. Please ensure no other applications or services on your server are binding to these ports, otherwise the lightweight cloud platform may fail to start properly.

We provide two ways to install GLKVM Cloud:

Note: The one-line installer is Docker-based. It automates Docker/Compose setup, pulls images, renders configs from templates, and starts services for you.

Run as root:

( command -v curl >/dev/null 2>&1 && curl -fsSL https://kvm-cloud.gl-inet.com/selfhost/install.sh || wget -qO- https://kvm-cloud.gl-inet.com/selfhost/install.sh ) | sudo bash

Full reference: see docker-compose/README.md

Once the installation is complete, access the platform via:

https://<your_server_public_ip>

⚠️ Note: Accessing via IP address will trigger a browser certificate warning. To eliminate the warning, it's recommended to configure a custom domain with a valid SSL certificate.

The default login password for the Web UI will be displayed in the installation script output:

🔐 Please check the installation console for your web login password.

• Copy script

• Run the script in the device terminal

• Devices connected to the cloud

⚠️ Note:

If you just want to quickly try out GLKVM Cloud and don’t mind the browser’s certificate warning, you can skip configuring a custom domain and SSL certificate, and still access the platform via the server’s public IP with HTTPS.

For production use, or if you need to access multiple KVM devices via subdomains, it is strongly recommended to configure your own wildcard SSL certificate (see below).

To enable full domain-based access, configure the following DNS records for your domain:

┌────────────┬──────┬────────────────────┬─────────────────────────────┐
│ Hostname   │ Type │     Value           │         Purpose             │
├────────────┼──────┼────────────────────┼─────────────────────────────┤
│ www        │  A   │ Your public IP      │ Web access to the platform │
│ *          │  A   │ Your public IP      │ Remote access to KVMs      │
└────────────┴──────┴────────────────────┴─────────────────────────────┘

To avoid browser warnings, replace the default certificates with your own wildcard SSL certificate that supports both:

• *.your-domain.com (for device access)
• www.your-domain.com (for platform access)

Replace the following files in:

~/glkvm_cloud/certificate

• glkvm.cer
• glkvm.key

⚠️ Make sure the filenames remain unchanged.

GLKVM Cloud supports LDAP authentication for enterprise environments, allowing you to integrate with existing directory services like Active Directory, OpenLDAP, or FreeIPA.

Key Features:

• Dual Authentication Mode: Support both LDAP and traditional password authentication simultaneously
• Group-based Authorization: Restrict access to specific LDAP groups
• User-based Authorization: Allow access for specific users only
• TLS/SSL Support: Secure LDAP connections with encryption
• Multiple LDAP Systems: Compatible with Active Directory, OpenLDAP, FreeIPA, and generic LDAP servers

Configuration: For detailed LDAP configuration options and setup instructions, see the Docker Compose README.

Note: When LDAP is enabled, users can choose between:

• LDAP Authentication: Enter username and password for directory service authentication
• Legacy Authentication: Leave username empty and use the web management password

GLKVM Cloud provides full support for OIDC (OpenID Connect) authentication, allowing seamless integration with modern identity providers such as Google, Auth0, Authing and any other standard-compliant OIDC provider.

Key Features

• Modern Authentication Secure sign-in through any OIDC provider supporting Authorization Code Flow.
• Email / Username / Group Whitelisting Restrict access based on:
  • Email or domain (e.g. @example.com)
  • Stable user ID (sub)
  • Username (preferred_username or name)
  • Groups attribute
• Full OpenID Connect Compliance Supports issuer validation, token signature verification, and nonce protection.
• Flexible Provider Support Works with public clouds (Google, Azure AD, Auth0, Okta) and self-hosted solutions.

Configuration

For detailed OIDC configuration options and setup instructions, see the Docker Compose README.

After replacing certificates or updating LDAP configuration, restart the GLKVM Cloud services to apply the changes:

cd ~/glkvm_cloud
docker-compose down && docker-compose up -d

Or, on systems with the Docker CLI plugin:

docker compose down && docker compose up -d

Once everything is configured, you can access the platform via your domain:

https://www.your-domain.com