Skip to content

Commit 1dfcc8c

Browse files
authored
Merge pull request #242 from skiffer-git/n2
add docs for configuration center
2 parents 820b6b2 + 8b19efd commit 1dfcc8c

1 file changed

Lines changed: 29 additions & 12 deletions

File tree

docs/guides/gettingStarted/config-center.mdx

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,36 @@ sidebar_position: 11
77

88
## 介绍
99

10-
配置中心是`OpenIM`的配置可视化功能模块,能够让用户在可视化界面中便捷、友好地对`open-im-server`的配置进行修改,并能够根据新的配置自动重启相应的服务以应用新的配置。
10+
11+
12+
配置中心是 OpenIM 提供的可视化配置管理模块,支持用户在图形化界面中便捷地修改服务端配置,并可根据最新配置自动重启相应服务并应用变更。该配置中心分别面向 OpenIMServer 和 Chat 两个系统,二者相互独立,即便存在相同字段(例如 secret),也需要在各自系统中分别修改。
13+
14+
在之前的版本中,开发者可以通过以下两种方式修改配置:
15+
- **源码部署**:手动编辑 `config` 目录下的配置文件,并重启服务。
16+
- **Docker 部署**:设置相应的环境变量,并重启 Docker 容器。
17+
18+
上述两种方式统称为“本地修改”或“本地配置文件”方式。
19+
20+
1121

1222
## 使用说明
1323

1424
### 访问界面
1525

16-
在通过`docker compose up -d`启动管理后台组件后,在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址,确保您的浏览器能访问。默认账号和密码均为 `chatAdmin`
26+
在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址,确保您的浏览器能访问。默认账号和密码均为 `chatAdmin`
27+
28+
在左侧的菜单栏中选择“运维中心”,选择“IM配置管理”,即可进入OpenIMServer配置中心页面。
29+
30+
配置中心功能默认不启用,第一次进入配置中心页面需要点击“启用配置管理”开启。
1731

18-
在左侧的菜单栏中选择“运维中心”,选择“IM配置管理”,即可进入配置中心页面。
1932

20-
配置中心功能默认不启用,第一次进入配置中心页面需要点击“启用配置管理”开启配置中心功能。
2133

2234
![i0](config-center.assets/i0.png)
2335

2436
### 查看配置
2537

26-
点击“IM配置管理”后,界面左上角会显示部署方式以及版本。如下图所示为源码部署、3.8.2版本:
38+
点击“IM配置管理”后,界面左上角会显示部署方式以及当前版本。配置中心仅在源码和docker部署方式下生效,在kubernetes环境下不生效。
39+
如下图所示为源码部署、服务端为3.8.2版本:
2740

2841
![i1](config-center.assets/i1.png)
2942

@@ -33,7 +46,7 @@ sidebar_position: 11
3346

3447
### 编辑配置
3548

36-
鼠标点击`Common Configuration`下的配置字段或者点击下方各个配置文件右上角的“编辑”按钮,即可对配置文件进行修改。修改后,点击“保存”,即可更新配置,并自动重启相关的服务。如下图所示:
49+
鼠标点击`Common Configuration`下的配置字段或者点击下方各个配置文件右上角的“编辑”按钮,即可对配置文件进行修改。修改后,点击“保存”,即可更新配置,系统会自动重启相关的服务以应用新的配置。如下图所示:
3750

3851
![i3](config-center.assets/i3.png)
3952

@@ -43,19 +56,23 @@ sidebar_position: 11
4356

4457
### 重启系统/重置配置
4558

46-
配置中心右上角有“重启系统”和“重置配置两个按钮”。
59+
配置中心右上角有 `重启系统 ``重置配置 `两个按钮。
60+
61+
如果您发现在某些极端情况下,修改了配置之后系统没有正确应用,可点击 `重启系统 `保证配置被正确加载。
4762

48-
如果在某些极端情况下,修改了配置之后系统没有正确应用,可点击“重启系统”保证配置被正确加载。
63+
`重置配置 `表示系统将重新以本地配置文件覆盖配置中心的配置,这样会导致之前所有在配置中心的修改全部丢失。
64+
如在源码部署时修改了本地配置文件,或在docker部署时设置了环境变量,您希望以本地配置为准,则可以点击 `重置配置 `
4965

50-
“重置配置”表示系统将重新从`config`目录下的配置文件中加载配置,覆盖在配置中心进行的修改。
5166

5267
![i5](config-center.assets/i5.png)
5368

5469
### 关闭配置中心
5570

56-
点击上方“关闭配置管理”按钮,可关闭配置中心。
71+
点击上方“关闭配置管理”按钮,可关闭配置中心。关闭配置中心以后,系统以本地配置为准,之前的所有关于配置的修改都不再生效。
5772

5873
## 注意事项
5974

60-
1. 配置中心启用时,**会导致在`config`目录下配置文件的修改失效**,只能通过配置中心进行配置的修改。
61-
1. 配置中心一旦关闭,会丢失在开启过程中进行的配置(服务重启不会丢失)。
75+
1. 配置中心启用时,在本地配置文件的修改无法生效,只能通过配置中心进行配置的修改。
76+
2. 配置中心一旦关闭,会丢失在开启过程中进行的配置。
77+
3. 配置中心启用时,重启服务,已经修改的配置依然生效。
78+
4. 重置配置,会导致之前所有在配置中心的修改全部丢失。

0 commit comments

Comments
 (0)