Skip to content

Commit 58b48ee

Browse files
committed
feat(docs): add production deployment guide and reorganize gettingStarted docs
Add production.md with single-machine production deployment guide, internalDeployment.md with internal network deployment guide, and env-comp.md with platform requirements. Reorganize gettingStarted docs with clearer structure and improved content.
1 parent 11e03e5 commit 58b48ee

12 files changed

Lines changed: 367 additions & 321 deletions

File tree

docs/guides/gettingStarted/cluster.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,17 +120,17 @@ http {
120120
}
121121
122122
upstream im_api {
123-
# OpenIMServer API 地址,可根据部署情况指定多个
123+
# OpenIMServer API addresses; add more upstreams if needed
124124
server IP_A:10002;
125125
server IP_B:10002;
126126
}
127127
128128
server {
129129
listen 443 ssl;
130-
server_name yourhost.com; # 替换为您的域名
130+
server_name yourhost.com; # Replace with your domain
131131
132-
ssl_certificate /usr/local/nginx/conf/ssl/your_host_bundle.pem; # 替换为您的证书路径
133-
ssl_certificate_key /usr/local/nginx/conf/ssl/your_host.key; # 替换为您的证书密钥路径
132+
ssl_certificate /usr/local/nginx/conf/ssl/your_host_bundle.pem; # Replace with your certificate path
133+
ssl_certificate_key /usr/local/nginx/conf/ssl/your_host.key; # Replace with your private key path
134134
135135
location ^~ /api/ {
136136
proxy_http_version 1.1;
@@ -152,10 +152,10 @@ http {
152152
}
153153
}
154154
155-
# 可选: HTTP 重定向到 HTTPS
155+
# Optional: redirect HTTP to HTTPS
156156
server {
157157
listen 80;
158-
server_name yourhost.com; # 替换为您的域名
158+
server_name yourhost.com; # Replace with your domain
159159
160160
return 301 https://$host$request_uri;
161161
}

docs/guides/gettingStarted/dockerCompose.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ git checkout "$LATEST_STABLE_TAG"
1919
echo "using openim-docker stable release tag: $LATEST_STABLE_TAG"
2020
```
2121

22-
> 这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。
22+
> 这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。`main` 为开发版分支,生产环境不要直接使用 `main`
2323
2424
### 2.2 配置修改 🔧
2525

@@ -58,6 +58,21 @@ docker compose down
5858
docker logs -f openim-server
5959
```
6060

61+
### 2.4 监控告警(可选)
62+
63+
如需同时启动 `Prometheus``Alertmanager``Grafana``node-exporter`,可执行:
64+
65+
```bash
66+
docker compose --profile m up -d
67+
```
68+
69+
默认端口以当前 `.env` 为准,常用值如下:
70+
71+
- `19090`:Prometheus
72+
- `19093`:Alertmanager
73+
- `13000`:Grafana
74+
- `19100`:node-exporter
75+
6176
## 3. 快速体验 ⚡
6277

6378
快速体验 OpenIMSDK 核心能力,并测试 OpenIMServer/ChatServer 部署是否正常,请参考[快速验证](./quickTestServer)

docs/guides/gettingStarted/env-comp.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,27 @@ sidebar_position: 1
55

66
# 🧩 平台及组件要求
77

8-
适用于 OpenIMSDK 服务端生产环境源码部署(单机)
8+
适用于 `docs/guides/gettingStarted` 下的 OpenIMServer、ChatServer 部署文档
99

1010
---
1111

12-
## 一、环境要求
12+
## 一、名词约定
13+
14+
- **OpenIMSDK**:项目统称,包含 OpenIMClientSDK 与 OpenIMServer。
15+
- **OpenIMClientSDK**:客户端 SDK。
16+
- **OpenIMServer**:IM 基础服务端。
17+
- **ChatServer**:业务扩展服务端,文档中不再使用 `Chat` 作为独立产品名称。
18+
- **APP 管理员**:调用管理类接口(如 `10009`)的后台管理角色。
19+
- **APP 业务服务器**:调用业务扩展接口(如 `10008`)的应用服务端。
20+
21+
## 二、版本与分支策略
22+
23+
- `main`:开发版分支,用于持续集成未发布变更,不建议直接用于生产环境。
24+
- `vX.Y.Z...`:稳定版发布版本命名。
25+
- 生产环境建议优先使用 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布版**
26+
- 如需问题复现、灰度回滚或多环境统一,请固定到明确的稳定版本 tag。
27+
28+
## 三、环境要求
1329

1430
| 注意事项 | 详细说明 | 补充说明 |
1531
| --- | --- | --- |
@@ -20,14 +36,14 @@ sidebar_position: 1
2036
| Docker | `v24.0.5` 或更高版本 | 自带 `compose` 功能 |
2137
| Git | `v2.17.1` 或更高版本 | [安装参考](https://git-scm.com/downloads) |
2238

23-
## 、外部组件要求
39+
## 、外部组件要求
2440

25-
| 存储组件 | 建议版本 | 支持模式 | 支持云服务 |
26-
| --- | --- | --- | --- |
27-
| MongoDB | `v7.0` | 单机、分片集群 | 支持 |
28-
| Redis | `v7.0.0` | 单机、分片集群 | 支持 |
29-
| Etcd | `v3.5.13` | 单机、分片集群 | 不支持 |
30-
| Kafka | `v3.5.1` | 单机、分布式集群 | 支持 |
31-
| MinIO | `RELEASE.2024-01-11T07-46-16Z` | 单机 | S3 兼容存储系统(`cos``oss``kodo``aws`|
41+
| 组件 | 建议版本 | OpenIMServer 支持模式 | ChatServer 接入方式 | 支持云服务 / 备注 |
42+
| --- | --- | --- | --- | --- |
43+
| MongoDB | `v7.0` | `standalone``replicaSet` | `address``uri` | 支持;如接副本集,建议优先使用 `uri` |
44+
| Redis | `v7.0.0` | `standalone``cluster``sentinel` | `standalone``clusterMode` | 支持;`sentinel` 仅在 OpenIMServer 配置层有显式支持 |
45+
| Etcd | `v3.5.13` | 单机、多节点集群 | 多地址接入 | 不支持云服务 |
46+
| Kafka | `v3.5.1` | 单机、分布式集群 | 不直接依赖 | 支持;需按文档预建 topic |
47+
| MinIO | `RELEASE.2024-01-11T07-46-16Z` | 单机 | 不直接依赖 | 可替换为 S3 兼容存储(`COS``OSS``Kodo``AWS S3`|
3248

3349
---

docs/guides/gettingStarted/faq.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ sidebar_position: 10
6161
mage start
6262
```
6363

64-
5. **如果部署了 ChatServer,也建议同步升级到对应 tag 后再重启 Chat 服务**
64+
5. **如果部署了 ChatServer,也建议同步升级到对应 tag 后再重启 ChatServer**
6565

6666
> 说明:这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。
6767

@@ -80,23 +80,23 @@ docker compose down
8080
源码部署:
8181

8282
```sh
83-
mage stop # 关闭服务
84-
docker compose down # 关闭组件
83+
mage stop # Stop services
84+
docker compose down # Stop components
8585
```
8686

8787
然后移动整个文件夹到数据目录,修改.env文件中DATA_DIR的值为新数据目录,再启动服务和组件:
8888

8989
`docker`部署:
9090

9191
```sh
92-
docker compose up -d # 启动组件
92+
docker compose up -d # Start components
9393
```
9494

9595
源码部署:
9696

9797
```sh
98-
docker compose up -d # 启动组件
99-
mage start # 启动服务
98+
docker compose up -d # Start components
99+
mage start # Start services
100100
```
101101

102102
---
@@ -113,8 +113,8 @@ docker compose down
113113
源码部署:
114114

115115
```sh
116-
mage stop # 关闭服务
117-
docker compose down # 关闭组件
116+
mage stop # Stop services
117+
docker compose down # Stop components
118118
```
119119

120120
然后删除当前部署仓库下的 `components` 文件夹。
@@ -125,15 +125,16 @@ docker compose down # 关闭组件
125125
## 四、 发送文本消息正常,但发送图片失败
126126

127127
一般发送图片失败是由于没有配置第三方存储的原因。默认使用的第三方存储为`minio`,需修改相关配置
128-
```
129-
源码部署:
130-
修改 config/minio.yml 文件,配置 MinIO 外网 IP,以支持发送图片和文件,其中 `your-server-ip` 为服务端外网 IP
128+
129+
源码部署:修改 `config/minio.yml`,将 `externalAddress` 改为外网 IP 或域名路径。
130+
131+
```yaml
131132
externalAddress: http://your-server-ip:10005
132133
```
133134

134-
```
135-
docker部署
136-
修改 .env 文件,配置 MinIO 外网 IP,以支持发送图片和文件,其中 `your-server-ip` 为服务端外网 IP
135+
Docker 部署:修改 `.env`,将 `MINIO_EXTERNAL_ADDRESS` 改为外网 IP 或域名路径。
136+
137+
```dotenv
137138
MINIO_EXTERNAL_ADDRESS="http://your-server-ip:10005"
138139
```
139140
---
@@ -149,15 +150,15 @@ MINIO_EXTERNAL_ADDRESS="http://your-server-ip:10005"
149150
```yml
150151
mongo:
151152
environment:
152-
- wiredTigerCacheSizeGB=0.5 # 修改为适当的值,单位GB
153+
- wiredTigerCacheSizeGB=0.5 # Adjust to an appropriate value, unit: GB
153154
```
154155

155156
`kafka`
156157

157158
```yml
158159
kafka:
159160
environment:
160-
KAFKA_HEAP_OPTS: "-Xms256m -Xmx256m" # 添加该限制
161+
KAFKA_HEAP_OPTS: "-Xms256m -Xmx256m" # Add this memory limit
161162
```
162163

163164
---

docs/guides/gettingStarted/faultRecovery.mdx

Lines changed: 0 additions & 186 deletions
This file was deleted.

0 commit comments

Comments
 (0)