Files
CLICD/docs/en/guide/introduction.md
T
MengMengCode a45e063fc2 Add comprehensive documentation for CLICD features and operations
- Introduced Container Management documentation covering lifecycle operations, resource management, and console access.
- Added Dashboard documentation detailing metrics and related APIs.
- Created Host Report documentation summarizing host environment and resource status.
- Included Image Management documentation for template handling and management actions.
- Documented Networking and Routing features including NAT4 and IPv6 management.
- Added Security Alerts documentation outlining alert scenarios and API usage.
- Created Snapshot Management documentation for snapshot operations and scheduling.
- Documented Sub-user management for granting access to specific containers.
- Added Configuration guide detailing runtime settings and security recommendations.
- Created Installation guide for setting up CLICD with requirements and steps.
- Added Introduction and Quick Start guides for new users.
- Documented Upgrade process with version checking and pre-upgrade checklist.
- Created Deployment guide for service exposure and firewall recommendations.
- Added FAQ section addressing common questions and concerns.
- Documented Troubleshooting steps for common issues encountered.
2026-06-10 00:42:06 +08:00

1.6 KiB

Introduction

CLICD is a lightweight virtualization management panel for LXC and KVM. It brings common host operations into a web console and CLI, making it suitable for small VPS nodes, dedicated servers, and scenarios where container access needs to be distributed in batches.

Core Capabilities

  • Manage LXC containers and KVM virtual machines.
  • Create, start, stop, restart, reinstall, and delete containers.
  • Configure CPU, memory, disk, traffic limits, and expiration time.
  • Manage NAT4 port mappings, public IPv4 assignment, and public IPv6 assignment when the host network supports it.
  • Open WebSSH or WebVNC from the browser.
  • Manage image downloads, enablement, and local cache.
  • Create, restore, and delete snapshots, plus scheduled snapshots and quotas.
  • Generate security alerts based on connection behavior and keep audit logs.
  • Create sub-user access links for specific containers.
  • Integrate automation through API keys and /api/v1.

Use Cases

  • Quickly allocate multiple Linux containers on one host.
  • Give users temporary access to a container console, SSH, VNC, or NAT port management.
  • Automate container creation, resource changes, password resets, or resource cleanup through the API.
  • Use a panel that is clearer than pure CLI workflows without becoming a heavy platform.

Tech Stack

  • Backend: Go, net/http, SQLite, systemd, LXC, KVM/libvirt, cgroup v2, iptables, conntrack.
  • Frontend: React, TypeScript, Vite, Tailwind CSS, lucide-react, xterm.js, noVNC.
  • Release: GitHub Actions builds Linux AMD64 release artifacts. The installer fetches the latest release by default.