diff --git a/src/index.jsx b/src/index.jsx index 0f3c261..f67b3b1 100644 --- a/src/index.jsx +++ b/src/index.jsx @@ -5,7 +5,7 @@ banner: btns: - { name: '开 始', href: '/docs/quickstart.html', primary: true } - { name: 'Github >', href: 'https://github.com/buession/buession-cas' } - caption: '当前版本: v2.2.0' + caption: '当前版本: v2.3.0' features: - { name: '优雅', desc: '经过精雕细琢，我们带给大家一个精心设计的、标准的、高内聚低耦合的通用类库' } - { name: '灵活', desc: '非重复造车轮，我们是整合市面上开源的类库，以标准的接口暴露给上层用户，用户可替换或自行封装同类组件。在此基础上，封装了大量的常用的类库。' } diff --git a/src/manual/2.3/audit/index.md b/src/manual/2.3/audit/index.md new file mode 100644 index 0000000..a52d393 --- /dev/null +++ b/src/manual/2.3/audit/index.md @@ -0,0 +1,21 @@ +# buession-cas-audit 参考手册 + + +Apereo CAS 审计相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-audit + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-audit/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/captcha/ConfigurationProperties.md b/src/manual/2.3/captcha/ConfigurationProperties.md new file mode 100644 index 0000000..dcd11dd --- /dev/null +++ b/src/manual/2.3/captcha/ConfigurationProperties.md @@ -0,0 +1,45 @@ +# buession-cas-captcha 参考手册 + + +## 配置属性 + + +#### 通用 + +| 属性 | 类型 | 默认值 | 说明 | +| ---- | ---- | ---- | ---- | +| cas.captcha.javascript | String[] | -- | 前端 JavaScript 库地址 | + + +#### 阿里云 + +| 属性 | 类型 | 默认值 | 说明 | +| ---- | ---- | ---- | ---- | +| cas.captcha.aliyun.enabled | boolean | true | 是否启用阿里云行为验证码 | +| cas.captcha.aliyun.access-key-id | String | -- | AccessKey ID | +| cas.captcha.aliyun.access-key-secret | String | -- | AccessKey Secret | +| cas.captcha.aliyun.app-key | String | -- | 服务使用的 App Key | +| cas.captcha.aliyun.region-id | String | -- | 区域 ID | +| cas.captcha.aliyun.parameter | [AliyunParameter](https://javadoc.io/doc/com.buession.security/buession-security-captcha/2.3.0/com/buession/security/captcha/aliyun/AliyunParameter.html) | AliyunParameter 默认值 | 前端提交参数名称 | + + +#### 极验 + +| 属性 | 类型 | 默认值 | 说明 | +| ---- | ---- | ---- | ---- | +| cas.captcha.geetest.enabled | boolean | true | 是否启极验行为验证码 | +| cas.captcha.geetest.app-id | String | -- | 应用 ID | +| cas.captcha.geetest.secret-key | String | -- | 密钥 | +| cas.captcha.geetest.version | String | v4 | 版本 | +| cas.captcha.geetest.v3.parameter | [GeetestV3Parameter](https://javadoc.io/doc/com.buession.security/buession-security-captcha/2.3.0/com/buession/security/captcha/geetest/api/v3/GeetestV3Parameter.html) | GeetestV3Parameter 默认值 | 前端提交参数名称 | +| cas.captcha.geetest.v4.parameter | [GeetestV4Parameter](https://javadoc.io/doc/com.buession.security/buession-security-captcha/2.3.0/com/buession/security/captcha/geetest/api/v4/GeetestV4Parameter.html) | GeetestV4Parameter 默认值 | 前端提交参数名称 | + + +#### 腾讯 + +| 属性 | 类型 | 默认值 | 说明 | +| ---- | ---- | ---- | ---- | +| cas.captcha.tencent.enabled | boolean | true | 是否启腾讯云行为验证码 | +| cas.captcha.tencent.app-id | String | -- | 应用 ID | +| cas.captcha.tencent.secret-key | String | -- | 密钥 | +| cas.captcha.tencent.parameter | [TencentParameter](https://javadoc.io/doc/com.buession.security/buession-security-captcha/2.3.0/com/buession/security/captcha/tencent/TencentParameter.html) | TencentParameter 默认值 | 前端提交参数名称 | \ No newline at end of file diff --git a/src/manual/2.3/captcha/index.md b/src/manual/2.3/captcha/index.md new file mode 100644 index 0000000..2401454 --- /dev/null +++ b/src/manual/2.3/captcha/index.md @@ -0,0 +1,21 @@ +# buession-cas-captcha 参考手册 + + +Apereo CAS 集成 [buession-security-captcha](https://security.buession.com/manual/2.3/captcha/index.html) 行为验证码自动配置类。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-captcha + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-captcha/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/client/index.md b/src/manual/2.3/client/index.md new file mode 100644 index 0000000..a9c59c7 --- /dev/null +++ b/src/manual/2.3/client/index.md @@ -0,0 +1,21 @@ +# buession-cas-client 参考手册 + + +Apereo CAS 客户端依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-client + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-client/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/core/ConfigurationProperties.md b/src/manual/2.3/core/ConfigurationProperties.md new file mode 100644 index 0000000..2d97557 --- /dev/null +++ b/src/manual/2.3/core/ConfigurationProperties.md @@ -0,0 +1,11 @@ +# buession-cas-core 参考手册 + + +## 配置属性 + + +#### 通用 + +| 属性 | 类型 | 默认值 | 说明 | +| ---- | ---- | ---- | ---- | +| cas.client-real-ip-header-name | String | -- | 真实客户端 IP 头名称 | \ No newline at end of file diff --git a/src/manual/2.3/core/index.md b/src/manual/2.3/core/index.md new file mode 100644 index 0000000..7ce6194 --- /dev/null +++ b/src/manual/2.3/core/index.md @@ -0,0 +1,21 @@ +# buession-cas-core 参考手册 + + +Apereo CAS 核心组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-core + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-core/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/metrics/index.md b/src/manual/2.3/metrics/index.md new file mode 100644 index 0000000..7cca957 --- /dev/null +++ b/src/manual/2.3/metrics/index.md @@ -0,0 +1,21 @@ +# buession-cas-metrics 参考手册 + + +Apereo CAS metrics 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-metrics + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-metrics/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/service/index.md b/src/manual/2.3/service/index.md new file mode 100644 index 0000000..c89d6eb --- /dev/null +++ b/src/manual/2.3/service/index.md @@ -0,0 +1,21 @@ +# buession-cas-service 参考手册 + + +Apereo CAS service 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-service + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-service/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/session/index.md b/src/manual/2.3/session/index.md new file mode 100644 index 0000000..3a648e5 --- /dev/null +++ b/src/manual/2.3/session/index.md @@ -0,0 +1,21 @@ +# buession-cas-session 参考手册 + + +Apereo CAS SESSION 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-session + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-session/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/support/ConfigurationProperties.md b/src/manual/2.3/support/ConfigurationProperties.md new file mode 100644 index 0000000..64b08c1 --- /dev/null +++ b/src/manual/2.3/support/ConfigurationProperties.md @@ -0,0 +1,6 @@ +# buession-cas-support 参考手册 + + +## 配置属性 + +-- \ No newline at end of file diff --git a/src/manual/2.3/support/index.md b/src/manual/2.3/support/index.md new file mode 100644 index 0000000..d47871b --- /dev/null +++ b/src/manual/2.3/support/index.md @@ -0,0 +1,21 @@ +# buession-cas-support 参考手册 + + +Apereo CAS support 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-support + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-support/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/throttle/index.md b/src/manual/2.3/throttle/index.md new file mode 100644 index 0000000..dde8b8b --- /dev/null +++ b/src/manual/2.3/throttle/index.md @@ -0,0 +1,21 @@ +# buession-cas-throttle 参考手册 + + +Apereo CAS throttle 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-throttle + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-throttle/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/ticket/index.md b/src/manual/2.3/ticket/index.md new file mode 100644 index 0000000..84ab489 --- /dev/null +++ b/src/manual/2.3/ticket/index.md @@ -0,0 +1,21 @@ +# buession-cas-ticket 参考手册 + + +Apereo CAS ticket 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-ticket + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-ticket/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/view/index.md b/src/manual/2.3/view/index.md new file mode 100644 index 0000000..1439ac6 --- /dev/null +++ b/src/manual/2.3/view/index.md @@ -0,0 +1,21 @@ +# buession-cas-view 参考手册 + + +Apereo CAS 视图相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-view + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-view/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/web/index.md b/src/manual/2.3/web/index.md new file mode 100644 index 0000000..43ba86d --- /dev/null +++ b/src/manual/2.3/web/index.md @@ -0,0 +1,21 @@ +# buession-cas-web 参考手册 + + +Apereo CAS WEB 相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-web + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-web/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/2.3/webflow/index.md b/src/manual/2.3/webflow/index.md new file mode 100644 index 0000000..5b057ac --- /dev/null +++ b/src/manual/2.3/webflow/index.md @@ -0,0 +1,21 @@ +# buession-cas-webflow 参考手册 + + +Apereo CAS 工作流相关组件依赖引入。 + + +--- + + +### 安装 + +```xml + + com.buession.cas + buession-cas-webflow + x.x.x + +``` + + +### [API 参考手册>>](https://javadoc.io/doc/com.buession.cas/buession-cas-webflow/2.3.0/index.html) \ No newline at end of file diff --git a/src/manual/SUMMARY.md b/src/manual/SUMMARY.md index 2a1106a..e79104d 100644 --- a/src/manual/SUMMARY.md +++ b/src/manual/SUMMARY.md @@ -2,6 +2,37 @@ * [简介](index.md) * [参考指南](overview.md) + * [2.3.x](2.3/index.md) + * [buession-cas-audit](2.3/audit/index.md) + * [安装](2.3/audit/index.md#安装) + * [buession-cas-captcha](2.3/captcha/index.md) + * [安装](2.3/captcha/index.md#安装) + * [配置属性](2.3/captcha/ConfigurationProperties.md) + * [buession-cas-client](2.3/client/index.md) + * [安装](2.3/client/index.md#安装) + * [buession-cas-core](2.3/core/index.md) + * [安装](2.3/core/index.md#安装) + * [配置属性](2.3/core/ConfigurationProperties.md) + * [buession-cas-metrics](2.3/metrics/index.md) + * [安装](2.3/metrics/index.md#安装) + * [buession-cas-service](2.3/service/index.md) + * [安装](2.3/service/index.md#安装) + * [buession-cas-session](2.3/session/index.md) + * [安装](2.3/session/index.md#安装) + * [buession-cas-support](2.3/support/index.md) + * [安装](2.3/support/index.md#安装) + * [配置属性](2.3/support/ConfigurationProperties.md) + * [buession-cas-throttle](2.3/throttle/index.md) + * [安装](2.3/throttle/index.md#安装) + * [buession-cas-ticket](2.3/ticket/index.md) + * [安装](2.3/ticket/index.md#安装) + * [buession-cas-view](2.3/view/index.md) + * [安装](2.3/view/index.md#安装) + * [buession-cas-web](2.3/web/index.md) + * [安装](2.3/web/index.md#安装) + * [配置属性](2.3/web/ConfigurationProperties.md) + * [buession-cas-webflow](2.3/webflow/index.md) + * [安装](2.3/webflow/index.md#安装) * [2.2.x](2.2/index.md) * [buession-cas-audit](2.2/audit/index.md) * [安装](2.2/audit/index.md#安装) diff --git a/src/manual/overview.md b/src/manual/overview.md index 232fbc8..1b3c80f 100644 --- a/src/manual/overview.md +++ b/src/manual/overview.md @@ -5,6 +5,7 @@ | 版本 | 手册 | | ---- | ---- | +| 2.3.x | [API 手册](2.3/index.html) | | 2.2.x | [API 手册](2.2/index.html) | | 2.1.x | [API 手册](2.1/index.html) | | 2.0.x | [API 手册](2.0/index.html) | \ No newline at end of file