DOCUMENTATION

STX documentation

Install STX, manage hosts and SeaTunnel clusters, write jobs, and review alerts.

Pick a guide for the task at hand. Start with Quick deploy on first use; if you already have STX, jump to the matching topic.

Start here

01Quick deployInstall STX on Linux, open the Web UI, and complete first login.Read guide ↗02System architectureLearn how STX Server, managed hosts, and processes connect.Read guide ↗03Hosts & clustersRegister hosts, install stx-agent, and manage SeaTunnel clusters.Read guide ↗04Debug workbenchReview connector parameters, then write and debug sync jobs.Read guide ↗

Browse by topic

Install and connect

Prepare the install environment and confirm Web UI, API, and gRPC addresses.

Quick deploy↗Architecture and default ports↗

Manage the runtime

Start by registering hosts, then attach an existing cluster or install a new one.

Host management↗Cluster management↗

Edit and debug jobs

In the Web UI, review connector docs, debug jobs, and check run results.

Debug workbench↗

Packages & Plugins

Prepare SeaTunnel install archives, download connectors with dependencies, and install them onto clusters.

Package Management↗Plugin Marketplace↗

Alerts & diagnostics

Start from alerts or errors, run inspections, then read reports and known fixes.

Alert center↗Errors↗Inspection & report↗Experience library↗

Use the CLI

Learn CLI usage, the command risk model, and how to install Skill for AI Agents.

STX CLI↗