docs: translate some docs to english

pull/90/head
moonrailgun 2 years ago
parent 47c0491e75
commit 3e8820e38f

@ -1,4 +1,4 @@
{
"label": "进阶使用",
"label": "Advanced Usage",
"position": 30
}

@ -1,21 +1,21 @@
---
sidebar_position: 2
title: Github 集成
title: Github integration
---
![](./assets/github-integration.excalidraw.png)
![](/img/github-app/github-integration.excalidraw.png)
## 普通用户使用
## Common user use
### 在项目安装应用
### Install the application in the project
地址: https://github.com/apps/tailchat
Link: https://github.com/apps/tailchat
安装到项目仓库中。
Install into the project repository.
### 在项目中进行配置
### Configure in the project
在根目录创建`.tailchat/topic.json` 文件:
Create `.tailchat/topic.json` file in the root directory:
```json
{
"groupId": "<your-notify-group-id>",
@ -23,30 +23,29 @@ title: Github 集成
}
```
## 自部署配置
## Self-host configuration
An application needs to be registered in github before the application starts:
应用启动前需要在github中注册一个应用:
![](/img/github-app/github-new-app.png)
![](./assets/github-new-app.png)
The following environment variables need to be configured during deployment:
- `APP_ID`: from the github app settings
- `WEBHOOK_SECRET`: from the github app settings
- `PRIVATE_KEY`: from the github application settings
- `TAILCHAT_APP_ID`: the id of the Tailchat open platform
- `TAILCHAT_APP_SECRET`: The secret key of Tailchat open platform
- `TAILCHAT_API_URL`: Tailchat backend address
部署时需要配置以下环境变量:
- `APP_ID`: 来自github 应用设置
- `WEBHOOK_SECRET`: 来自github 应用设置
- `PRIVATE_KEY`: 来自github 应用设置
- `TAILCHAT_APP_ID`: Tailchat 开放平台的id
- `TAILCHAT_APP_SECRET`: Tailchat 开放平台的秘钥
- `TAILCHAT_API_URL`: Tailchat 后台地址
In order to obtain `TAILCHAT_APP_ID` and `TAILCHAT_APP_SECRET`, you need to create an open platform application in the Tailchat open platform
为获取 `TAILCHAT_APP_ID``TAILCHAT_APP_SECRET` 需要在 Tailchat 开放平台中创建一个开放平台应用
At the same time, enable the robot permission and set the message callback link: `https://<your_app_url>/message/webhook`
同时开启机器人权限,并设置消息回调地址: `https://<your_app_url>/message/webhook`
### Deploy open platform applications
### 部署开放平台应用
> Source code: [https://github.com/msgbyte/tailchat/tree/master/apps/github-app](https://github.com/msgbyte/tailchat/tree/master/apps/github-app)
> 源码: [https://github.com/msgbyte/tailchat/tree/master/apps/github-app](https://github.com/msgbyte/tailchat/tree/master/apps/github-app)
After pulling the source code and deploying it to an accessible online, there are two ways:
拉取源码后部署到可供访问的线上,提供两种方式:
- 独立应用: `npm run build` 后执行 `node lib/index.js`运行应用
- Vercel: 直接推送到Vercel即可
- Standalone application: execute `node lib/index.js` after `npm run build` to run the application
- Vercel: just push to Vercel directly

@ -1,29 +1,29 @@
---
sidebar_position: 1
title: 富文本语法
title: Rich text syntax
---
## 对于普通用户
## For normal users
Tailchat 内置了 `com.msgbyte.bbcode` 插件用于对富文本消息做支持(且是默认安装的)。
Tailchat has a built-in `com.msgbyte.bbcode` plugin for rich text message support (and it is installed by default).
以下是目前 `bbcode` 插件支持的语法列表:
The following is a list of syntaxes currently supported by the `bbcode` plugin:
| 关键字 | 描述 | 用法示例 | 预览 |
| Keyword | Description | Usage Example | Preview |
| ------ | ----- | ------ | ----- |
| b | 文本加粗 | `[b]foo[/b]` | <b>foo</b> |
| i | 文本倾斜 | `[i]foo[/i]` | <i>foo</i> |
| u | 文本下划线 | `[u]foo[/u]` | <ins>foo</ins> |
| s | 文本删除线 | `[s]foo[/s]` | <del>foo</del> |
| url | 超链接 | <div style={{width: 400}}>`[url]https://tailchat.msgbyte.com[/url]` / `[url=https://tailchat.msgbyte.com]官网[/url]`</div> | <a>https://tailchat.msgbyte.com</a> / <a href="https://tailchat.msgbyte.com">官网</a> |
| img | 图片 | `[img]https://tailchat.msgbyte.com/img/logo.svg[/img]` | <div style={{width: 60}}><img src="https://tailchat.msgbyte.com/img/logo.svg" /></div> |
| at | 提及 | `[at=<hereisuserid>]moonrailgun[/at]` | - |
| emoji | 表情 | `[emoji]smile[/emoji]` | - |
| markdown / md | markdown语法支持 | `[markdown]## Heading[/markdown]` | - |
## 对于插件开发者
如果你的插件需要使用统一的富文本支持,请在你的渲染函数中这样实现:
| b | bold text | `[b]foo[/b]` | <b>foo</b> |
| i | text italic | `[i]foo[/i]` | <i>foo</i> |
| u | underline text | `[u]foo[/u]` | <ins>foo</ins> |
| s | strikethrough text | `[s]foo[/s]` | <del>foo</del> |
| url | hyperlink | <div style={{width: 400}}>`[url]https://tailchat.msgbyte.com[/url]` / `[url=https://tailchat.msgbyte.com ]Official website[/url]`</div> | <a>https://tailchat.msgbyte.com</a> / <a href="https://tailchat.msgbyte.com">official website</a> |
| img | Image | `[img]https://tailchat.msgbyte.com/img/logo.svg[/img]` | <div style={{width: 60}}><img src="https:/ /tailchat.msgbyte.com/img/logo.svg" /></div> |
| at | Mention | `[at=<hereisuserid>]moonrailgun[/at]` | - |
| emoji | expression | `[emoji]smile[/emoji]` | - |
| markdown / md | markdown syntax support | `[markdown]## Heading[/markdown]` | - |
## For plugin developers
If your plugin needs to use unified rich text support, please implement this in your rendering function:
```jsx
import { getMessageRender } from '@capital/common';

@ -3,10 +3,10 @@ sidebar_position: 3
title: 系统架构
---
## 服务端架构
## Backend Architecture
![](/img/architecture/backend.excalidraw.svg)
## 插件机制架构
## Plugin mechanism architecture
![](/img/architecture/plugin.excalidraw.svg)

@ -1,4 +1,4 @@
{
"label": "运维操作",
"label": "Operations",
"position": 15
}

@ -1,22 +1,22 @@
---
sidebar_position: 1
title: 数据库管理
title: Database management
---
`tailchat` 使用 mongodb 作为主要数据库存储用户信息
`Tailchat` uses mongodb as the main database to store user information
在`docker`中,常见的运维命令如下:
In `docker`, common operation and maintenance commands are as follows:
```bash
# 备份
# backup
docker exec -i <IMAGE_NAME> mongodump -d tailchat --archive > ./backup.archive
# 还原
# restore
docker exec -i <IMAGE_NAME> mongorestore -d tailchat --archive < ./backup.archive
```
其中`<IMAGE_NAME>` 表示mongodb镜像名而`-d tailchat` 表示使用的数据库的名字,默认启动的数据库名为`tailchat`, 你可以通过环境变量`MONGO_URL`进行修改
Among them `<IMAGE_NAME>` represents the name of the mongodb image, and `-d tailchat` represents the name of the database used, the default database name is `tailchat`, you can modify it through the environment variable `MONGO_URL`
:::info
为了用户数据安全,建议创建定时任务定期备份数据库文件
For user data security, it is recommended to create a scheduled task to regularly back up the database file
:::

@ -1,57 +1,57 @@
---
sidebar_position: 1
title: 概述
title: Summary
---
`Tailchat` 是一款插件化易拓展的开源 IM 应用。可拓展架构赋予 `Tailchat` 无限可能性。
`Tailchat` is an open source IM application that is pluggable and easy to expand. Plugin architecture gives `Tailchat` unlimited possibilities.
前端微内核架构 + 后端微服务架构 使得 `Tailchat` 能够驾驭任何定制化/私有化的场景
Front-end micro-kernel architecture + back-end micro-service architecture makes `Tailchat` to control any customized/privatized scenarios
面向企业与私域用户打造,高度自由的群组管理与定制化的面板展示可以让私域主能够更好的展示自己的作品,管理用户,打造自己的品牌与圈子。
Created for enterprises and private domain users, highly free group management and customized panel display allow private domain owners to better display their works, manage users, and build their own brand and circle.
## 特性
## Feature
- 完整的即时通讯基础能力
- 插件化架构的赋予的自由拓展能力
- 微服务架构赋予的水平拓展能力
- Complete basic ability of instant messaging
- The free expansion ability endowed by the plugin architecture
- The horizontal expansion capability endowed by the microservice architecture
## 亮点
## Highlight
- 基于[mini-star](https://ministar.moonrailgun.com/)的前端微内核架构与基于[moleculer](https://moleculer.services/)的后端微服务架构可以适应各种用户用量,便于拓展
- 完整的聊天系统支持提及、面板跳转、富文本、markdown、url链接等各种语法
- 消息reaction机制让你通过表情表达自己
- 文件分享与图片发送
- 支持语音通话与视频通话
- 完善的身份组管理,权限控制颗粒化
- 用户管理与用户禁言
- 邮箱认证与密码找回
- 多种面板: 网页嵌入, 自定义html, 话题面板
- 简易消息推送与github通知订阅
- 后台管理平台,可以
- 开放平台
- 机器人
- The front-end micro-kernel architecture based on [mini-star](https://ministar.moonrailgun.com/) and the back-end micro-service architecture based on [moleculer](https://moleculer.services/) can adapt to various user usage, easy to expand
- A complete chat system that supports various syntaxes such as mentions, panel jumps, rich text, markdown, url links, etc.
- Message reaction mechanism, allowing you to express yourself through expressions
- File sharing and image sending
- Support voice calls and video calls
- Perfect identity group management, RBAC
- User Management and User Muting
- Email authentication and password retrieval
- Various panels: web page embedding, custom html, topic panel
- Simple message push and github notification subscription
- Admin platform
- Openapi platform
- Bot
- OAuth
- 插件带来的更多奇妙化学反应
- 自定义主题
- 在线听音乐
- 消息加密
- url获取元数据
- 隔空投送
- 任务管理
- 在线绘图
- 字体放大
- 工具箱
- More wonderful chemical reactions brought by plugins
- custom theme
- listen to music online
- message encryption
- fetch link metadata
- Airdrop
- Task
- Draw
- Font size
- Toolbox
- ...
## 技术栈
## Technology Stack
- 前端
- Frontend
- `React`
- `Redux`
- `mini-star`
- `tailwindcss`
- `iconify`
- 后端
- Backend
- `Nodejs`
- `Socket.io`
- `koa`
@ -59,6 +59,8 @@ title: 概述
## 截图
<!-- TODO -->
#### 插件中心
![](/img/intro/plugins.png)

@ -1,26 +1,26 @@
---
sidebar_position: 2
title: 使用场景
title: Why Tailchat
---
Tailchat 的设计之处就是以插件化的架构来满足不同人群对于不同需求的实现。
The design of `Tailchat` is to use a plug-in architecture to meet different needs of different groups of people.
## 对于个人用户
## For personal
- 如果希望和朋友一起玩
- 创建一个群组
- 通过多个频道分割不同的话题
- 使用网页面板来分享喜欢的网页
- 如果希望聚集自己的粉丝圈
- 使用机器人来订阅自己的信息并转发到聊天面板
- 让自己的粉丝集中在一起不需要创建无数个qq群/微信群
- 多个频道让多个话题能够一起产生
- 如果对于自己的隐私非常看中
- 自己部署让一切都能掌控在手中
- If you want to play with friends
- Create a group
- Divide different topics through multiple channels
- Use the web panel to share favorite web pages
- If you want to gather your own fandom
- Use bots to subscribe to your own messages and forward them to the chat panel
- Let your fans gather together without creating countless qq groups/WeChat groups
- Multiple channels allow multiple topics to be generated together
- If you are very fancy about your privacy
- Self-host to keep everything under control
## 对于企业用户
## For enterprise
- 面板化设计满足企业自定义化设计需求
- 插件化架构可以方便基于核心进行二次开发
- 自部署的实现可以让企业价值得到保护,让企业安心
- 开源代码方便审查
- The panel design meets the customized design needs of enterprises
- Plug-in architecture can facilitate secondary development based on the core
- The realization of self-host can protect the value of the enterprise and make the enterprise feel at ease
- Open source code for easy review

@ -3,7 +3,7 @@ sidebar_position: 2
title: Github 集成
---
![](./assets/github-integration.excalidraw.png)
![](/img/github-app/github-integration.excalidraw.png)
## 普通用户使用
@ -28,7 +28,7 @@ title: Github 集成
应用启动前需要在github中注册一个应用:
![](./assets/github-new-app.png)
![](/img/github-app/github-new-app.png)
部署时需要配置以下环境变量:
- `APP_ID`: 来自github 应用设置

@ -27,7 +27,7 @@ title: 概述
- 邮箱认证与密码找回
- 多种面板: 网页嵌入, 自定义html, 话题面板
- 简易消息推送与github通知订阅
- 后台管理平台,可以
- 后台管理平台
- 开放平台
- 机器人
- OAuth

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 116 KiB

Loading…
Cancel
Save