Skip to content

Commit 9467941

Browse files
committed
docs: update installation documentation with configuration notes for MySQL and Redis
1 parent a70d0bd commit 9467941

File tree

3 files changed

+84
-41
lines changed

3 files changed

+84
-41
lines changed

manual/installation/1panel_installtion.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
点击开始安装后,页面自动跳转到已安装应用列表,等待安装的 Cordys CRM 应用状态变为已启动。
2424

25+
:warning: **注意:** 如需修改 MySQL,Redis 相关配置参数请参考[**在线一键安装**](../installation/online_installtion.md/#_2) 文档。
26+
27+
2528
![Cordys CRM安装状态](../img/installation/crm_success.png)
2629

2730
!!! Abstract ""

manual/installation/offline_installtion.md

Lines changed: 43 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -44,48 +44,50 @@
4444

4545
Cordys CRM 安装目录、服务运行端口、数据库配置等信息可在安装包解压后中的 install.conf 文件进行配置。
4646

47+
:warning: **注意:** 这部分参数仅限于离线包安装使用,在线安装请参考[**在线一键安装**](../installation/online_installtion.md/#_2) 文档。
48+
4749
```
48-
# 基础配置
49-
## 安装路径, Cordys CRM 配置及数据文件默认将安装在 ${CORDYS_BASE}/cordys 目录下
50-
CORDYS_BASE=/opt
51-
## Cordys CRM 使用的 docker 网络网段信息
52-
CORDYS_DOCKER_SUBNET=172.30.10.0/24
53-
## 镜像前缀
54-
CORDYS_IMAGE_PREFIX='registry.fit2cloud.com/cordys'
55-
## 镜像相关
56-
CORDYS_IMAGE_NAME=cordys-crm-ce
57-
CORDYS_IMAGE_TAG=v1.0.0
58-
59-
## CORDYS 主程序的 HTTP 服务监听端口
60-
CORDYS_SERVER_PORT=8081
61-
62-
# 数据库配置
63-
## 是否使用外部数据库
64-
CORDYS_EXTERNAL_MYSQL=false
65-
## 数据库地址
66-
CORDYS_MYSQL_HOST=$(hostname -I|cut -d" " -f 1)
67-
## 数据库端口
68-
CORDYS_MYSQL_PORT=3306
69-
## 数据库库名
70-
CORDYS_MYSQL_DB=cordys-crm
71-
## 数据库用户名
72-
CORDYS_MYSQL_USER=root
73-
## 数据库密码
74-
CORDYS_MYSQL_PASSWORD=CordysCRM@mysql
75-
76-
# Redis 配置
77-
## 是否使用外部Redis
78-
CORDYS_EXTERNAL_REDIS=false
79-
## Redis 端口
80-
CORDYS_REDIS_PORT=6379
81-
## Redis 密码
82-
CORDYS_REDIS_PASSWORD=CordysCRM@redis
83-
## Redis地址
84-
CORDYS_REDIS_HOST=$(hostname -I|cut -d" " -f 1)
85-
86-
#MCP Server
87-
CORDYS_MCP_EXTERNAL_SERVER=false
88-
CORDYS_MCP_SERVER_PORT=8082
50+
# 基础配置
51+
## 安装路径, Cordys CRM 配置及数据文件默认将安装在 ${CORDYS_BASE}/cordys 目录下
52+
CORDYS_BASE=/opt
53+
## Cordys CRM 使用的 docker 网络网段信息
54+
CORDYS_DOCKER_SUBNET=172.30.10.0/24
55+
## 镜像前缀
56+
CORDYS_IMAGE_PREFIX='registry.fit2cloud.com/cordys'
57+
## 镜像相关
58+
CORDYS_IMAGE_NAME=cordys-crm-ce
59+
CORDYS_IMAGE_TAG=v1.0.0
60+
61+
## CORDYS 主程序的 HTTP 服务监听端口
62+
CORDYS_SERVER_PORT=8081
63+
64+
# 数据库配置
65+
## 是否使用外部数据库
66+
CORDYS_EXTERNAL_MYSQL=false
67+
## 数据库地址
68+
CORDYS_MYSQL_HOST=$(hostname -I|cut -d" " -f 1)
69+
## 数据库端口
70+
CORDYS_MYSQL_PORT=3306
71+
## 数据库库名
72+
CORDYS_MYSQL_DB=cordys-crm
73+
## 数据库用户名
74+
CORDYS_MYSQL_USER=root
75+
## 数据库密码
76+
CORDYS_MYSQL_PASSWORD=CordysCRM@mysql
77+
78+
# Redis 配置
79+
## 是否使用外部Redis
80+
CORDYS_EXTERNAL_REDIS=false
81+
## Redis 端口
82+
CORDYS_REDIS_PORT=6379
83+
## Redis 密码
84+
CORDYS_REDIS_PASSWORD=CordysCRM@redis
85+
## Redis地址
86+
CORDYS_REDIS_HOST=$(hostname -I|cut -d" " -f 1)
87+
88+
#MCP Server
89+
CORDYS_MCP_EXTERNAL_SERVER=false
90+
CORDYS_MCP_SERVER_PORT=8082
8991
```
9092

9193

manual/installation/online_installtion.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,46 @@
3939
-p 8082:8082 \
4040
-v ~/cordys:/opt/cordys \
4141
1panel/cordys-crm
42+
43+
```
44+
45+
#### 参数说明
46+
47+
!!! Abstract ""
48+
如需调整 MySQL、Redis 等内部组件的配置文件,可直接编辑宿主机目录下的:
49+
50+
```
51+
~/cordys/conf/cordys-crm.properties
52+
```
4253
```
54+
# 需要修改的配置把前面的 # 号去掉,修改对应的值即可,例如:
55+
logger.sql.level=info
56+
## DATABASE
57+
#spring.datasource.url=jdbc:mysql://ip:port/db?autoReconnect=false&useUnicode=true&characterEncoding=UTF-8&characterSetResults=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=false
58+
#spring.datasource.username=username
59+
#spring.datasource.password=password
60+
61+
#spring.data.redis.host=ip
62+
#spring.data.redis.password=password
63+
#spring.data.redis.port=6379
64+
#spring.session.redis.repository-type=indexed
65+
66+
# SQLBot 默认获取 spring.datasource 配置访问数据库,支持自定义配置只读用户
67+
# sqlbot.datasource.username=Read-only-user
68+
# sqlbot.datasource.password=password
69+
70+
# mcp server settings
71+
#mcp.embedded.enabled=true
72+
#cordys.crm.url=http://127.0.0.1:8081
73+
#spring.mvc.async.request-timeout=60000
74+
#spring.ai.mcp.server.type=ASYNC
75+
#spring.ai.mcp.server.name=cordys-crm-mcp-server
76+
77+
# Streamable Protocol Settings ,default is SSE
78+
#spring.ai.mcp.server.protocol=STREAMABLE
79+
#spring.ai.mcp.server.streamable-http.mcp-endpoint=/sse
4380

81+
```
4482

4583
## 4 在线升级
4684

0 commit comments

Comments
 (0)