Skip to content

Commit c0775b4

Browse files
skiffer-gitskiffer-git
committed
doc
1 parent 22098da commit c0775b4

14 files changed

Lines changed: 97 additions & 12 deletions

‎docs/guides/gettingStarted/_category_.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"position": 2,
3-
"label": "快速开始",
3+
"label": "快速部署",
44
"collapsible": true,
55
"collapsed": true
66
}

‎docs/guides/gettingStarted/admin.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: '监控及告警'
3-
sidebar_position: 5
3+
sidebar_position: 9
44
---
55

66

‎docs/guides/gettingStarted/cluster.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: '源码集群部署指南'
3-
sidebar_position: 6
2+
title: '集群部署-源码'
3+
sidebar_position: 5
44
---
55

66

‎docs/guides/gettingStarted/dockerCompose.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'docker部署'
3-
sidebar_position: 3
3+
sidebar_position: 2
44

55
---
66
## 环境准备 🌍

‎docs/guides/gettingStarted/imSourceCodeDeployment.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: '源码部署'
3-
sidebar_position: 1
3+
sidebar_position: 3
44
---
55

66
# 🛠 源码部署

‎docs/guides/gettingStarted/internalDeployment.mdx‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: '内网部署'
3+
sidebar_position: 4
4+
---
5+
## 📌 一、部署服务端
6+
7+
请参考 [docker部署](./dockerCompose) 或 [源码部署](./imSourceCodeDeployment) 来进行部署。
8+
9+
---
10+
## 二、 开放端口
11+
12+
### 📡 IM 端口
13+
14+
| TCP 端口 | 说明 | 操作 ⚙️ |
15+
| --- | --- | --- |
16+
| TCP:10001 | ws 协议，消息端口，用于客户端 SDK | 端口放行 |
17+
| TCP:10002 | api 端口，如用户、好友、群组、消息等接口 | 端口放行 |
18+
| TCP:10005 | 选择 MinIO 存储时需要（OpenIM 默认使用 MinIO 存储） | 端口放行 |
19+
20+
### 💬 Chat 端口
21+
22+
| TCP 端口 | 说明 | 操作 ⚙️ |
23+
| --- | --- | --- |
24+
| TCP:10008 | 业务系统，如注册、登录等 | 端口放行 |
25+
| TCP:10009 | 管理后台，如统计、封号等 | 端口放行 |
26+
27+
### 💻 PC Web 及管理后台前端资源端口
28+
29+
| TCP 端口 | 说明 | 操作 ⚙️ |
30+
| --- | --- | --- |
31+
| TCP:11001 | PC Web 前端资源 | 端口放行 |
32+
| TCP:11002 | 管理后台前端资源 | 端口放行 |
33+
34+
### 💻 grafana端口
35+
| TCP 端口 | 说明 | 操作 ⚙️ |
36+
| --- | --- | --- |
37+
| TCP:13000 | grafana端口 | 端口放行 |
38+
39+
40+
41+
## 三、验证
42+
43+
### PC Web 验证
44+
45+
:::tip
46+
在浏览器中输入 `http://your_server_ip:11001` 来访问 PC Web。`your_server_ip` 为服务端部署机器`ip`地址，确保浏览器能访问。注册时验证码默认为 `666666`。
47+
:::
48+
49+
50+
51+
52+
import Image3 from './assets/pc-web.png';
53+
54+
<img src={Image3} width="700" alt="PC Web Interface" />
55+
56+
57+
58+
### 管理后台验证
59+
60+
在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
61+
62+
63+
import Image4 from './assets/admin.jpg';
64+
65+
<img src={Image4} width="700" alt="admin " />

‎docs/guides/gettingStarted/k8s-deployment.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'k8s部署-待完善'
3-
sidebar_position: 8
2+
title: '集群部署-kubernetes'
3+
sidebar_position: 6
44
---
55

66

‎docs/guides/gettingStarted/nginxDomainConfig.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Nginx域名配置'
3-
sidebar_position: 7
2+
title: 'Nginx域名及证书配置'
3+
sidebar_position: 8
44
---
55

66

‎docs/guides/gettingStarted/quickTestServer.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: '快速验证'
3-
sidebar_position: 5
3+
sidebar_position: 7
44
---
55
## 📌 一、部署服务端
66

‎docs/guides/pressure_test.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: '压测报告'
33
hide_title: true
4-
sidebar_position: 3
4+
sidebar_position: 5
55
---
66

77
## 测试目的

0 commit comments

Comments
 (0)