Skip to content

Commit 8d57f47

Browse files
icey-yuicey-yu
committed
feat: doc
1 parent 1d27c0e commit 8d57f47

3 files changed

Lines changed: 100 additions & 96 deletions

File tree

‎docs/guides/gettingStarted/admin.mdx‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ sidebar_position: 9
66

77

88
## 组件说明
9-
docker compose部署时，会自动部署如下组件，如使用源码部署，需手动开启docker-compose.yaml中的相关组件。
109

1110
| 组件名称 | 组件说明 | 部署说明 |
1211
|-------------|-----------------------------------------|--------------------------------------|
@@ -106,12 +105,12 @@ docker compose --profile m up -d
106105
```yaml
107106
global:
108107
resolve_timeout: 5m
109-
smtp_from: alert@openim.io #告警信息发送邮箱
110-
smtp_smarthost: smtp.163.com:465 #发送邮箱smtp地址
111-
smtp_auth_username: alert@openim.io #发送邮箱授权用户名，一般和smtp_from邮箱相同
112-
smtp_auth_password: YOURAUTHPASSWORD #发送邮箱授权码
108+
smtp_from: your_email #告警信息发送邮箱
109+
smtp_smarthost: your_smtp_addr #发送邮箱smtp地址
110+
smtp_auth_username: your_username #发送邮箱授权用户名，一般和smtp_from邮箱相同
111+
smtp_auth_password: your_password #发送邮箱授权码
113112
smtp_require_tls: false
114-
smtp_hello: openim alert
113+
smtp_hello: hello
115114

116115
templates:
117116
- /etc/alertmanager/email.tmpl #邮件模版
@@ -249,15 +248,10 @@ node-exporter指标信息，如下图
249248

250249
## 告警体验
251250

252-
可手动触发instancedown告警规则，如果是源码部署openim方式，执行 `make stop`命令停止openim-server服务，等待5m分钟以上，即可收到告警邮件，内容如下：
251+
可手动触发instancedown告警规则，如果是源码部署openim方式，执行 `mage stop`命令停止`open-im-server`服务，等待1m分钟以上，即可收到告警邮件，内容如下：
253252

254253
![PC Web Interface](./assets/alert6.png)
255254

256-
## 日志系统
257-
如果是在k8s环境通过helm chart方式部署的OpenIM服务，即通过grafana查看OpenIM所有服务的日志信息。
258-
目前二进制和docker部署没有集成loki日志收集组件，想体验loki日志收集功能，请采用helm chart部署，
259-
详情请查阅链接https://github.com/openimsdk/helm-charts/blob/main/docs/user-guide-zh.md
260-
261255
## **自定义prometheus指标配置**
262256

263257
在源码中`pkg/common/prommetrics`中初始化相应类型指标，调用`Init()`函数进行注册。

‎docs/guides/gettingStarted/internalDeployment.mdx‎

Lines changed: 94 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,123 @@
22
title: '内网部署'
33
sidebar_position: 4
44
---
5-
## 📌 一、部署服务端
5+
## 📌 open-im-server 内网部署指南
66

7-
请参考 [docker部署](./dockerCompose) 或 [源码部署](./imSourceCodeDeployment) 来进行部署。
7+
本指南将指导您在一台没有连接到互联网的机器上部署`open-im-server`。
88

9-
---
10-
## 二、 开放端口
9+
### **Docker部署**
10+
11+
1. 使用一台连接到互联网的机器，克隆仓库：
12+
13+
```sh
14+
git clone https://github.com/openimsdk/openim-docker
15+
```
16+
17+
2. 运行`docker compose up -d`以拉取镜像。
18+
19+
3. 保存相应的镜像。命令如下：
20+
21+
```sh
22+
docker save -o image-name.tar image-name:tag
23+
```
24+
25+
例如，需要保存`openim-server`镜像，命令应为：
26+
27+
```sh
28+
docker save -o openim-server.tar openim/openim-server:release-v3.8.1
29+
```
30+
31+
保存`mongo`镜像，命令应为：
32+
33+
```sh
34+
docker save -o mongo.tar mongo:7.0
35+
```
36+
37+
可以使用`docker images`查看拉取的镜像信息，或者在`.env`文件中确认镜像的版本信息。
1138

12-
### 📡 IM 端口
39+
所有需要保存的镜像为：
1340

14-
| TCP 端口 | 说明 | 操作 ⚙️ |
15-
| --- | --- | --- |
16-
| TCP:10001 | ws 协议，消息端口，用于客户端 SDK | 端口放行 |
17-
| TCP:10002 | api 端口，如用户、好友、群组、消息等接口 | 端口放行 |
18-
| TCP:10005 | 选择 MinIO 存储时需要（OpenIM 默认使用 MinIO 存储） | 端口放行 |
41+
- `mongo:7.0`
42+
- `redis:7.0.0`
43+
- `bitnami/kafka:3.5.1`
44+
- `minio/minio:RELEASE.2024-01-11T07-46-16Z`
45+
- `quay.io/coreos/etcd:v3.5.13`
46+
- `openim/openim-web-front:release-v3.8.1`
47+
- `openim/openim-admin-front:release-v1.8.3`
48+
- `openim/openim-server:release-v3.8.2`
49+
- `openim/openim-chat:v1.8.2`
1950

20-
### 💬 Chat 端口
51+
以下为监控告警组件镜像，可根据需求选择性部署：
2152

22-
| TCP 端口 | 说明 | 操作 ⚙️ |
23-
| --- | --- | --- |
24-
| TCP:10008 | 业务系统，如注册、登录等 | 端口放行 |
25-
| TCP:10009 | 管理后台，如统计、封号等 | 端口放行 |
53+
- `prom/prometheus:v2.51.2`
54+
- `prom/alertmanager:v0.27.0`
55+
- `grafana/grafana:11.0.1`
56+
- `prom/node-exporter:v1.7.0`
2657

27-
### 💻 PC Web 及管理后台前端资源端口
58+
4. 通过内网或者物理介质将**镜像文件**和**docker仓库文件**拷贝到部署机器上。
2859

29-
| TCP 端口 | 说明 | 操作 ⚙️ |
30-
| --- | --- | --- |
31-
| TCP:11001 | PC Web 前端资源 | 端口放行 |
32-
| TCP:11002 | 管理后台前端资源 | 端口放行 |
60+
5. 导入镜像到`docker`中，命令为：
61+
```bash
62+
docker load -i image-name.tar
63+
```
3364

34-
### 💻 grafana端口
35-
| TCP 端口 | 说明 | 操作 ⚙️ |
36-
| --- | --- | --- |
37-
| TCP:13000 | grafana端口 | 端口放行 |
65+
例如`openim-server`镜像导入命令为：
3866

67+
```sh
68+
docker load -i openim-server.tar
69+
```
3970

71+
6. 在仓库目录下运行：
72+
```sh
73+
docker copose up -d
74+
```
4075

41-
## 三、验证
76+
需要启动监控组件则运行：
77+
```sh
78+
docker compose --profile m up -d
79+
```
4280

43-
### PC Web 验证
81+
### **源码部署**
4482

45-
:::tip
46-
在浏览器中输入 `http://your_server_ip:11001` 来访问 PC Web。`your_server_ip` 为服务端部署机器`ip`地址，确保浏览器能访问。注册时验证码默认为 `666666`。
47-
:::
83+
1. 使用一台连接到互联网的机器，克隆server仓库建议切换到 release-v3.8.2 分支：
4884

