Files
CLICD/docs/en/guide/quick-start.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.3 KiB

Quick Start

This is a common path from a fresh installation to your first container.

1. Log In

Open http://YOUR_SERVER_IP:8999 and sign in with the administrator account.

After entering the panel, check:

  • Whether the dashboard shows host resources.
  • Whether Image Management can list templates.
  • Whether NAT and IPv6 status in Routing match your host network.

2. Download an Image

Open Image Management, choose a template, and download it. On small hosts, lightweight images such as Alpine or Debian are a good first choice.

Image downloads run asynchronously. You can watch progress in the task queue.

3. Create a Container

Open Container Management and click Create:

  • Select virtualization type and template.
  • Set CPU, memory, and disk.
  • Set traffic limits and expiration time.
  • If external access is required, add NAT port mappings or assign IPv6 from the container details page after creation.

4. Open a Terminal

After the container is created, open WebSSH from the details page. KVM virtual machines can use WebVNC for console access.

5. Share with a Sub-user

If another user needs to manage a container, create an access link in Sub-user Management. The sub-user only sees authorized containers and is limited by the operation scope configured by the administrator.