Skip to content

Commit 03b15fc

Browse files
authored
Merge branch 'openimsdk:main' into docs/dev
2 parents 88ca8a9 + 1dfcc8c commit 03b15fc

8 files changed

Lines changed: 130 additions & 1 deletion

File tree

30.7 KB
Loading
10.3 KB
Loading
18.5 KB
Loading
57.4 KB
Loading
28 KB
Loading
2.99 KB
Loading
Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,78 @@
11
---
22
title: '配置中心'
3-
sidebar_position: 11
3+
sidebar_position: 11
44
---
5+
6+
# OpenIM配置中心说明
7+
8+
## 介绍
9+
10+
11+
12+
配置中心是 OpenIM 提供的可视化配置管理模块,支持用户在图形化界面中便捷地修改服务端配置,并可根据最新配置自动重启相应服务并应用变更。该配置中心分别面向 OpenIMServer 和 Chat 两个系统,二者相互独立,即便存在相同字段(例如 secret),也需要在各自系统中分别修改。
13+
14+
在之前的版本中,开发者可以通过以下两种方式修改配置:
15+
- **源码部署**:手动编辑 `config` 目录下的配置文件,并重启服务。
16+
- **Docker 部署**:设置相应的环境变量,并重启 Docker 容器。
17+
18+
上述两种方式统称为“本地修改”或“本地配置文件”方式。
19+
20+
21+
22+
## 使用说明
23+
24+
### 访问界面
25+
26+
在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址,确保您的浏览器能访问。默认账号和密码均为 `chatAdmin`
27+
28+
在左侧的菜单栏中选择“运维中心”,选择“IM配置管理”,即可进入OpenIMServer配置中心页面。
29+
30+
配置中心功能默认不启用,第一次进入配置中心页面需要点击“启用配置管理”开启。
31+
32+
33+
34+
![i0](config-center.assets/i0.png)
35+
36+
### 查看配置
37+
38+
点击“IM配置管理”后,界面左上角会显示部署方式以及当前版本。配置中心仅在源码和docker部署方式下生效,在kubernetes环境下不生效。
39+
如下图所示为源码部署、服务端为3.8.2版本:
40+
41+
![i1](config-center.assets/i1.png)
42+
43+
`Common Configuration`表示常用的配置,下方展示了常用的配置字段,鼠标悬浮于字段上方可查看字段含义,如下图所示:
44+
45+
![i2](config-center.assets/i2.png)
46+
47+
### 编辑配置
48+
49+
鼠标点击`Common Configuration`下的配置字段或者点击下方各个配置文件右上角的“编辑”按钮,即可对配置文件进行修改。修改后,点击“保存”,即可更新配置,系统会自动重启相关的服务以应用新的配置。如下图所示:
50+
51+
![i3](config-center.assets/i3.png)
52+
53+
![i4](config-center.assets/i4.png)
54+
55+
56+
57+
### 重启系统/重置配置
58+
59+
配置中心右上角有 `重启系统 ``重置配置 `两个按钮。
60+
61+
如果您发现在某些极端情况下,修改了配置之后系统没有正确应用,可点击 `重启系统 `保证配置被正确加载。
62+
63+
`重置配置 `表示系统将重新以本地配置文件覆盖配置中心的配置,这样会导致之前所有在配置中心的修改全部丢失。
64+
如在源码部署时修改了本地配置文件,或在docker部署时设置了环境变量,您希望以本地配置为准,则可以点击 `重置配置 `
65+
66+
67+
![i5](config-center.assets/i5.png)
68+
69+
### 关闭配置中心
70+
71+
点击上方“关闭配置管理”按钮,可关闭配置中心。关闭配置中心以后,系统以本地配置为准,之前的所有关于配置的修改都不再生效。
72+
73+
## 注意事项
74+
75+
1. 配置中心启用时,在本地配置文件的修改无法生效,只能通过配置中心进行配置的修改。
76+
2. 配置中心一旦关闭,会丢失在开启过程中进行的配置。
77+
3. 配置中心启用时,重启服务,已经修改的配置依然生效。
78+
4. 重置配置,会导致之前所有在配置中心的修改全部丢失。

docs/guides/solution/s3convert.mdx

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: '如何迁移到其他S3存储'
3+
sidebar_position: 9
4+
5+
---
6+
7+
# S3存储接入
8+
9+
### 获取最新代码
10+
请下载项目的最新代码版本:
11+
- 最新代码已集成`S3`迁移工具,无需单独操作。
12+
```shell
13+
git clone https://github.com/openimsdk/open-im-server.git
14+
cd open-im-server
15+
```
16+
17+
### 配置文件修改指南
18+
请根据需要修改`config`目录下的相关配置文件,以完成迁移相关的 S3 配置:
19+
1. 编辑`openim-rpc-third.yml`配置文件
20+
- 定位并更新与 S3 相关的配置项,确保其符合您的实际迁移需求。
21+
2. 关于 minio.yml 配置文件
22+
- 如果项目中未实际使用 MinIO,该文件可以忽略。
23+
- 如需使用,请同样根据迁移需求更新 S3 配置相关项。
24+
3. `openim-rpc-third.yml`中都有`object.enable`字段,用于指定新的S3存储引擎。
25+
26+
### 编译S3迁移工具
27+
1. 进入工具目录
28+
```shell
29+
cd tools/s3
30+
```
31+
2. 执行编译命令
32+
```shell
33+
go build -o s3convert main.go
34+
```
35+
36+
### 开始迁移
37+
为确保数据迁移过程的稳定性,请按照以下建议进行操作:
38+
1. 准备工作
39+
- 关闭服务:建议在服务停止的状态下进行迁移操作,以避免数据不一致或操作冲突。
40+
- 备份 MongoDB:重点备份`s3`表的数据,以便在发生意外时快速恢复。
41+
2. 迁移说明
42+
- 迁移工具不会删除原有的`S3`数据,但会修改`MongoDB``s3`表的相关记录。
43+
- 请在迁移完成后,核对数据完整性,确保所有迁移步骤正确执行。
44+
3. 执行迁移命令
45+
- `<config dir path>`:指定配置文件目录路径。
46+
- `<old s3 name>`:填写原 S3 配置名称,例如 minio。
47+
```shell
48+
./s3convert -config <config dir path> -name <old s3 name>
49+
```
50+
4. 示例命令
51+
如配置文件位于 config 目录下,且原 S3 名称为 minio,可执行以下命令:
52+
```shell
53+
./s3convert -config ./../../config -name minio
54+
```
55+
当看到输出信息`success`时,表示迁移操作已完成。

0 commit comments

Comments
 (0)