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.

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

This PR adds both Chinese and English versions of the README.md file to improve the project's accessibility and global reach. #1049

Merged
merged 80 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from 58 commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
b8d50e5
feat(elsa): 添加对 PostgreSql 的支持
feijie999 Dec 8, 2024
3b87682
feat(elsa): 添加对 SQL Server 的支持
feijie999 Dec 8, 2024
10bcb1b
refactor(notifications): 注释掉不再使用的通知数据映射
feijie999 Dec 9, 2024
97b114c
refactor(tests): 注释掉默认消息前缀,使其能编译通过
feijie999 Dec 9, 2024
115f414
feat: 添加 PostgreSQL 支持的迁移
feijie999 Dec 9, 2024
5bcb146
feat: 添加新的配置选项以支持 PostgreSQL
feijie999 Dec 9, 2024
7a7d24b
feat(migration):生成pgsql的数据迁移文件
feijie999 Dec 9, 2024
4b25573
feat: 分离LY.MicroService.Applications.Single.EntityFrameworkCore 中的MyS…
feijie999 Dec 9, 2024
70d5949
feat: 更新数据库连接字符串和时区配置
feijie999 Dec 9, 2024
47a1712
feat(migration): 添加 MySQL 和 PostgreSQL 数据库迁移指南
feijie999 Dec 10, 2024
d626a21
feat(migrations): 添加数据库迁移脚本
feijie999 Dec 10, 2024
5ecdbcd
chore: 删除 MySql 配置文件并更新解决方案文件以包含迁移脚本
feijie999 Dec 10, 2024
3909512
fix(migrations): 更新数据库上下文名称以支持迁移脚本生成
feijie999 Dec 10, 2024
72cd606
fix: 调整配置文件路径格式化,优化可读性
feijie999 Dec 10, 2024
951ea33
feat(data-protection): 添加数据保护模块的迁移文件及配置
feijie999 Dec 10, 2024
cd136b1
feat: 更新 PostgreSQL 配置
feijie999 Dec 10, 2024
3f86fc1
feat(docs): 添加QQ和微信认证模块文档
feijie999 Dec 10, 2024
66d5be1
feat(docs): 添加任务管理模块文档
feijie999 Dec 10, 2024
36ea8be
feat(docs): 添加组织单元权限验证模块文档
feijie999 Dec 10, 2024
1fd8e1f
feat(docs): 添加阿里云模块文档
feijie999 Dec 10, 2024
49b9727
feat(docs): 添加腾讯云模块文档
feijie999 Dec 10, 2024
089a197
feat(docs): 添加Core模块文档
feijie999 Dec 10, 2024
9e6049e
feat(docs): 添加IdGenerator模块文档
feijie999 Dec 10, 2024
e01f056
feat(docs): 添加IP2Region模块文档
feijie999 Dec 10, 2024
6b15dbf
feat(docs): 添加Wrapper模块文档
feijie999 Dec 10, 2024
4586f30
feat(docs): 添加RealTime模块文档
feijie999 Dec 10, 2024
1c181e0
feat(docs): 添加Location模块文档
feijie999 Dec 10, 2024
858112a
feat(docs): 添加接口幂等性检查模块文档
feijie999 Dec 10, 2024
984310f
feat(docs): 添加Dapr模块文档
feijie999 Dec 10, 2024
d6c254f
feat(docs): 添加数据权限模块文档
feijie999 Dec 10, 2024
1efcb0f
feat(docs): 添加动态查询模块文档
feijie999 Dec 10, 2024
48ef1b6
feat(docs): 添加Elasticsearch模块文档
feijie999 Dec 10, 2024
bd8c7a4
feat(docs): 添加实体变更追踪模块文档
feijie999 Dec 10, 2024
21989dd
feat(docs): 添加ExceptionHandling模块文档
feijie999 Dec 10, 2024
cf9c7f2
feat(docs): 添加功能验证管理模块文档
feijie999 Dec 10, 2024
8a106fb
feat(docs): 添加Hangfire模块文档
feijie999 Dec 10, 2024
ded650a
feat(docs): 添加位置模块文档
feijie999 Dec 10, 2024
6c59e08
feat(docs): 添加日志模块文档
feijie999 Dec 10, 2024
966f471
feat(docs): 添加菜单导航模块文档
feijie999 Dec 10, 2024
78fc327
feat(docs): 添加Nexus存储模块文档
feijie999 Dec 10, 2024
23bd362
feat(docs): 添加实时通知模块文档
feijie999 Dec 10, 2024
d30c7e5
feat(docs): 添加OpenApi模块文档
feijie999 Dec 10, 2024
7b39a0c
feat(docs): 添加PushPlus模块文档
feijie999 Dec 10, 2024
2a112c1
feat(docs): 添加规则引擎模块文档
feijie999 Dec 10, 2024
52e61a1
feat(docs): 添加Security模块文档
feijie999 Dec 10, 2024
c95495e
feat(docs): 添加设置模块文档
feijie999 Dec 10, 2024
fbd19e2
feat(docs): 添加租户版本控制模块文档
feijie999 Dec 10, 2024
8164085
feat(docs): 添加微信模块文档
feijie999 Dec 10, 2024
710ecaa
feat(docs): 添加微信通知模块文档
feijie999 Dec 10, 2024
9d763a2
feat(docs): 添加包装器模块文档
feijie999 Dec 11, 2024
6d1a197
feat(docs): 添加微信发送模块文档
feijie999 Dec 11, 2024
6fd4215
feat(docs): 添加数据迁移模块文档
feijie999 Dec 11, 2024
bdbb1df
feat(docs): 添加Account模块文档
feijie999 Dec 11, 2024
31c1fcd
feat(docs): 添加auditing模块文档
feijie999 Dec 11, 2024
5440f0a
feat(docs): 添加Caching模块文档
feijie999 Dec 11, 2024
b5f16b4
feat(docs): 添加Elsa模块文档
feijie999 Dec 11, 2024
f3a1b2d
feat(docs): 添加功能管理模块文档
feijie999 Dec 11, 2024
c0242db
feat(docs): 添加identity模块文档
feijie999 Dec 11, 2024
b1c6958
feat(docs): 添加IdentityServer模块文档
feijie999 Dec 11, 2024
58cd62b
feat(docs): 添加本地文档管理模块文档
feijie999 Dec 11, 2024
2108dfa
feat(docs): 添加OpenIddict模块文档
feijie999 Dec 11, 2024
5065786
feat(docs): 添加Oss管理模块文档
feijie999 Dec 11, 2024
13ee01b
feat(docs): 添加权限管理模块文档
feijie999 Dec 11, 2024
d77f6f6
feat(docs): 添加Platform模块文档
feijie999 Dec 11, 2024
8bb4806
feat(docs): 添加实时消息模块文档
feijie999 Dec 11, 2024
f60b0b8
feat(docs): 添加实时通知模块文档
feijie999 Dec 11, 2024
03c81a3
feat(docs): 添加规则引擎管理模块文档
feijie999 Dec 11, 2024
184968d
docs: 更新规则引擎管理模块的README文档,添加功能特性和配置项
feijie999 Dec 11, 2024
498a18a
feat(docs): 添加Saas模块文档
feijie999 Dec 11, 2024
99c5f25
feat(docs): 添加文本模板模块文档
feijie999 Dec 11, 2024
dc2d2b4
feat(docs): 添加设置管理模块文档
feijie999 Dec 11, 2024
4691325
feat(docs): 添加webhooks模块文档
feijie999 Dec 11, 2024
15a1bc9
docs: 添加审计模块的 README 文档
feijie999 Dec 11, 2024
2ec0858
feat(docs): 添加认证模块的 README 文档
feijie999 Dec 11, 2024
9b35e8c
chore(abp): upgradeabp framework to 8.3.0.
colinin Oct 9, 2024
ff5c038
🔧 refactor(数据库迁移模块): 移除对MySQL和PostgreSQL的条件编译指令,简化代码结构
feijie999 Dec 12, 2024
89ac004
✨ fix(EfCoreMessageRepository): 优化消息查询逻辑,解决在pgsql下报错的问题,合并用户消息和群组消息查询…
feijie999 Dec 12, 2024
ef1368e
🔧 refactor(数据库迁移模块): 移除对MySQL和PostgreSQL的条件编译指令,简化代码结构
feijie999 Dec 12, 2024
59114c4
Merge branch 'refs/heads/main' into docs/main
feijie999 Dec 12, 2024
ec41df3
🗑️ delete(appsettings.PostgreSql.json): 删除 PostgreSQL 配置文件以优化项目配置管理
feijie999 Dec 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
<PackageVersion Include="Volo.Abp.EntityFrameworkCore" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.EntityFrameworkCore.MySql" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.EntityFrameworkCore.SqlServer" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.EntityFrameworkCore.PostgreSql" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.Features" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.FeatureManagement.Application" Version="$(VoloAbpPackageVersion)" />
<PackageVersion Include="Volo.Abp.FeatureManagement.Application.Contracts" Version="$(VoloAbpPackageVersion)" />
Expand Down Expand Up @@ -171,6 +172,10 @@
<PackageVersion Include="Elsa.WorkflowSettings.Persistence.EntityFramework.Core" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.Webhooks.Persistence.EntityFramework.MySql" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.WorkflowSettings.Persistence.EntityFramework.MySql" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.Webhooks.Persistence.EntityFramework.PostgreSql" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.WorkflowSettings.Persistence.EntityFramework.PostgreSql" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.Webhooks.Persistence.EntityFramework.SqlServer" Version="$(ElsaPackageVersion)" />
<PackageVersion Include="Elsa.WorkflowSettings.Persistence.EntityFramework.SqlServer" Version="$(ElsaPackageVersion)" />
</ItemGroup>
<!-- DotNetCore.CAP -->
<ItemGroup>
Expand Down
5,297 changes: 2,956 additions & 2,341 deletions aspnet-core/LINGYUN.MicroService.All.sln

