Rulego Server

🚀 Server Side

This project provides a server - side configuration solution, which can be customized through a configuration file to meet different business needs, such as setting data directories, command whitelists, and authentication information.

🚀 Quick Start

Configuration File Parameters

config.conf

# Data directory
data_dir = ./data
# Command white list for command - line components
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 username
default_username = admin
# Whether to record node execution logs to a log file
debug = true
# Maximum node log size, default is 40
max_node_log_size =40
# Resource mapping, supporting 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 the rule chain JSON format, example: ./node_pool.json
node_pool_file=./node_pool.json
# Whether to save runtime logs to a file
save_run_log = false
# Maximum script execution time
script_max_execution_time = 5000
# Whether to enable JWT authentication
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 load components as MCP tools
load_components_as_tool = true
# Whether to load rule chains as MCP tools
load_chains_as_tool = true
# Whether to add rule chain API tools
load_apis_as_tool = true
# List of excluded components
exclude_components = comment,iterator,delay,groupAction,ref,fork,join,*Filter
# List of excluded rule chains
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 through ${global.xxx}
[global]
# Example
sqlDriver = mysql
sqlDsn = root:root@tcp(127.0.0.1:3306)/test

# User list
# Configure the username and password in the format of username=password[,apiKey]. apiKey is optional.
# If apiKey is configured, the caller can directly access the interface through apiKey without authentication.
[users]
admin = admin,2af255ea5618467d914c67a8beeca31d
user01 = user01,2af255ea5618467d914c67a8beeca51c

📞 Contact Us

Email: rulego@outlook.com