Skip to content

Commit

Permalink
Merge pull request #1049 from feijie999/docs/main
Browse files Browse the repository at this point in the history
This PR adds both Chinese and English versions of the README.md file to improve the project's accessibility and global reach.
  • Loading branch information
colinin authored Dec 19, 2024
2 parents 3af8dda + ec41df3 commit 6be1d47
Show file tree
Hide file tree
Showing 732 changed files with 79,914 additions and 16,158 deletions.
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.

3,798 changes: 1,915 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));
});
```
113 changes: 113 additions & 0 deletions aspnet-core/framework/auditing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# LINGYUN.Abp 审计模块

## 模块概述

审计模块提供了全面的日志记录和审计功能,支持多种存储方式和高度可配置的审计选项。

## 功能特性

### 核心功能

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

### 存储支持

- EntityFrameworkCore 实现
- Elasticsearch 实现

## 模块引用

### 核心模块

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

### EntityFrameworkCore 模块

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

### Elasticsearch 模块

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

## 配置选项

### 审计日志配置

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

### Elasticsearch 配置

```json
{
"AuditLogging": {
"Elasticsearch": {
"IndexPrefix": "auditlogging" // 索引前缀
}
}
}
```

## 数据库连接配置

```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=*"
}
}
```

## 高级功能

### 忽略特定类型

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

- CancellationToken
- CancellationTokenSource

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

```csharp
Configure<AbpAuditingOptions>(options =>
{
options.IgnoredTypes.AddIfNotContains(typeof(YourType));
});
```

## 特殊说明

- Elasticsearch 实现支持跨租户,将根据租户自动切换索引
- EntityFrameworkCore 实现主要作为桥梁,具体实现交由 Abp 官方模块管理
Loading

0 comments on commit 6be1d47

Please sign in to comment.