Skip to content

Commit d383ced

Browse files
committed
doc
1 parent 16bd486 commit d383ced

1 file changed

Lines changed: 5 additions & 19 deletions

File tree

docs/guides/gettingStarted/dockerCompose.mdx

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 2
55
---
66
## 环境准备 🌍
77

8-
- 在服务器上安装带有 Compose 插件的 Docker 或 docker-compose。安装详情请访问 [Docker Compose 安装指南](https://docs.docker.com/compose/install/linux/)
8+
- 在服务器上安装带有 Compose 插件的 Docker 或 docker-compose,并确保docker已正常启动
99

1010
## 仓库克隆 🗂️
1111

@@ -18,15 +18,11 @@ git clone https://github.com/openimsdk/openim-docker
1818
- 修改 `.env` 文件,配置外网 IP。如果使用域名,需配置 [Nginx](./nginxDomainConfig.mdx)
1919

2020
```plaintext
21-
# 设置 MinIO 服务的外网访问地址(外网IP或域名
21+
# 设置 MinIO 服务的外网访问地址(external_ip:10005或域名
2222
MINIO_EXTERNAL_ADDRESS="http://external_ip:10005"
2323
```
2424

25-
>注意:docker部署不采用配置挂载的模式,在config目录下面修改配置文件无效!请采用环境变量的方式修改配置。
26-
>
27-
>配置格式说明:docker方式部署如果需要修改配置,则需要通过修改docker-compose.yaml中的环境变量来实现。例如修改`openim-server`的配置文件`openim-api.yml`中的`prometheus.grafanaURL`字段,则应在`docker-compose.yaml`文件中的`openim-server``environment`下添加:`- IMENV_OPENIM_API_PROMETHEUS_GRAFANAURL=${GRAFANA_URL}``IMENV``openim-server`配置的固定前缀,文件名和字段之间的分隔符全部为`_`,并且全部改为大写。
28-
29-
- 其他配置请参考 .env 中的注释
25+
>注意:进入容器修改config目录下的修改配置文件无效!请采用环境变量的方式修改配置,参考[设置环境变量指南](https://github.com/openimsdk/openim-docker/issues/136)
3026
3127
## 服务启动 🚀
3228

@@ -36,7 +32,7 @@ git clone https://github.com/openimsdk/openim-docker
3632
docker compose up -d
3733
```
3834

39-
- 启动服务+监控组件(可选):
35+
- 启动监控运维组件(可选):
4036

4137
```bash
4238
docker compose --profile m up -d
@@ -57,15 +53,5 @@ docker logs -f openim-chat
5753

5854
## 快速体验 ⚡
5955

60-
快速体验 OpenIM 服务,请参考[快速验证](./quickTestServer)
61-
62-
## 关于 Docker 版本 🐋
63-
64-
强烈要求使用 docker compose 命令而不是 docker-compose,老版本 Docker 可能不支持 gateway 功能❌。我们建议您升级到较新的版本,例如 `23.0.1`🔝
65-
66-
## 日志查看 📜
67-
68-
日志位置:
69-
70-
- `{openim-server, openim-chat}/_output/logs/openim-service-log.*`
56+
快速体验 OpenIM 服务,检测部署是否正常,请参考[快速验证](./quickTestServer)
7157

0 commit comments

Comments
 (0)