diff --git a/docs/dev-manual/auditplugins/eclipse.md b/docs/dev-manual/auditplugins/eclipse.md index 2ef97b5f3..8e3eaf617 100644 --- a/docs/dev-manual/auditplugins/eclipse.md +++ b/docs/dev-manual/auditplugins/eclipse.md @@ -27,7 +27,7 @@ Eclipse审核插件可以在开发阶段实时进行自助式的SQL审核，确 2. 选择HTTP连接方式 3. 输入登录信息 1. 选择账号密码登录时，需要填写用于登录的账密信息 - 2. 选择token登录时，需要填写在个人中心生成的访问令牌 + 2. 选择token登录时，需要填写在个人中心生成的[访问令牌](../../user-manual/user-manager/account.md) 4. 点击`Test Connection`按钮，确保能够成功连接到SQLE并获取项目和数据库类型列表。 3. 选择审核的数据对象 1. 依次选择Project、DB Type、Data Source和Schema下拉框，配置要进行审核的数据库信息。 @@ -65,4 +65,4 @@ Eclipse审核插件可以在开发阶段实时进行自助式的SQL审核，确 ::: ### 后续操作 -Eclipse中产生的审核操作，将同步记录到SQLE平台，您可以在平台查看历史审核记录。 \ No newline at end of file +Eclipse中产生的审核操作，将同步记录到SQLE平台，您可以在平台查看[历史审核记录](../../user-manual/project/IDEaudit.md)。 \ No newline at end of file diff --git a/docs/dev-manual/auditplugins/jetbrains.md b/docs/dev-manual/auditplugins/jetbrains.md index 2b426bf5b..fa4b8891c 100644 --- a/docs/dev-manual/auditplugins/jetbrains.md +++ b/docs/dev-manual/auditplugins/jetbrains.md @@ -38,6 +38,7 @@ title: IDEA审核插件 |http/https按钮|指定连接SQLE的方式| |UserName|登录SQLE使用的用户名| |Password|登录SQLE使用的密码| +|token|登录SQLE时使用的访问令牌| |Test Connection|测试连接是否成功, 将会尝试登录| |DB Type|当其他配置正确时，该下拉框会自动获取支持审核的实例类型。选择实例类型后，平台将使用该实例类型应用的审核规则进行审核| |Data Source|选择使用的数据源| diff --git a/docs/dev-manual/plugins/howtouse.md b/docs/dev-manual/plugins/howtouse.md index a5bdd72d4..f2d2437c3 100644 --- a/docs/dev-manual/plugins/howtouse.md +++ b/docs/dev-manual/plugins/howtouse.md @@ -21,11 +21,9 @@ drwxr-x--- 4 actiontech-universe actiontech 112 12月 8 03:19 static ``` ### 修改配置文件config.yaml :::tip -配置插件时，主要注意两个方面的配置 -* dms组件中，需要在database_driver_options部分配置数据库logo存储路径、变量信息，详细配置信息请参考[配置文件说明](/docs/deploy-manual/config.md) -* sqle组件中，根据数据源类型的不同，目前有两种不同的配置文件书写方式。用户应根据实际情况选择相应的配置方式进行填写。 +注意：dms组件中，需要在database_driver_options部分配置数据库logo存储路径、变量信息，详细配置信息请参考[配置文件说明](/docs/deploy-manual/config.md) ::: -```jsx title="config.yaml # 针对PostgreSQL、SQL server、TiDB、OceanBase For MySQL类型的数据源" +```jsx title="config.yaml " dms: id: 1 api: @@ -84,78 +82,10 @@ sqle: mysql_schema: 'sqle' ``` -```jsx title="config.yaml # 针对Oracle和DB2类型的数据源，须先在SQLE环境中安装JDK" -dms: - id: 1 - api: - addr: 0.0.0.0 - port: 7601 - service: - database: - username: root - password: root - host: 127.0.0.1 - port: 3306 - database: dms - debug: true - log: - level: DEBUG - path: logs - max_size_mb: 100 - max_backup_number: 10 - cloudbeaver: - enable_https: false - host: 172.41.134.5 - port: 8978 - admin_user: administrator - admin_password: 123456 - secret_key: - database_driver_options: ## 需要配置数据库logo存储路径、变量信息 - - db_type: MySQL - logo_path: "/logo/mysql.png" - params: - - db_type: DB2 - logo_path: "/static/logo/db2.png" - params: [ - { - "key":"database_name", - "value":"", - "desc":"数据库名", - "type":"string" - }, - ] -sqle: - id: 1 - dms_server_address: http://127.0.0.1:7601 - api: - addr: 127.0.0.1 - port: 10000 - enable_https: false - cert_file_path: './etc/cert.pem' - key_file_path: './etc/key.pem' - secret_key: - service: - auto_migrate_table: true - debug_log: false - log_path: './logs' - log_max_size_mb: 1024 - log_max_backup_number: 2 - plugin_path: './plugins' ## 插件所在路径，也可以填写绝对路径 - plugin_config: - - plugin_name: 'sqle-db2-plugin.jar' ## 填写插件文件名称 - cmd: 'java -jar /opt/sqle/plugins/sqle-db2-plugin.jar' ## 填写插件启动指令及插件绝对路径 - enable_cluster_mode: - database: - mysql_host: '127.0.0.1' - mysql_port: '3306' - mysql_user: 'root' - mysql_password: 'root' - mysql_schema: 'sqle' -``` :::tip 1. 针对Oracle和DB2类型的数据源，须先在SQLE环境中安装JDK yum install java-1.8.0-openjdk* -y -2. 针对Sql-Server类型的数据源，需要安装 .net 6.0 版本 +1. 针对Sql Server类型的数据源，需要安装 .net 6.0 版本 * unbuntu * apt-get install -y dotnet-sdk-6.0 * centos diff --git a/docs/support/compare.md b/docs/support/compare.md index 252282292..1bd5e3b26 100644 --- a/docs/support/compare.md +++ b/docs/support/compare.md @@ -13,7 +13,7 @@ title: 功能对比 企业版 - 支持的数据源类型 + 支持的数据源类型 MySQL ✅ ✅ @@ -78,6 +78,12 @@ title: 功能对比 ✅ + + + GoldenDB + + + ✅ 审核方式 @@ -167,8 +173,8 @@ title: 功能对比 SQL下钻分析 - - + ✅ + ✅ ✅ @@ -374,7 +380,7 @@ title: 功能对比 ✅ - 对接能力 + 对接能力 用户对接:LDAP ✅ ✅ @@ -387,43 +393,49 @@ title: 功能对比 ✅ - 消息通知：邮件告警 + 邮件告警 ✅ ✅ ✅ - 消息通知：微信企业号告警 + 微信企业号告警 ✅ ✅ ✅ - 消息通知：飞书告警 - ✅ - ✅ + 微信企业号审批 + + ✅ - 流程对接：钉钉在线审批 + 飞书告警 ✅ ✅ ✅ - 流程对接：飞书在线审批 + 飞书在线审批 ✅ - OpenAPI：提供完整的标准接口方案 + 钉钉在线审批 + + + ✅ + + + webhook告警 ✅ ✅ ✅ - webhook告警 + OpenAPI：提供完整的标准接口方案 ✅ ✅ ✅ @@ -633,7 +645,7 @@ title: 功能对比 ### 非MySQL系 - +
@@ -652,7 +664,7 @@ title: 功能对比 - + @@ -661,7 +673,7 @@ title: 功能对比 - + @@ -670,7 +682,7 @@ title: 功能对比 - + @@ -679,7 +691,7 @@ title: 功能对比 - + @@ -688,7 +700,7 @@ title: 功能对比 - + @@ -698,7 +710,7 @@ title: 功能对比 - + @@ -725,7 +737,7 @@ title: 功能对比 - + @@ -779,7 +791,7 @@ title: 功能对比 - + @@ -788,7 +800,7 @@ title: 功能对比 - + @@ -797,7 +809,7 @@ title: 功能对比 - + @@ -807,6 +819,6 @@ title: 功能对比 - +
√ √ √
SQL上下文√ √ √
元数据检查√ √
SQL回滚√ √
上线中止 √
扫描任务√ √
慢日志√ √
TiDB审计日志√ √ √ √
应用程序抓取√ √ √ √
自定义√ √ √ √
其他60 21 23 83
\ No newline at end of file diff --git a/docs/user-manual/project/IDEaudit.md b/docs/user-manual/project/IDEaudit.md new file mode 100644 index 000000000..968d37dc9 --- /dev/null +++ b/docs/user-manual/project/IDEaudit.md @@ -0,0 +1,34 @@ +--- +title: IDE审核 +--- + +# IDE审核 + + +### 使用场景 +本功能适用于管理员和开发团队，旨在实现将IDE工具中生成的SQL审核同步到SQLE平台，以便管理员能够查看开发人员的审核记录和使用统计。这将帮助管理员了解开发团队的使用情况，进行性能优化和资源管理。 + +## 前置操作： + +在开始使用本功能之前，请确保完成以下操作： + +* 请确保插件已正确安装和配置，以确保SQL审核记录能够成功同步到SQLE平台。 + +:::tip +目前SQLE已提供了IDEA和Eclipse的审核插件 +* IDEA审核插件配置请参考[IDEA插件配置](docs/dev-manual/auditplugins/jetbrains.md) +* Eclipse审核插件配置请参考[Eclipse插件配置](/docs/dev-manual/auditplugins/eclipse.md) +::: + + +## 使用步骤： +下面是将IDE生成的SQL审核同步到SQLE平台的详细步骤： + +### 生成SQL审核记录 +在IDE工具中创建或编辑SQL脚本，并执行审核操作。 + +### 查看审核记录和使用统计 +登录到SQLE平台，导航到IDE审核记录页面。你将能够查看在IDE工具中生成的SQL审核记录，包括原始SQL和触发的规则。此外，你还可以获取有关开发团队的使用统计信息，如执行次数、执行时间等。 + +## 后续操作 +根据审核记录和使用统计，管理员可以了解开发团队的SQL审核情况。这将有助于进行性能优化和资源管理，例如识别慢查询、优化SQL语句、调整资源分配等。 diff --git a/docs/user-manual/project/audit_task/SQLfile_audit.md b/docs/user-manual/project/audit_task/SQLfile_audit.md index ca0116e48..578d1b956 100644 --- a/docs/user-manual/project/audit_task/SQLfile_audit.md +++ b/docs/user-manual/project/audit_task/SQLfile_audit.md @@ -33,8 +33,8 @@ title: SQL文件扫描 参数解释如下： * -J, --project：说明扫描任务所在项目，例如“default”； -* -H, --host string：指定SQLE主机所在地址； -* -P, --port string：指定SQLE所在端口； +* -H, --host string：指定dms主机所在地址； +* -P, --port string：指定dms所在端口； * -N, --name string：指定扫描任务名称，scannerd会将获得的SQL传至指定的任务池中审核； * -D, --dir string：指定要扫描的SQL文件路径； * -A, --token string：输入扫描任务凭证token； diff --git a/docs/user-manual/project/audit_task/mybatis.md b/docs/user-manual/project/audit_task/mybatis.md index 1a1adb859..d3f8e7784 100644 --- a/docs/user-manual/project/audit_task/mybatis.md +++ b/docs/user-manual/project/audit_task/mybatis.md @@ -36,8 +36,8 @@ title: MyBatis扫描 参数解释如下： * -J, --project：说明扫描任务所在项目，例如“default”； -* -H, --host string：指定SQLE主机所在地址； -* -P, --port string：指定SQLE所在端口； +* -H, --host string：指定dms主机所在地址； +* -P, --port string：指定dms所在端口； * -N, --name string：指定扫描任务名称，scannerd会将获得的SQL传至指定的任务池中审核； * -D, --dir string：指定要扫描的XML文件路径 * -A, --token string：输入扫描任务凭证token； diff --git a/docs/user-manual/project/audit_task/slowlog_audit.md b/docs/user-manual/project/audit_task/slowlog_audit.md index 3abf56263..959173fa3 100644 --- a/docs/user-manual/project/audit_task/slowlog_audit.md +++ b/docs/user-manual/project/audit_task/slowlog_audit.md @@ -55,7 +55,7 @@ long_query_time = 1 //设置慢查询时间阈值，当前示例时间为1s， 参数解释如下： * -J, --project：说明扫描任务所在项目，例“default”； -* -H, --host string：指定SQLE主机所在地址； +* -H, --host string：指定dms主机所在地址； * -N, --name string：指定扫描任务名称，scannerd会将获得的慢SQL传至指定的任务池中审核； * -P, --port string：指定SQLE所在端口； * -A, --token string：输入扫描任务凭证token； diff --git a/docs/user-manual/project/dataexport.md b/docs/user-manual/project/dataexport.md index 8d4a9ecf0..86a35283c 100644 --- a/docs/user-manual/project/dataexport.md +++ b/docs/user-manual/project/dataexport.md @@ -8,6 +8,12 @@ title: 数据导出 当您需要使用数据但没有足够的权限时，可以利用数据导出功能获取需要的数据。平台通过预检查及审批流程确保数据的安全访问，并记录详细的数据导出信息，包括导出人员、导出目的及导出的数据等内容，有助于审核人全面了解数据的使用情况，从而更好地保障数据安全。 +## 支持的数据源类型 +* MySQL +* PG +* Oracle +* SQL Server + ## 前置条件 在进行以下操作之前，请先创建两个成员，分别配置其在数据源上有`创建数据导出任务`、`审批/驳回数据导出工单`的权限、 @@ -40,6 +46,7 @@ title: 数据导出 * 如果审批不通过，审批人点击 "驳回"，并填写驳回原因。 * 如果审批通过，由工单创建人执行导出操作。 + ### 下载导出文件 要下载导出文件，请按照以下步骤进行操作： 1. 以user1账号登录DMS平台，进入导出工单详情，点击执行导出。 @@ -47,4 +54,6 @@ title: 数据导出 ![exportresult](img/exportresult.png) - +### 后续操作 +当您需要线下人工审核SQL语句，或是事后审计时，可以进入导出工单详情，下载SQL语句 +![exportdownload](img/exportdownload.png) \ No newline at end of file diff --git a/docs/user-manual/project/img/exportdownload.png b/docs/user-manual/project/img/exportdownload.png new file mode 100644 index 000000000..5609a2673 Binary files /dev/null and b/docs/user-manual/project/img/exportdownload.png differ diff --git a/docs/user-manual/sys-configuration/login_syn.md b/docs/user-manual/sys-configuration/login_syn.md index 1ecbcd7d7..984a5bb42 100644 --- a/docs/user-manual/sys-configuration/login_syn.md +++ b/docs/user-manual/sys-configuration/login_syn.md @@ -57,7 +57,8 @@ SQLE中支持通过配置的方式接入OAuth 2.0系统, 如同其他系统一 * 请求资源范围：此范围由验证服务器定义 * access_token放置位置：SQLE会在获取用户ID时将access_token放在这个key对应的value中, 此参数会作为get请求的参数发送给用户ID获取地址 * 用户ID保存位置：SQLE会尝试使用此key从第三方平台的响应中解析出用户ID,用户ID应当为唯一ID -* 登录按钮文字 +* 登录按钮文字：用于登录页面按钮提示 +* 自动创建并绑定用户：若开启，在通过OAuth2登陆时，若该用户未绑定SQLE用户，SQLE则会根据从OAuth2服务端获取的用户id创建SQLE账户，并且不会跳转到绑定界面，而是进入SQLE主界面 :::tip 当仅允许内网访问SQLE服务时，请确保回调地址的后缀为"/v1/oauth2/callback"。 diff --git a/docs/user-manual/user-manager/account.md b/docs/user-manual/user-manager/account.md new file mode 100644 index 000000000..a2064565b --- /dev/null +++ b/docs/user-manual/user-manager/account.md @@ -0,0 +1,46 @@ +--- +title: 个人中心 +--- + + +个人中心页面提供以下功能： + +* 修改邮箱：允许您更新个人账户绑定的邮箱地址。 +* 修改企业微信userid：允许您更新与企业微信关联的用户ID。 +* 修改手机：允许您更新个人账户绑定的手机号码。 +* 生成个人访问token：允许您生成用于访问个人账户的访问令牌。 + + +## 使用场景 +当您需要修改个人账户信息和生成访问令牌时，可以进入个人中心编辑。 + +## 入口 +1. 登录SQLE平台 +2. 点击右下角头像图标，选择`个人中心`进入 + + +## 使用步骤 +### 修改邮箱 + +* 定位到`邮箱`选项并点击编辑图标。 +* 输入新的邮箱地址。 +* 点击保存或确认按钮以应用更改。 + +### 修改企业微信userid + +* 定位到`企业微信userid`选项并点击编辑图标。 +* 输入新的userid。 +* 点击保存或确认按钮以应用更改。 + +### 修改手机 + +* 定位到`手机`选项并点击编辑图标。 +* 输入新的手机号。 +* 点击保存或确认按钮以应用更改。 + + +### 生成个人访问token +* 定位到`生成个人访问token`选项并点击，设置访问令牌的失效时间。 +* 系统将生成一个唯一的访问令牌。 +* 复制该访问令牌以备将来使用或记录下来。 +* 访问令牌可用于访问个人账户的受限资源或进行身份验证。 \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 9e3c64700..98a74a120 100644 --- a/sidebars.js +++ b/sidebars.js @@ -59,6 +59,7 @@ const sidebars = { "user-manual/project/sqlmanage", "user-manual/project/dataexport", "user-manual/project/quick_audit", + "user-manual/project/IDEaudit", { type: 'category', label: '工单', @@ -116,6 +117,7 @@ const sidebars = { "user-manual/user-manager/intro", "user-manual/user-manager/user", "user-manual/user-manager/role", + "user-manual/user-manager/account", ], }, "user-manual/customrule",