Large diffs are not rendered by default.

2,225 changes: 1,237 additions & 988 deletions aspnet-core/LINGYUN.MicroService.Common.sln

Large diffs are not rendered by default.

4,295 changes: 2,412 additions & 1,883 deletions aspnet-core/LINGYUN.MicroService.SingleProject.sln

Large diffs are not rendered by default.

1,096 changes: 555 additions & 541 deletions aspnet-core/LINGYUN.MicroService.Workflow.sln

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# LINGYUN.Abp.AuditLogging.Elasticsearch

[简体中文](./README.md) | English

Elasticsearch implementation for the audit logging module.

## Features

* ElasticsearchAuditLogManager - Implements IAuditLogManager, managing audit logs with Elasticsearch
* ElasticsearchSecurityLogManager - Implements ISecurityLogManager, managing security logs with Elasticsearch

## Module Dependencies

```csharp
[DependsOn(typeof(AbpAuditLoggingElasticsearchModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## Configuration Options

* AbpAuditLoggingElasticsearchOptions.IndexPrefix - Index prefix, default is 'auditlogging'
* AbpAuditLoggingElasticsearchOptions.IndexSettings - Elasticsearch index settings

## Multi-tenancy Support

When integrated with the tenant module, the index will switch based on the tenant:
- For tenant-specific data: `{prefix}-{index}-{tenantId}`
- For host data: `{prefix}-{index}`

## appsettings.json

```json
{
"AuditLogging": {
"Elasticsearch": {
"IndexPrefix": "auditlogging"
}
}
}
```

## Features

1. Audit Log Management
- Store and retrieve audit logs in Elasticsearch
- Support for entity change tracking
- Flexible querying with various filters
- Support for extra properties

2. Security Log Management
- Store and retrieve security logs in Elasticsearch
- Support for security-related events tracking
- Comprehensive querying capabilities

3. Index Management
- Automatic index initialization
- Support for custom index settings
- Multi-tenant index isolation
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# LINGYUN.Abp.AuditLogging.Elasticsearch

简体中文 | [English](./README.EN.md)

审计模块 Elasticsearch 实现

ElasticsearchAuditLogManager 实现了 IAuditLogManager, 审计日志由ES管理
Expand Down Expand Up @@ -33,6 +35,4 @@ public class YouProjectModule : AbpModule
"IndexPrefix": "auditlogging"
}
}
}

```
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# LINGYUN.Abp.AuditLogging.EntityFrameworkCore