85+
```sh
86+
git clone https://github.com/openimsdk/open-im-server
87+
```
4988

89+
2. 克隆`chat`仓库建议切换到 release-v1.8.3 分支
90+
```bash
91+
git clone https://github.com/openimsdk/chat
92+
```
5093

94+
3. 参考[docker部署](#Docker部署)步骤，保存镜像，区别为不需要`openim/openim-server:release-v3.8.2`和`openim/openim-chat:v1.8.2`。
5195

52-
import Image3 from './assets/pc-web.png';
96+
4. 通过内网或者物理介质将**镜像文件**、**server仓库文件**、**chat仓库文件**拷贝到部署机器上。
5397

54-
<img src={Image3} width="700" alt="PC Web Interface" />
98+
5. 导入镜像到`docker`中，命令为：
5599

100+
```bash
101+
docker load -i image-name.tar
102+
```
56103

104+
例如`mongo`镜像导入命令为：
57105

58-
### 管理后台验证
106+
```sh
107+
docker load -i mongo.tar
108+
```
59109

60-
在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
110+
6. 在`server`目录下依次运行：
111+
```bash
112+
docker compose up -d # 如需启用监控组件则为 docker compose --profile m up -d
113+
mage
114+
mage start
115+
```
61116

117+
7. 在`chat`目录下运行：
118+
```bash
119+
mage
120+
mage start
121+
```
62122

63-
import Image4 from './assets/admin.jpg';
123+
64124

65-
<img src={Image4} width="700" alt="admin " />

‎docs/guides/gettingStarted/offlineDeployment.md‎

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

0 commit comments

Comments
 (0)