RuleGo
STDIOLightweight automation workflow platform for iPaaS, API orchestration, and AI integration.
Lightweight automation workflow platform for iPaaS, API orchestration, and AI integration.
English | 简体中文
Official Website | Docs | Contribution Guide
RuleGo-Server is a lightweight, high-performance, modular, and integration-friendly automation workflow platform built on RuleGo.
It can be used for automation orchestration, iPaaS (Integration Platform as a Service), API orchestration, application orchestration, AI orchestration, data processing, IoT rule engine, AI assistant, and other scenarios.
This project supports multi-tenancy/users, with isolated rule chain data for each user. User data is stored in the data/workflows/{username} directory.
User permission verification is disabled by default, and all operations are performed as the default user. To enable permission verification:
# Whether to enable JWT authentication for APIs. If disabled, operations will be performed as the default user (admin) require_auth = true # JWT secret key jwt_secret_key = r6G7qZ8xk9P0y1Q2w3E4r5T6y7U8i9O0pL7z8x9CvBnM3k2l1 # JWT expiration time jwt_expire_time = 43200000 # JWT issuer jwt_issuer = rulego.cc # User list # Configure usernames and passwords in the format username=password[,apiKey]. The apiKey is optional. # If apiKey is configured, the caller can access other interfaces directly using the apiKey without logging in. [users] admin = admin user01 = user01
The frontend obtains a token through the login interface (/api/v1/login), then accesses other interfaces using the token. Example:
curl -H "Authorization: Bearer token" http://localhost:8080/api/resource
api_key method. Example:# Whether to enable JWT authentication for APIs. If disabled, operations will be performed as the default user (admin) require_auth = true # User list # Configure usernames and passwords in the format username=password[,apiKey]. The apiKey is optional. # If apiKey is configured, the caller can access other interfaces directly using the apiKey without logging in. [users] admin = admin,2af255ea-5618-467d-914c-67a8beeca31d user01 = user01
Then access other interfaces using the token. Example:
curl -H "Authorization: Bearer apiKey" http://localhost:8080/api/resource
To save the size of the compiled file, the extension component rulego-components is not included by default. Default compilation:
cd cmd/server go build .
If you need to include the extension component rulego-components, compile with the with_extend tag:
cd cmd/server go build -tags with_extend .
Other extension component library tags:
with_extend tag for compilation:with_ai tag for compilationwith_ci tag for compilationwith_iot tag for compilationwith_etl tag for compilationendpoint/http and restApiCall components with fasthttp, and compile with the use_fasthttp tag.If you need to include multiple extension component libraries at the same time, you can compile with the go build -tags "with_extend,with_ai,with_ci,with_iot,with_etl" tag.
./server -c="./config.conf"
Or start in the background:
nohup ./server -c="./config.conf" >> console.log &
Details: UI
Rename the compiled ui directory to editor and place it in the root directory, then run server.
RuleGo-Server supports MCP (Model Context Protocol). When enabled, the system automatically registers all registered components, rule chains, and APIs as MCP tools. This allows AI assistants (such as Windsurf, Cursor, Codeium, etc.) to directly call these tools through the MCP protocol, achieving deep integration with application systems. Documentation: rulego-server-mcp
config.conf
# Data directory data_dir = ./data # Whitelist for cmd component commands cmd_white_list = cp,scp,mvn,npm,yarn,git,make,cmake,docker,kubectl,helm,ansible,puppet,pytest,python,python3,pip,go,java,dotnet,gcc,g++,ctest # Whether to load third-party Lua libraries load_lua_libs = true # HTTP server server = :9090 # Default user default_username = admin # Whether to log node execution logs to the log file debug = true # Maximum node log size, default 40 max_node_log_size =40 # Resource mapping, supports wildcards, multiple mappings separated by commas, format: /url/*filepath=/path/to/file resource_mapping = /editor/*filepath=./editor,/images/*filepath=./editor/images # Node pool file, in rule chain JSON format, example: ./node_pool.json node_pool_file=./node_pool.json # Save run log to file save_run_log = false # Maximum script execution time script_max_execution_time = 5000 # Whether to enable JWT authentication for APIs require_auth = false # JWT secret key jwt_secret_key = r6G7qZ8xk9P0y1Q2w3E4r5T6y7U8i9O0pL7z8x9CvBnM3k2l1 # JWT expiration time, in milliseconds jwt_expire_time = 43200000 # JWT issuer jwt_issuer = rulego.cc # MCP server configuration [mcp] # Whether to enable the MCP service enable = true # Whether to use components as MCP tools load_components_as_tool = true # Whether to use rule chains as MCP tools load_chains_as_tool = true # Whether to add a rule chain API tool load_apis_as_tool = true # Exclude component list exclude_components = comment,iterator,delay,groupAction,ref,fork,join,*Filter # Exclude rule chain list exclude_chains = # pprof configuration [pprof] # Whether to enable pprof enable = false # pprof address addr = 0.0.0.0:6060 # Global custom configuration, components can access values using ${global.xxx} [global] # Example sqlDriver = mysql sqlDsn = root:root@tcp(127.0.0.1:3306)/test # User list # Configure usernames and passwords in the format username=password[,apiKey]. The apiKey is optional. # If apiKey is configured, the caller can access other interfaces directly using the apiKey without logging in. [users] admin = admin,2af255ea5618467d914c67a8beeca31d user01 = user01,2af255ea5618467d914c67a8beeca51c
Email: [email protected]