[简体中文](./README.md) | English

EntityFrameworkCore implementation for the audit logging module. This module serves as a bridge, with the actual implementation delegated to the official ABP modules.

## Features

* AuditLogManager - Implements IAuditLogManager, audit logs are managed by the Volo.Abp.AuditLogging module
* SecurityLogManager - Implements ISecurityLogManager, security logs are managed by the Volo.Abp.Identity module

## Module Dependencies

```csharp
[DependsOn(typeof(AbpAuditLoggingEntityFrameworkCoreModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## Configuration

Please follow the configuration guidelines in the Volo.Abp.AuditLogging and Volo.Abp.Identity modules.

## Database Configuration

Configure the connection strings in your appsettings.json:

```json
{
"ConnectionStrings": {
"AbpIdentity": "Server=127.0.0.1;Database=Identity;User Id=root;Password=*",
"AbpAuditLogging": "Server=127.0.0.1;Database=AuditLogging;User Id=root;Password=*",
}
}
```

## Features

1. Audit Log Management
- Store and retrieve audit logs using EntityFrameworkCore
- Support for entity change tracking
- Integration with ABP's identity system for security logs

2. Auto Mapping
- Automatic mapping configuration for audit log entities
- Supports custom mapping profiles through AbpAutoMapperOptions
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# LINGYUN.Abp.AuditLogging

Audit logging core module, providing basic functionality and interface definitions for audit logging.

[简体中文](./README.md)

## Features

* Audit logging infrastructure
* Audit log repository interface definitions
* Audit log manager interface definitions
* Support for ignoring specific types in audit logging

## Module Dependencies

```csharp
[DependsOn(typeof(AbpAuditLoggingModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## Configuration

```json
{
"Auditing": {
"IsEnabled": true, // Enable or disable audit logging
"HideErrors": true, // Hide error information in audit logs
"IsEnabledForAnonymousUsers": true, // Enable audit logging for anonymous users
"IsEnabledForGetRequests": false, // Enable audit logging for GET requests
"ApplicationName": null // Application name
}
}
```

## Basic Usage

1. Reference the module
2. Configure audit logging options
3. Implement an audit log storage provider (e.g., EntityFrameworkCore or Elasticsearch)

## Advanced Features

### Ignoring Specific Types

By default, the module ignores audit logs for the following types:
* CancellationToken
* CancellationTokenSource

You can add more types to ignore through configuration:

```csharp
Configure<AbpAuditingOptions>(options =>
{
options.IgnoredTypes.AddIfNotContains(typeof(YourType));
});
```
59 changes: 59 additions & 0 deletions aspnet-core/framework/auditing/LINGYUN.Abp.AuditLogging/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# LINGYUN.Abp.AuditLogging

审计日志核心模块,提供审计日志的基础功能和接口定义。

[English](./README.EN.md)

## 功能特性

* 审计日志基础设施
* 审计日志仓储接口定义
* 审计日志管理器接口定义
* 支持忽略特定类型的审计日志记录

## 模块引用

```csharp
[DependsOn(typeof(AbpAuditLoggingModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## 配置项

```json
{
"Auditing": {
"IsEnabled": true, // 是否启用审计日志
"HideErrors": true, // 是否隐藏错误信息
"IsEnabledForAnonymousUsers": true, // 是否为匿名用户启用审计日志
"IsEnabledForGetRequests": false, // 是否为GET请求启用审计日志
"ApplicationName": null // 应用程序名称
}
}
```

## 基本用法

1. 引用模块
2. 配置审计日志选项
3. 实现审计日志存储提供者(例如:EntityFrameworkCore或Elasticsearch)

## 高级功能

### 忽略特定类型

默认情况下,模块会忽略以下类型的审计日志:
* CancellationToken
* CancellationTokenSource

你可以通过配置添加更多需要忽略的类型:

```csharp
Configure<AbpAuditingOptions>(options =>
{
options.IgnoredTypes.AddIfNotContains(typeof(YourType));
});
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# LINGYUN.Abp.Authentication.QQ

QQ Connect authentication module, integrating QQ login functionality into ABP applications.

## Features

* QQ OAuth2.0 authentication
* Support for both mobile and PC login
* Retrieve basic QQ user information (nickname, gender, avatar, etc.)
* Integration with ABP identity system

## Module Dependencies

```csharp
[DependsOn(typeof(AbpAuthenticationQQModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## Configuration

```json
{
"Authentication": {
"QQ": {
"AppId": "Your QQ Connect AppId",
"AppKey": "Your QQ Connect AppKey",
"IsMobile": false, // Enable mobile login page
"ClaimsIssuer": "connect.qq.com", // Optional, defaults to connect.qq.com
"CallbackPath": "/signin-qq", // Optional, defaults to /signin-qq
"Scope": ["get_user_info"] // Optional, defaults to get_user_info
}
}
}
```

## Basic Usage

1. Configure QQ Connect Parameters
* Apply for an application on QQ Connect platform to get AppId and AppKey
* Configure AppId and AppKey in appsettings.json

2. Add QQ Login
```csharp
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddAuthentication()
.AddQQConnect(); // Add QQ login support
}
```

## Retrieved User Information

* OpenId - Unique QQ user identifier
* NickName - User's nickname
* Gender - User's gender
* AvatarUrl - User's avatar URL

## More Information

* [QQ Connect Documentation](https://wiki.connect.qq.com/)
* [ABP Authentication Documentation](https://docs.abp.io/en/abp/latest/Authentication)
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# LINGYUN.Abp.Authentication.QQ

QQ互联认证模块,集成QQ登录功能到ABP应用程序。

## 功能特性

* QQ OAuth2.0认证
* 支持移动端和PC端登录
* 获取QQ用户基本信息(昵称、性别、头像等)
* 支持与ABP身份系统集成

## 模块引用

```csharp
[DependsOn(typeof(AbpAuthenticationQQModule))]
public class YouProjectModule : AbpModule
{
// other
}
```

## 配置项

```json
{
"Authentication": {
"QQ": {
"AppId": "你的QQ互联AppId",
"AppKey": "你的QQ互联AppKey",
"IsMobile": false, // 是否启用移动端登录页面
"ClaimsIssuer": "connect.qq.com", // 可选,默认为 connect.qq.com
"CallbackPath": "/signin-qq", // 可选,默认为 /signin-qq
"Scope": ["get_user_info"] // 可选,默认为 get_user_info
}
}
}
```

## 基本用法

1. 配置QQ互联参数
* 在QQ互联平台申请应用,获取AppId和AppKey
* 在appsettings.json中配置AppId和AppKey

2. 添加QQ登录
```csharp
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddAuthentication()
.AddQQConnect(); // 添加QQ登录支持
}
```

## 获取的用户信息

* OpenId - QQ用户唯一标识
* NickName - 用户昵称
* Gender - 用户性别
* AvatarUrl - 用户头像URL

## 更多信息

* [QQ互联文档](https://wiki.connect.qq.com/)
* [ABP认证文档](https://docs.abp.io/en/abp/latest/Authentication)
Loading