AstronAgent Complete Deployment Guide

This guide will help you start all components of the AstronAgent project in the correct order, including authentication, knowledge base, and core services.

📋 Project Architecture Overview

The AstronAgent project consists of the following three main components:

Casdoor - Identity authentication and single sign-on service (required component, provides SSO functionality)
RagFlow - Knowledge base and document retrieval service (optional component, deploy as needed)
AstronAgent - Core business service cluster (required component)

🚀 Deployment Steps

Prerequisites

Agent System Requirements

CPU >= 2 Core
RAM >= 4 GiB
Disk >= 50 GB

RAGFlow Requirements

CPU >= 4 Core
RAM >= 16 GB
Disk >= 50 GB

Step 1: Start RagFlow Knowledge Base Service (Optional, deploy as needed)

RagFlow is an open-source RAG (Retrieval-Augmented Generation) engine that provides accurate question-answering services using deep document understanding technology.

To start the RagFlow service, run our docker-compose.yml file or docker-compose-macos.yml. Before running the installation commands, please ensure that Docker and Docker Compose are installed on your machine.

bash

# Navigate to RagFlow directory
cd docker/ragflow

# Add executable permissions to all sh files
chmod +x *.sh

# Start RagFlow service (including all dependencies)
docker compose up -d

# Check service status
docker compose ps

# View service logs
docker compose logs -f ragflow

Access Address:

RagFlow Web Interface: http://localhost:18080

Model Configuration Steps:

Click on your avatar to enter the Model Providers page, select Add Model, fill in the corresponding API address and API Key, and add both Chat model and Embedding model respectively.
In the upper right corner of the same page, click Set Default Models to set the Chat model and Embedding model added in the first step as defaults.

Important Configuration Notes:

Elasticsearch is used by default. To use opensearch or infinity, modify the DOC_ENGINE configuration in .env
GPU acceleration is supported, start with docker-compose-gpu.yml

Step 2: Configure AstronAgent Environment Variables

Before starting AstronAgent services, you need to configure the relevant connection information.

bash

# Navigate to astronAgent directory
cd docker/astronAgent

# Copy environment variable configuration
cp .env.example .env

The .env file is only used for startup, access addresses, authentication, database, Redis, object storage, and other infrastructure settings. Business capability accounts such as RAGFlow, iFLYTEK Open Platform, AI Ability Chat, Virtual Man, and Spark Knowledge Base are no longer configured in .env. Configure them in Platform Account Management after AstronAgent starts.

2.1 Configure Service Host Address

bash

# Navigate to astronAgent directory
cd docker/astronAgent

# Edit environment variable configuration
vim .env

Configure the AstronAgent service host address:

env

HOST_BASE_ADDRESS=http://localhost

Notes:

If you use a domain name for access, replace localhost with your domain name
Ensure nginx and minio ports are properly exposed

2.2 Prepare Business Capability Account Information (configure in the UI after startup)

The following settings do not need to be written to .env. After AstronAgent starts, log in to the console and open Platform Account Management from the left menu. Fill in the corresponding cards; after saving, the configuration takes effect globally without restarting containers. If a feature depends on a capability that has not been configured, the system will prompt the user to configure it in Platform Account Management and will not block system startup.

iFLYTEK Open Platform (used by built-in Spark model, real-time speech recognition, image generation, and related capabilities):

For documentation, see: https://www.xfyun.cn/doc/platform/quickguide.html

After creating your application, you may need to purchase or claim API authorization service quotas for the corresponding capabilities:

Spark LLM API: https://xinghuo.xfyun.cn/sparkapi (For the LLM API, you'll need an additional SPARK_API_PASSWORD available on the page : https://console.xfyun.cn/services/bm4)
Real-time Speech Recognition API: https://console.xfyun.cn/services/rta
Image Generation API: https://www.xfyun.cn/services/wtop

Prepare and fill in the following fields in the UI:

PLATFORM_APP_ID
PLATFORM_API_KEY
PLATFORM_API_SECRET
SPARK_API_PASSWORD
SPARK_RTASR_API_KEY

AI Ability Chat (default Agent model interface, OpenAI protocol):

AI_ABILITY_CHAT_BASE_URL
AI_ABILITY_CHAT_MODEL
AI_ABILITY_CHAT_API_KEY

Virtual Man capability:

SPARK_VIRTUAL_MAN_APP_ID
SPARK_VIRTUAL_MAN_API_KEY
SPARK_VIRTUAL_MAN_API_SECRET

Knowledge Base Platform:

RAGFlow: RAGFLOW_BASE_URL, RAGFLOW_API_TOKEN, RAGFLOW_TIMEOUT, RAGFLOW_DEFAULT_GROUP
Spark Knowledge Base: XINGHUO_DATASET_ID

When creating a knowledge base, users choose RAGFlow or Spark Knowledge Base. Only the platform actually used needs to be configured.

Obtaining RagFlow API Token:

Visit RagFlow Web Interface: http://localhost:18080
Log in and click on your avatar to enter user settings
Click API to generate an API KEY
Fill it in as RAGFLOW_API_TOKEN under Platform Account Management - Knowledge Base Platform

Obtaining Spark Knowledge Base Dataset ID:

Spark RAG cloud service provides two usage methods:

Method 1: Obtain from the Web Interface

Use the APP_ID and API_SECRET created on the iFLYTEK Open Platform
Directly obtain the Spark dataset ID from the web interface, see: xinghuo_rag_tool.html

