Quick Deployment Guide (One-Click Docker Compose Deployment)
Before You Start
Who is this guide for?
- Users who are new to qData and want to try its features quickly
- Users who do not want to configure the environment, initialize databases, and start services one by one
- Users who want to start the complete platform with a single script
Check before use
- The deployment downloads Docker images from the internet. Make sure the image registries are accessible.
- In mainland China, configure an available Docker registry mirror in advance.
- When using Docker Desktop on Windows, switch to Linux Containers mode.
Docker images support two architectures
The Docker images used by this deployment package support both amd64 (x86_64) and arm64. When pulling images, Docker automatically detects the host CPU architecture and selects the matching image. You do not need to switch image tags manually.
The deployment package includes:
- ✅ Frontend static assets (the packaged
distfolder) - ✅ DolphinScheduler scheduler
- ✅ Hadoop (HDFS + YARN)
- ✅ Spark 3.5.6
- ✅ Preset
.envenvironment file - ✅ The complete directory structure, Docker Compose configuration, and one-click scripts
You do not need to build the frontend or initialize the database manually. Install Docker, extract the deployment package, and run the appropriate script.
Python 3 is already installed in the Docker image. You do not need to install Python separately on the host.
Step 1: Install Docker and Docker Compose
qData runs in Docker containers. Docker must be installed and running before deployment.
- Docker: ≥ v20.10
- Docker Compose: ≥ v2.20.2
Download and install Docker Desktop. Docker Compose is included with Docker Desktop and does not need to be installed separately.
Follow the official Docker documentation to install Docker Engine and the Docker Compose Plugin. You can also use the Docker installation files included in the deployment package.
After installation, run these commands to verify it:
docker version
docker compose versionStep 2: Download the Deployment Package
🔗 Baidu Netdisk: https://pan.baidu.com/s/1sKgeBnMZmRnIr42_pVHmiw
🔑 Extraction code: Join the QQ community group and find it in the group files. 👉 Join the QQ community group
After downloading and extracting the package, enter its docker folder to run the scripts.
Step 3: Run the One-Click Script
3.1 Linux / macOS
Linux and macOS use qdata.sh, which supports lightweight startup, full startup, and uninstallation.
| Command | Purpose |
|---|---|
sh qdata.sh start light --demo | Starts the lightweight qData environment and the demo database, without DolphinScheduler or Spark |
sh qdata.sh start all --demo | Starts the full qData environment and the demo database |
sh qdata.sh uninstall | Uninstalls qData and deletes its containers, data, and related images |
Start
Open a terminal in the docker folder and run:
# Lightweight startup
sh qdata.sh start light --demo
# Full startup
sh qdata.sh start all --demoUninstall
sh qdata.sh uninstallEnter DELETE QDATA when prompted to confirm.
Caution
Uninstallation deletes the qData containers and runtime data. Back up any data you need to keep first.
3.2 Windows
Windows provides three scripts:
| Script | Purpose | Difference |
|---|---|---|
start-light.bat | Starts lightweight qData | Does not start DolphinScheduler or Spark, so startup is faster and uses fewer resources |
start-all.bat | Starts full qData | Starts DolphinScheduler, Spark, and all other dependency services |
uninstall.bat | Uninstalls qData | Deletes containers, data, and related images |
How to run the scripts
Open the deployment package's docker folder and double-click the required .bat file.
You can also run it in PowerShell or CMD:
# Start the lightweight version
.\start-light.bat
# Start the full version
.\start-all.bat
# Uninstall
.\uninstall.batWhich startup script should I choose?
- To try qData quickly, run
start-light.bat. - To use the complete features, including DolphinScheduler and Spark, run
start-all.bat.
When uninstalling, enter DELETE QDATA when prompted. Uninstallation deletes the qData containers and runtime data, so back up anything you need to keep first.
Deployment Complete! 🎉
After deployment, use these addresses:
🌐 qData Data Platform
http://<server-ip>:80
Username:admin
Password:qData123📅 DolphinScheduler
http://<server-ip>:12345/dolphinscheduler/ui/home
Username:admin
Password:dolphinscheduler123
⚠️ DolphinScheduler starts only in the full version.
🔑 Replace
<server-ip>with the public or private IP address of your server.
💡 Important
- After the first startup, wait 1–2 minutes for all containers to finish initializing.
- Run
docker psto check container status. - If qData is inaccessible, check whether port
80is open in the server firewall.
