Skip to content

Commit 1c02200

Browse files
committed
feat: doc
1 parent 22098da commit 1c02200

5 files changed

Lines changed: 63 additions & 10 deletions

File tree

docs/guides/gettingStarted/dockerCompose.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ docker compose up -d
4242
docker compose --profile m up -d
4343
```
4444

45+
监控告警使用参考: [监控告警](./admin.mdx)
46+
4547
- 停止服务:
4648

4749
```bash
@@ -63,9 +65,3 @@ docker logs -f openim-chat
6365

6466
强烈要求使用 docker compose 命令而不是 docker-compose,老版本 Docker 可能不支持 gateway 功能❌。我们建议您升级到较新的版本,例如 `23.0.1`🔝
6567

66-
## 日志查看 📜
67-
68-
日志位置:
69-
70-
- `{openim-server, openim-chat}/_output/logs/openim-service-log.*`
71-

docs/guides/gettingStarted/env-comp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sidebar_position: 1
1111
| --- | --- |
1212
| 操作系统 | Linux windows mac 系统 |
1313
| 硬件资源 | 至少 4G 可用内存 |
14-
| Golang | v1.21 或更高,[安装参考](https://go.dev/learn/) |
14+
| Golang | v1.21 或更高,[安装参考](https://go.dev/learn/),设置代理(可选):`export GOPROXY=https://goproxy.cn,direct` |
1515
| Docker | v24.0.5 或更高,[安装参考](https://www.docker.com/get-started/) |
1616
| Git | v2.17.1 或更高,[安装参考](https://git-scm.com/downloads) |
1717

docs/guides/gettingStarted/imSourceCodeDeployment.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ mage check
7272

7373
## 3. 部署 App Server (Chat)
7474

75-
### 3.1 clone 仓库 建议切换到 release-v1.8 分支
75+
### 3.1 clone 仓库 建议切换到 release-v1.8.3 分支
7676

7777
```
7878
git clone https://github.com/openimsdk/chat&& cd chat
@@ -128,7 +128,7 @@ mage check
128128

129129
## 6. 关于配置项的修改
130130

131-
[参考此文档](../../restapi/commonConfigs.mdx)
131+
[参考此文档](../../restapi/commonConfigs)
132132

133133
---
134134

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: '离线部署指南'
3+
sidebar_position: 7
4+
---
5+
6+
7+
8+
## open-im-server 离线部署指南
9+
10+
本指南将指导您在一台没有连接到互联网的机器上部署`open-im-server`
11+
12+
### **Docker部署**
13+
14+
1. 使用一台连接到互联网的机器,克隆仓库:
15+
```sh
16+
git clone https://github.com/openimsdk/openim-docker
17+
```
18+
19+
2. 运行`docker compose up -d`以拉取镜像。
20+
21+
3. 保存相应的镜像。命令如下:
22+
```sh
23+
docker save -o image-name.tar image-name:tag
24+
```
25+
26+
例如,需要保存`openim-server`镜像,命令应为:
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`文件中确认镜像的版本信息。
38+
39+
所有需要保存的镜像为:
40+
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+
- `prom/alertmanager:v0.27.0`
46+
- `grafana/grafana:11.0.1`
47+
- `quay.io/coreos/etcd:v3.5.13`
48+
- `redis`
49+

docs/guides/gettingStarted/quickTestServer.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,12 @@ import Image3 from './assets/pc-web.png';
6262

6363
import Image4 from './assets/admin.jpg';
6464

65-
<img src={Image4} width="700" alt="admin " />
65+
<img src={Image4} width="700" alt="admin " />
66+
67+
68+
69+
### 监控告警验证
70+
71+
在浏览器中输入 `http://your_server_ip:13000` 来访问`grafana``your_server_ip` 为服务端部署机器`ip`地址,确保您的浏览器能访问。
72+
73+
具体使用方式可参考 [监控告警部署文档](./admin)

0 commit comments

Comments
 (0)