Method 2: Using cURL Command Line

If you prefer using command-line tools, you can create a dataset with the following cURL command:

bash

# Create Spark RAG dataset
curl -X PUT 'https://chatdoc.xfyun.cn/openapi/v1/dataset/create' \
    -H "Accept: application/json" \
    -H "appId: your_app_id" \
    -H "timestamp: $(date +%s)" \
    -H "signature: $(echo -n "$(echo -n "your_app_id$(date +%s)" | md5sum | awk '{print $1}')" | openssl dgst -sha1 -hmac 'your_api_secret' -binary | base64)" \
    -F "name=我的数据集"

Notes:

Please replace your_app_id with your actual APP ID
Please replace your_api_secret with your actual API Secret

After obtaining the dataset ID, fill it in as XINGHUO_DATASET_ID under Platform Account Management - Knowledge Base Platform.

Step 3: Start AstronAgent Core Services (Including Casdoor Authentication Service)

To start AstronAgent services, run our docker-compose-with-auth.yaml file. This file has integrated the Casdoor authentication service through the include mechanism and will automatically start Casdoor.

bash

# Navigate to astronAgent directory
cd docker/astronAgent

# Start all services (including Casdoor)
docker compose -f docker-compose-with-auth.yaml up -d

Note:

Default Casdoor login credentials: username: admin, password: 123

Step 4: Configure Platform Account Management (Optional, configure business capabilities as needed)

After AstronAgent starts, access the console and log in. Open Platform Account Management from the left menu. Platform Account Management is at the same menu level as Application Management and Resource Management, and contains the following four configuration cards:

iFLYTEK Open Platform: fill in PLATFORM_APP_ID, PLATFORM_API_KEY, PLATFORM_API_SECRET, SPARK_API_PASSWORD, SPARK_RTASR_API_KEY
AI Ability Chat: fill in AI_ABILITY_CHAT_BASE_URL, AI_ABILITY_CHAT_MODEL, AI_ABILITY_CHAT_API_KEY
Virtual Man capability: fill in SPARK_VIRTUAL_MAN_APP_ID, SPARK_VIRTUAL_MAN_API_KEY, SPARK_VIRTUAL_MAN_API_SECRET
Knowledge Base Platform: fill in RAGFlow fields RAGFLOW_BASE_URL, RAGFLOW_API_TOKEN, RAGFLOW_TIMEOUT, RAGFLOW_DEFAULT_GROUP, and Spark Knowledge Base field XINGHUO_DATASET_ID

After saving, the configuration takes effect globally immediately. The system automatically refreshes the cache, and AstronAgent containers do not need to be restarted.

Step 5: Modify Casdoor Authentication (Optional)

You can create new applications and organizations in Casdoor as needed, and update the configuration information in the .env file (default organization and application already exist).

5.1 Configure Casdoor Application

Obtaining Casdoor Configuration Information:

Visit the Casdoor management console: http://localhost:8000
Log in with the default administrator account: admin / 123
Create Organization Go to the http://localhost:8000/organizations page, click "Add", fill in the organization name, save and exit.
Create Application and Bind Organization Go to the http://localhost:8000/applications page, click "Add".

When creating the application, fill in the following information:
- Name: Custom application name, e.g., agent
- Redirect URL: Set to the project's callback address. If the Nginx exposed port is 80, use http://your-local-ip/callback; if it's another port (e.g., 888), use http://your-local-ip:888/callback
- Organization: Select the organization name you just created
After saving the application, record the following information and map it to the project configuration items:

Casdoor Information Item	Example Value	Corresponding `.env` Configuration Item
Casdoor Service Address (URL)	`http://localhost:8000`	`CONSOLE_CASDOOR_URL=http://localhost:8000`
Client ID	`your-casdoor-client-id`	`CONSOLE_CASDOOR_ID=your-casdoor-client-id`
Application Name (Name)	`your-casdoor-app-name`	`CONSOLE_CASDOOR_APP=your-casdoor-app-name`
Organization Name (Organization)	`your-casdoor-org-name`	`CONSOLE_CASDOOR_ORG=your-casdoor-org-name`

Fill in the above configuration information into the project's environment variable file:

bash

# Navigate to astronAgent directory
cd docker/astronAgent

# Edit environment variable configuration
vim .env

Add or update the following configuration items in the .env file:

env

# Casdoor Configuration
CONSOLE_CASDOOR_URL=http://localhost:8000
CONSOLE_CASDOOR_ID=your-casdoor-client-id
CONSOLE_CASDOOR_APP=your-casdoor-app-name
CONSOLE_CASDOOR_ORG=your-casdoor-org-name

Restart AstronAgent services to apply the new configuration:

bash

docker compose restart console-frontend console-hub

📊 Service Access Addresses

After startup, you can access the services at the following addresses:

Authentication Service

Casdoor Admin Interface: http://localhost:8000

Knowledge Base Service

RagFlow Web Interface: http://localhost:18080

AstronAgent Core Services

Console Frontend (nginx proxy): http://localhost/

📚 Additional Resources

🤝 Technical Support

If you encounter issues, please:

Check the log files of related services
Review the official documentation and troubleshooting guides
Submit an Issue on the project's GitHub repository
Contact the technical support team

Note: For first-time deployment, it is recommended to verify all functionalities in a test environment before deploying to production.