accounts/README.md
2025-08-10 09:30:37 +08:00

2.5 KiB

XControl

XControl is a modular multi-tenant management platform written in Go. The project integrates several optional components to provide a visual control plane for traffic statistics, configuration export and multi-node management.

This repository contains the API server, agent code and a Next.js-based UI.

Components

  • ui-homepage
  • ui-panel
  • xcontrol-cli
  • xcontrol-server

All UI components provide both Chinese and English interfaces.

Tech Stack

Category Technology Version
Framework Go 1.24
Framework Next.js 14.1.0
Gateway OpenResty 1.27.1.2
Database PostgreSQL + pgvector N/A
Cache Redis N/A
Model Large Language Models via CodePRobot N/A

Supported Platforms

Tested on Ubuntu 22.04 x64 and macOS 26 arm64.

Installation

make install
make init-db   # initialize database (optional)

Features

  • XCloudFlow Multi-cloud IaC engine built with Pulumi SDK and Go. GitHub →
  • KubeGuard Kubernetes cluster application and node-level backup system. GitHub →
  • XConfig Lightweight task execution & configuration orchestration engine. GitHub →
  • CodePRobot AI-driven GitHub Issue to Pull Request generator and code patching tool. GitHub →
  • OpsAgent AIOps-powered intelligent monitoring, anomaly detection and RCA. GitHub →
  • XStream Cross-border developer proxy accelerator for global accessibility. GitHub →

The docs directory contains a more detailed overview and design documents for each module.

Building

make build

This produces a binary under bin/xcontrol. Run make agent to build the node agent.

Testing

make test

Deployment

make start

This launches the server, homepage and panel. Use make stop to stop all components.

The API server also accepts a custom configuration file:

xcontrol-server --config path/to/server.yaml

Logging

Both xcontrol-cli and xcontrol-server accept a --log-level flag to control verbosity. The level may be one of debug, info, warn, or error:

xcontrol-cli --log-level debug
xcontrol-server --log-level warn

The server's log level can also be set in the configuration file:

log:
  level: info

The flag value takes precedence over the configuration file.

License

This project is licensed under the terms of the MIT License.