You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: i18n/en/docusaurus-plugin-content-docs-guides/current/gettingStarted/dockerCompose.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ docker compose down
52
52
- View logs:
53
53
54
54
```bash
55
-
docker logs -f openim-server
55
+
docker compose logs -f openim-server openim-chat
56
56
```
57
57
58
58
### 2.4 Monitoring & Alerting (Optional)
@@ -74,13 +74,11 @@ Default ports follow the current `.env`. Common values are:
74
74
75
75
To quickly experience core OpenIMSDK capabilities and verify whether OpenIMServer / ChatServer deployment is working, refer to [Quick Verification](./quickTestServer).
76
76
77
-
> Additional note for the current project layout: if you deploy from the two source repositories `open-im-server` and `chat`, `open-im-server/docker-compose.yml` is mainly used for dependency components, and ChatServer still needs to be started with `mage start` in the `chat` directory. See [Source Code Deployment](./imSourceCodeDeployment).
78
-
79
77
## 4. FAQ
80
78
81
79
### Troubleshooting `unhealthy`
82
-
1. Run `docker exec -it openim-server mage check` and confirm whether the state lasts longer than one minute.
83
-
2. Run `docker logs -f openim-server` to inspect logs.
80
+
1. Run `docker exec -it openim-server mage check` and `docker exec -it openim-chat mage check`, then confirm whether either state lasts longer than one minute.
81
+
2. Run `docker compose logs -f openim-server openim-chat` to inspect logs.
84
82
3. If `openim-chat` briefly reports `connect: connection refused` during startup, wait `30-60s` and check again. This is usually a startup ordering issue while `openim-server` is still becoming ready.
Copy file name to clipboardExpand all lines: i18n/en/docusaurus-plugin-content-docs-guides/current/gettingStarted/env-comp.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ sidebar_position: 1
26
26
| --- | --- | --- |
27
27
| Operating system | Linux | Officially uses `ubuntu 22.04`; `Debian 13` has also been verified to work |
28
28
| Hardware resources | 8 CPU cores, 16 GB RAM, 10 Mbps bandwidth, 1 TB disk | Estimated for 100k registered users, 10% daily online ratio, 50k-member large groups, and 600 messages per second; requires a public IP |
29
-
| CPU architecture |`x86_64`| ARM requires separate verification |
29
+
| CPU architecture |`x86_64`, `arm64`| Other architectures require separate verification |
30
30
| Golang |`v1.22.7` or higher |[Installation reference](https://go.dev/learn/)|
31
31
| Docker |`v24.0.5` or higher | Must include `compose` support |
32
32
| Git |`v2.17.1` or higher |[Installation reference](https://git-scm.com/downloads)|
@@ -38,7 +38,7 @@ sidebar_position: 1
38
38
| MongoDB |`v7.0`|`standalone`, `replicaSet`, `sharded`| Supported; for replica sets or sharded clusters, `uri` is preferred |
| Etcd |`v3.5.13`| Single node, multi-node cluster | No managed cloud support |
41
-
| Kafka |`v3.5.1`| Single node, distributed cluster | Supported; create the required topics in advance according to the docs |
41
+
| Kafka |`v3.5.1`| Single node, distributed cluster | Supported; [create the required topics in advance according to the docs](./imSourceCodeDeployment#22-initialization-requirements-for-self-hosted-components-or-cloud-services)|
42
42
| MinIO |`RELEASE.2024-01-11T07-46-16Z`| Single node | Can be replaced with S3-compatible storage such as `COS`, `OSS`, `Kodo` (community-maintained), or `AWS S3`|
Copy file name to clipboardExpand all lines: i18n/en/docusaurus-plugin-content-docs-guides/current/gettingStarted/quickTestServer.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,14 @@ Enter `http://your_server_ip:11001` in your browser to access PC Web. `your_serv
21
21
22
22
23
23
24
+
If you do not have a test account yet, complete registration with the following steps:
25
+
26
+
1. Click the registration entry at the bottom of the login page.
27
+
2. Fill in the required registration information. If registration verification codes are enabled in the current deployment, complete that verification as well.
28
+
3. After registration succeeds, return to the login page, sign in with the new account, and continue the remaining verification steps.
29
+
30
+
> If self-service registration is disabled in the current deployment, use an existing test account instead.
31
+
24
32
If you need to register an account on PC Web, the default verification code is `666666`.
25
33
26
34
> This value comes from `verifyCode.superCode` in `chat/config/chat-rpc-chat.yml`. By default, both `phone.use` and `mail.use` are also set to `superCode`. If you have changed the configuration, use the actual deployed value.
@@ -29,13 +37,15 @@ If you need to register an account on PC Web, the default verification code is `
29
37
30
38
Confirm that OpenIMServer and ChatServer are running normally.
31
39
40
+
### Docker Deployment
41
+
32
42
```bash
33
43
docker ps | grep -E 'openim-server|openim-chat'
34
44
```
35
45
36
46
> In the `docker deployment` scenario, `openim-server` and `openim-chat` may initially show `health: starting`. Wait `20-30s` until they become `healthy` before continuing with API verification.
0 commit comments