Skip to content

Commit

Permalink
更新README
Browse files Browse the repository at this point in the history
  • Loading branch information
xff committed Mar 21, 2024
1 parent ef4eeb8 commit b3b0acb
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![release](https://img.shields.io/github/v/release/lazzyfu/goInsight.svg)](https://github.com/lazzyfu/goInsight/releases)
<img alt="Github Stars" src="https://img.shields.io/github/stars/lazzyfu/goInsight?logo=github">

goInsight是集数据库工单和数据查询的平台,提供语法审核、工单流、数据查询能力,支持MySQL/TiDB/ClickHouse。旨在降低数据库管理员、研发测试等人员使用成本。注重用户隐私保护,并支持本地快速部署。
goInsight是集数据库工单和数据查询的平台,提供语法审核、工单审批执行、数据查询能力,支持MySQL/TiDB/ClickHouse。旨在降低数据库管理员、研发测试等人员使用成本。注重用户隐私保护,并支持本地快速部署,使用简单

## 文档
:point_right: [goInsight文档](https://github.com/lazzyfu/goInsight/wiki)
Expand All @@ -17,6 +17,7 @@ goInsight是集数据库工单和数据查询的平台,提供语法审核、
- **工单流** - 支持DDL、DML、数据导出(CSV/XLSX格式)工单,支持审批、执行、Hook功能,单个工单最大支持提交2048条SQL语句。
- **组织管理** - 支持用户组织层级管理,可以为每个DB实例绑定组织,实现用户只访问当前组织的数据库,支持用户角色管理。
- **其他功能**
- 支持自定义工单环境,可根据自己场景定义多个工单环境并绑定不同数据库实例,如研发环境、预发布环境、测试环境、生产环境等。
- 支持双因素身份认证登录、支持日志审计。
- 支持钉钉/企业微信机器人/邮件推送消息。

Expand All @@ -27,30 +28,33 @@ goInsight是集数据库工单和数据查询的平台,提供语法审核、
| TiDB | >= 4.0 | &#9745; DDL/DML工单 <br> &#9745; 导出工单 <br> &#9745; 数据查询 <br> &#9744; DML回滚 <br> &#9745; Online DDL(TiDB原生支持) |
| Clickhouse | >= 18.1 | &#9744; DDL/DML工单 <br> &#9744; 导出工单 <br> &#9745; 数据查询 |

## 安装
> [使用Supervisor管理服务](https://github.com/lazzyfu/goInsight/wiki/Service-Deployment)
## 部署
> [!NOTE]
> [建议使用Supervisor管理服务](https://github.com/lazzyfu/goInsight/wiki/Service-Deployment)
### 一、下载二进制包

下载前请更新下载链接中的`版本号`为最新的`发行版本`
#### 1.下载二进制包
> [!NOTE]
> 下载前请更新下载链接中的`版本号`为最新的`发行版本`
```
wget https://github.com/lazzyfu/goInsight/releases/download/v1.2.3/goinsight-linux-amd64-v1.2.3.tar.gz
wget https://github.com/lazzyfu/goInsight/releases/download/v1.3.1/goinsight-linux-amd64-v1.3.1.tar.gz
```

### 二、安装gh-ost工具
#### 2.安装gh-ost工具
> [!IMPORTANT]
> gh-ost提供MySQL ONLINE DDL功能
`MySQL DDL`改表工单自动集成`gh-ost`工具,请提前安装[gh-ost](https://github.com/github/gh-ost)
`MySQL DDL`改表工单自动集成`gh-ost`工具,请安装[gh-ost](https://github.com/github/gh-ost)

### 三、启动服务
#### 3.启动服务

请确保已正确配置config.yaml。
启动服务前,请确保已正确配置`config.yaml`

```
./goInsight -config config.yaml
```

### 四、访问Web界面
#### 4.访问Web界面

现在您可以访问goInsight的Web地址:<http://ip:port>,请确保防火墙放通了您启动服务时指定的port端口。

Expand Down

0 comments on commit b3b0acb

Please sign in to comment.