FAQ.md
A: ā Not yet! The open-source version of Astron RPA client currently only supports Windows systems.
Supported Systems:
A: ā Yes! RPA currently doesn't have a web version and requires a client to run.
A: ā No! You can download the msi installer package directly from the Release version and install it directly.
A:
Best for production environments, the fastest and simplest update method.
# 1. Stop old containers
docker-compose down
# 2. Remove old images (optional, to clean up local images)
docker rmi ghcr.io/iflytek/astron-rpa/openapi-service:latest
docker rmi ghcr.io/iflytek/astron-rpa/ai-service:latest
docker rmi ghcr.io/iflytek/astron-rpa/robot-service:latest
# 3. Start new containers and automatically download latest images
docker-compose up -d
Allows customization, suitable for development and testing environments.
# 1. Pull the latest code
git pull origin main
# 2. Enter docker directory
cd docker
# 3. Edit docker-compose.yml
# - Comment out the image line
# - Uncomment the build section
# Example configuration:
# services:
# openapi-service:
# # image: ghcr.io/iflytek/astron-rpa/openapi-service:latest
# build:
# context: ..
# dockerfile: backend/openapi-service/Dockerfile
# 4. Build and start locally
docker-compose up -d --build
# 5. Wait for build to complete (may take several minutes)
docker-compose logs -f
š” Update Tips:
- Method 1ļøā£ is fastest, suitable for production
- Method 2ļøā£ allows customization, suitable for developers
- Database data is preserved during updates (mysql container data in volumes)
Quickly update database schema by starting the ATLAS container for automatic migration.
# 1. Start the ATLAS container for database migration
docker-compose up -d atlas
# 2. View ATLAS migration logs (ensure migration succeeded)
docker-compose logs -f atlas
š” About ATLAS:
- ATLAS is a database version management tool for automatically executing database migration scripts
- Each server update may include database schema changes that need to be applied via ATLAS
- Existing data in the database is preserved; only table structures and schema are updated
Quick development iteration, only updating specific packages.
If you've modified Python packages in the engine directory (such as workflowlib, executor, etc.), you can copy them directly to the client's Python environment:
# Example: updating workflowlib
# 1. Find the source code location
# engine/shared/astronverse-workflowlib
# 2. Copy to client installation directory
# From: \astron-rpa\engine\shared\astronverse-workflowlib\src\astronverse\workflowlib
# To: C:\Program Files\Astron RPA\data\python_core\Lib\site-packages\astronverse\workflowlib
Common Packages and Locations:
| š¦ Package | š Source Code Location | šÆ Target Location |
|---|---|---|
| workflowlib | engine/shared/astronverse-workflowlib/src/astronverse/workflowlib | <install_dir>/data/python_core/Lib/site-packages/astronverse/workflowlib |
| executor | engine/servers/astronverse-executor/src/astronverse/executor | <install_dir>/data/python_core/Lib/site-packages/astronverse/executor |
| browser | engine/components/astronverse-browser/src/astronverse/browser | <install_dir>/data/python_core/Lib/site-packages/astronverse/browser |
| other packages | engine/<?>/astronverse-*/src/astronverse/* | <install_dir>/data/python_core/Lib/site-packages/astronverse/* |
š” Restart Tip:
- If updating packages in Servers, you need to restart the client to load the new packages
Use this when updating multiple packages or need a complete version update.
If you've made extensive changes or want to fully update the client, you can use build.bat to package a new client msi installer:
# 1. Run in the project root directory
.\build.bat
# 2. Wait for build to complete (may take 10-30 minutes)
# New msi installer will be generated in build/dist/ directory
# 3. Use the newly generated msi installer to reinstall
# - Run build/dist/*.msi file directly
# - Or replace it in the release directory for other users to download
| š Update Method | šÆ Use Case | ā” Speed | š Complexity |
|---|---|---|---|
| Copy Python packages directly | Quick dev iteration, only update specific packages | š Fast | š¢ Simple |
| Repackage msi | Multiple packages update, need complete version | š¢ Slow | š” Medium |
| Download new Release | New version release, production environment | š Medium | š¢ Simple |
š” Best Practices:
- šØ Development Phase ā Use "Copy packages" for quick iteration
- ā Feature Complete ā Use "build.bat" to package as complete installer
- š Production ā Use official Release version
A:
Here are some situations encountered in practice:
ā Symptom: Client hangs on loading page
ā
Solution: After installation, modify the server address in resources/conf.yaml in the installation directory:
# 32742 is the default port, change if modified
remote_addr: http://YOUR_SERVER_ADDRESS:32742/
skip_engine_start: false
ā Symptom: Newly started service is still initializing
ā Solution: Wait a while and then restart the client
ā Symptom: Authentication service cannot be accessed
ā Solution:
# Modify casdoor service configuration in .env (8000 is the default port)
CASDOOR_EXTERNAL_ENDPOINT="http://{YOUR_SERVER_IP}:8000"
A:
š“ Most likely you haven't installed the browser plugin
For more web automation information, see the Official Guide
A:
Before using AI atomic capabilities, you need to configure the corresponding AI parameters when deploying the server.
# Large model URL and corresponding API_KEY (compatible with OpenAI format)
AICHAT_BASE_URL="https://api.deepseek.com/v1/"
AICHAT_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxx"
# Iflytek Cloud OCR authentication method (get from official website)
XFYUN_APP_ID=dxxxxx38
XFYUN_API_SECRET=ZTFxxxxxxxxxxxxxxxxNDVm
XFYUN_API_KEY=c4xxxxxxxxxxxxxxxx8a7
# Yunma CAPTCHA authentication method
JFBYM_ENDPOINT="http://api.jfbym.com/api/YmServer/customApi"
JFBYM_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
ā ļø Important: Restart the server after configuration to ensure it takes effect
A:
For external calls, the official documentation has detailed descriptions and API documentation.
The only thing to note is that all URLs need to be changed from the official domain to your own server domain.
# Official version:
https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get
# Open-source version:
http://{IP_ADDRESS}:32742/api/rpa-openapi/workflows/get
š Reminder: All robots that need to be called externally need to be published in the designer first, then configured for external calls in the executor
A:
When encountering problems, query the server and engine logs:
# 1ļøā£ Query Docker logs
docker ps -a
docker logs [container_name] > logs.txt
# 2ļøā£ Query client logs
# Logs are saved in: installation_directory\data\logs
# If software is installed on C drive: %APPDATA%\astron-rpa\logs
| Channel | Link | Response Time |
|---|---|---|
| š GitHub Issues | Submit Issue | 24-48 hours |
| š¬ Discussions | Discussion Forum | Within a week |
| Version | Date | Content |
|---|---|---|
| v1.0 | 2025-11-26 | Initial Release |
| v1.1 | TBD | Will add more FAQs |
ā° Last Updated: 2025-11-26
š¤ Maintainer: DoctorBruce
š License: Apache-2.0