RuoYi AI

🚀 Live Demo

✨ Core Features

Project Repositories

Partner Projects

🛠️ Technical Architecture

Core Framework

• Backend: Spring Boot 3.5.8 + Langchain4j
• Data Storage: MySQL 8.0 + Redis + Vector Databases (Milvus/Weaviate/Qdrant)
• Frontend: Vue 3 + Vben Admin + element-plus-x
• Security: Sa-Token + JWT dual-layer security
• Document Processing: PDF, Word, Excel parsing, intelligent image analysis
• Real-time Communication: WebSocket real-time communication, SSE streaming response
• System Monitoring: Comprehensive logging system, performance monitoring, service health checks

🐳 Docker Deployment

This project provides two Docker deployment methods:

Method 1: One-click Start All Services (Recommended)

Use docker-compose-all.yaml to start all services at once (including backend, admin panel, user frontend, and dependencies):

Requirements

• Docker Engine（Linux/macOS）或 Docker Desktop（Windows）
• Docker Compose V2

Linux / macOS

# Clone the v3.1.0 release
git clone --depth 1 --branch v3.1.0 https://github.com/ageerle/ruoyi-ai.git
cd ruoyi-ai

# Pin the image version. Public GHCR images do not require docker login.
cp docs/docker/ruoyi-ai/.env.example docs/docker/ruoyi-ai/.env
sed -i 's/^RUIYI_VERSION=.*/RUIYI_VERSION=v3.1.0/' docs/docker/ruoyi-ai/.env

# Pull pre-built images from GHCR and start all services
docker compose --env-file docs/docker/ruoyi-ai/.env \
  -f docs/docker/ruoyi-ai/docker-compose-all.yaml pull
docker compose --env-file docs/docker/ruoyi-ai/.env \
  -f docs/docker/ruoyi-ai/docker-compose-all.yaml up -d

# Check service status
docker compose --env-file docs/docker/ruoyi-ai/.env \
  -f docs/docker/ruoyi-ai/docker-compose-all.yaml ps

# Access services (replace SERVER_IP with the server address)
# Admin Panel: http://SERVER_IP:25666 (admin / admin123)
# User Frontend: http://SERVER_IP:25137
# Backend API: http://SERVER_IP:26039

Windows PowerShell

If you are using Windows with Docker Desktop, you can use PowerShell to execute the following commands:

# Clone the v3.1.0 release
git clone --depth 1 --branch v3.1.0 https://github.com/ageerle/ruoyi-ai.git
cd ruoyi-ai

# Create the environment configuration file
Copy-Item docs\docker\ruoyi-ai\.env.example docs\docker\ruoyi-ai\.env

# Pin the image version
(Get-Content docs\docker\ruoyi-ai\.env) `
  -replace '^RUIYI_VERSION=.*', 'RUIYI_VERSION=v3.1.0' |
  Set-Content docs\docker\ruoyi-ai\.env

# Check the environment configuration
Get-Content docs\docker\ruoyi-ai\.env

# Pull pre-built images from GHCR and start all services
docker compose --env-file docs\docker\ruoyi-ai\.env `
  -f docs\docker\ruoyi-ai\docker-compose-all.yaml pull
docker compose --env-file docs\docker\ruoyi-ai\.env `
  -f docs\docker\ruoyi-ai\docker-compose-all.yaml up -d

# Check service status
docker compose --env-file docs\docker\ruoyi-ai\.env `
  -f docs\docker\ruoyi-ai\docker-compose-all.yaml ps

The default Compose file also publishes MySQL (23306), Redis (26379), Weaviate (28080), and MinIO (29000/29090). For production deployments, change the default MySQL and MinIO passwords and expose only the application ports through the firewall or a reverse proxy.

To upgrade to another published release, update RUIYI_VERSION in docs/docker/ruoyi-ai/.env, then run docker compose pull and docker compose up -d with the same --env-file and -f options. Do not use docker compose down -v unless you intend to delete persistent data volumes.

Method 2: Step-by-step Deployment (Source Build)

If you need to build backend services from source, follow these steps:

Step 1: Deploy Backend Service

# Enter backend project directory
cd ruoyi-ai

# Start backend service (build from source)
docker-compose up -d --build

# Wait for backend service to start
docker-compose logs -f backend

Step 2: Deploy Admin Panel

# Enter admin panel project directory
cd ruoyi-admin

# Build and start admin panel
docker-compose up -d --build

# Access admin panel
# URL: http://localhost:5666

Step 3: Deploy User Frontend (Optional)

# Enter user frontend project directory
cd ruoyi-web

# Build and start user frontend
docker-compose up -d --build

# Access user frontend
# URL: http://localhost:5137

Service Ports

📚 Documentation

Want to learn more about installation, deployment, configuration, and secondary development?

👉 Complete Documentation

• Model and API Key configuration in ruoyi-admin (Chinese)
• Dify Cloud setup for local development (Chinese)

🤝 Contributing

We warmly welcome community contributions! Whether you are a seasoned developer or just getting started, you can contribute to the project 💪

How to Contribute

1. Fork the project to your account
2. Create a branch (git checkout -b feature/new-feature-name)
3. Commit your changes (git commit -m 'Add new feature')
4. Push to the branch (git push origin feature/new-feature-name)
5. Create a Pull Request

💡 Tip: We recommend submitting PRs to GitHub, we will automatically sync to other code hosting platforms

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

Thanks to the following excellent open-source projects for their support:

• Langchain4j - Powerful Java LLM development framework
• RuoYi-Vue-Plus - Mature enterprise-level rapid development framework
• Vben Admin - Modern Vue admin template

💎 Sponsors

Thanks to the following sponsors for supporting this project:

Visit Atlas Cloud · Coding Plan Promotion A full-modal AI inference platform that gives developers a unified AI API, supporting video generation, image generation, and LLMs. Connect once to access 300+ curated models.

Sign up to claim 25 million tokens — go now Enjoy ByteDance's in-house Doubao models plus full-power open-source SOTA models, covering text, VLM, and image generation — all modalities in one stop: Seed-2.1, Seedream-5.0, GLM-5.2, DeepSeek, and more. Not just for coding — it can also tackle complex long-horizon Agent tasks!

💬 Community Chat

---