Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: fix error. #150

Merged
merged 11 commits into from
Aug 23, 2024
Merged

fix: fix error. #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
424f065
feat: update userInfoEx interface docs and update some comment.
mo3et Aug 23, 2024
5989a1d
docs: update `gettingStarted` module in EN docs.
mo3et Aug 23, 2024
86ceb6a
Merge branch 'main' of github.com:openimsdk/docs into docs/user-info
mo3et Aug 23, 2024
4c25ed5
update docs contents.
mo3et Aug 23, 2024
2739472
update content.
mo3et Aug 23, 2024
a948cbc
update cn-docs run script.
mo3et Aug 23, 2024
ec20bc0
feat: update error.
mo3et Aug 23, 2024
6838b02
Merge branch 'main' of github.com:openimsdk/docs into docs/user-info
mo3et Aug 23, 2024
095bf54
fix error.
mo3et Aug 23, 2024
bae2866
Merge branch 'main' of github.com:openimsdk/docs into docs/user-info
mo3et Aug 23, 2024
c83c3b0
revert file.
mo3et Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion docs/guides/gettingStarted/admin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,45 @@ docker compose 部署时，会自动部署如下组件，如使用源码部署
send_resolved: true # 告警解决时是否发送通知
```

5. 邮件模版文件 email.tmpl 说明：此文件是 html 格式，告警管理模块会填充里面的变量信息，然后渲染成 html 格式文件，进行邮件的发送，可根据需求自行改写:

```tmpl
{{ define "email.to.html" }}
{{ if eq .Status "firing" }}
{{ range .Alerts }}
<!-- Begin of OpenIM Alert -->
<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
<h3>OpenIM Alert</h3>
<p><strong>Alert Status:</strong> firing</p>
<p><strong>Alert Program:</strong> Prometheus Alert</p>
<p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
<p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
<p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
<p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
<p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
<p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
</div>
{{ end }}
{{ else if eq .Status "resolved" }}
{{ range .Alerts }}
<!-- Begin of OpenIM Alert -->
<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
<h3>OpenIM Alert</h3>
<p><strong>Alert Status:</strong> resolved</p>
<p><strong>Alert Program:</strong> Prometheus Alert</p>
<p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
<p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
<p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
<p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
<p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
<p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
</div>
{{ end }}
<!-- End of OpenIM Alert -->
{{ end }}
{{ end }}
```

## 登录管理后台

在浏览器中输入 `http://ip:11002` 来访问管理后台。此 IP 为服务端 OPENIM_IP，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
Expand Down Expand Up @@ -223,4 +262,4 @@ rpc_count
prometheus 容器没启动成功一般是两个原因：

1. 没有在`prometheus.yml`中配置内网 ip。
2. 第一次启动`prometheus`容器时可能会遇到权限问题，在`open-im-server`项目下运行`chmod -R 777 components`后重新启动容器即可。
2. 第一次启动`prometheus`容器时可能会遇到权限问题，在`open-im-server`项目下运行`chmod -R 777 components`后重新启动容器即可。
38 changes: 0 additions & 38 deletions i18n/en/docusaurus-plugin-content-docs-guides/current/gettingStarted/admin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,44 +101,6 @@ When deploying with Docker Compose, the following components will be automatical
send_resolved: true # Whether to send a notification when the alert is resolved
```

5. **email.tmpl Template File Description**: This file is in HTML format. The alert management module will fill in the variable information and render it into an HTML file to send the email. You can modify it according to your needs:

```tmpl
{{ define "email.to.html" }}
{{ if eq .Status "firing" }}
{{ range .Alerts }}
<!-- Begin of OpenIM Alert -->
<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
<h3>OpenIM Alert</h3>
<p><strong>Alert Status:</strong> firing</p>
<p><strong>Alert Program:</strong> Prometheus Alert</p>
<p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
<p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
<p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
<p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
<p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
<p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
</div>
{{ end }}
{{ else if eq .Status "resolved" }}
{{ range .Alerts }}
<!-- Begin of OpenIM Alert -->
<div style="border:1px solid #ccc; padding:10px; margin-bottom:10px;">
<h3>OpenIM Alert</h3>
<p><strong>Alert Status:</strong> resolved</p>
<p><strong>Alert Program:</strong> Prometheus Alert</p>
<p><strong>Severity Level:</strong> {{ .Labels.severity }}</p>
<p><strong>Alert Type:</strong> {{ .Labels.alertname }}</p>
<p><strong>Affected Host:</strong> {{ .Labels.instance }}</p>
<p><strong>Affected Service:</strong> {{ .Labels.job }}</p>
<p><strong>Alert Subject:</strong> {{ .Annotations.summary }}</p>
<p><strong>Trigger Time:</strong> {{ .StartsAt.Format "2006-01-02 15:04:05" }}</p>
</div>
{{ end }}
<!-- End of OpenIM Alert -->
{{ end }}
{{ end }}
```

## Accessing the Admin Panel

Expand Down
Loading