Quick Deployment Guide (Docker Compose)

Qiantong Technology11/2/26About 2 minDeploymentOne-click startupQuick Start

Before you start

Who is this guide for?

Users trying qOntology for the first time
Users who want to avoid configuring environments, initializing databases, and starting each service manually
Users who want to start the complete platform with a script

Check before deployment

Deployment downloads Docker images. Make sure the host can reach the image registries.
In mainland China, configure an accessible Docker registry mirror beforehand.
On Windows, switch Docker Desktop to Linux Containers mode.

Docker image architecture

The bundled MySQL 5.7 image uses amd64 (x86_64). An arm64 host requires emulation to run it. Make sure Docker has the required support enabled.

The deployment package includes:

✅ Frontend static assets (the built dist folder)
✅ qOntology backend services
✅ MySQL, Redis, and Neo4j
✅ Nginx and the file preview service
✅ A preset .env file
✅ The complete directory structure, Docker Compose configuration, and startup scripts

You do not need to build the frontend or initialize the database manually. Install Docker, extract the package, and run the appropriate script.

Step 1: Install Docker and Docker Compose

qOntology runs in Docker containers. Install and start Docker first.

Docker: ≥ v20.10
Docker Compose: ≥ v2.20.2

🖥️ Windows / macOS

Install Docker Desktop. Docker Compose is included.

🐧 Linux

Follow the Docker documentation to install Docker Engine and the Docker Compose Plugin.

Verify the installation:

docker version
docker compose version

Step 2: Download the deployment package

🔗 Baidu Netdisk: https://pan.baidu.com/s/1Lw8a4GX2G0m2c7u9CfAC9g

🔑 Access code: Join the QQ group and find the code in the group files. 👉 Join the QQ group

Extract the package and run the scripts from its docker folder.

Step 3: Run the scripts

3.1 Linux / macOS

Use qontology.sh to start or uninstall the platform.

Command	Purpose
`sh qontology.sh start`	Check the environment, prepare images, and start qOntology and its supporting services
`sh qontology.sh uninstall`	Remove qOntology containers and networks while preserving volumes and mounted data

Start

Open a terminal in the docker folder and run:

# Start qOntology
sh qontology.sh start

Uninstall

sh qontology.sh uninstall

Enter DELETE QONTOLOGY when prompted to confirm.

Caution

Uninstalling removes qOntology containers and networks but preserves volumes and mounted data. Back up any data you need first.

3.2 Windows

Two scripts are provided:

Script	Purpose	Behavior
`start-all.bat`	Start qOntology	Check the environment, initialize the database, and start the platform and supporting services
`uninstall.bat`	Uninstall qOntology	Remove containers, networks, volumes, runtime data, and related images not used by other containers

Run a script

Open the package's docker folder and double-click the required .bat file.

Alternatively, run it in PowerShell or CMD:

# Start qOntology
.\start-all.bat

# Uninstall
.\uninstall.bat

Which script should I use?

Start qOntology: double-click start-all.bat.
Fully uninstall qOntology: double-click uninstall.bat.

Enter DELETE QONTOLOGY when prompted during uninstall. The Windows full uninstall removes containers, networks, volumes, and runtime data. Back up any data you need first.

Deployment complete! 🎉

Access the platform at:

🌐 qOntology Ontology Engineering Platform

http://<SERVER_IP>:8897

Username: qOntology

Password: qOntology123

🔑 Replace <SERVER_IP> with the host's public or private IP address. The access port is set by EXPOSE_NGINX_PORT in the package's .env file. Credentials depend on the initialization data.

💡 Important reminders

After the first startup, wait 1–2 minutes for all containers to initialize.
Use docker ps to check container status.
If the platform is unreachable, check whether the host firewall allows port 8897 (or the configured access port).