Skip to content

Commit

Permalink
chore: update server/docker document (#181)
Browse files Browse the repository at this point in the history
  • Loading branch information
zsq1234 authored and hexf00 committed Jul 1, 2024
1 parent 4ac1dcf commit 6809cc5
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
36 changes: 36 additions & 0 deletions src/docs/guides/general/server/docker.en-US.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,39 @@ You'll need to tweak the `.env` file. Set `S3_ENDPOINT_PUBLIC` to your local net
- S3_ENDPOINT_PUBLIC=http://univer-minio:9000
+ S3_ENDPOINT_PUBLIC=http://<Your Local Network IP>:19000
```

### How to find error when server start failed ?

You can use `docker compose logs` to see server logs, for example:
```shell
# see universer latest 20 minute logs
docker compose logs -f universer --since 20m
```

If you need assistance, feel free to contact us.

### How to restart, stop, uninstall server ?
```shell
# restart server
bash run.sh

# stop server
docker compose stop

# uninstall
docker compose down

# uninstall and clean data
docker compose down --volumes
```

### How to change host port the server used ?

You can update the `.env` file, then run `bash run.sh`

```
# host ports
HOST_NGINX_PORT=8000
HOST_MINIO_PORT=19000
HOST_GRAFANA_PORT=13000
```
40 changes: 39 additions & 1 deletion src/docs/guides/general/server/docker.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,42 @@ Univer 服务默认端口如下:

- image: bitnami/minio:${MINIO_VERSION}
+ image: univer-acr-registry.cn-shenzhen.cr.aliyuncs.com/release/minio:${MINIO_VERSION}
```
```

### 怎么排查服务启动报错?

你可以用 `docker compose logs` 命令查看服务日志,例如:

```shell
# 查看 universer 最近20分钟内的日志
docker compose logs -f universer --since 20m
```

如果你需要帮助,请尽管联系我们。

### 如何重启、停止、卸载服务?

```shell
# 重启
bash run.sh

# 停止
docker compose stop

# 卸载
docker compose down

# 卸载并删除数据
docker compose down --volumes
```

### 怎样修改服务端口?

可以更新 `.env` 文件,然后执行 `bash run.sh` 重启。

```
# host ports
HOST_NGINX_PORT=8000
HOST_MINIO_PORT=19000
HOST_GRAFANA_PORT=13000
```

0 comments on commit 6809cc5

Please sign in to comment.