diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.BlobStoring.OssManagement/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.BlobStoring.OssManagement/README.EN.md new file mode 100644 index 000000000..4039e2014 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.BlobStoring.OssManagement/README.EN.md @@ -0,0 +1,96 @@ +# LINGYUN.Abp.BlobStoring.OssManagement + +OSS Management implementation of ABP framework's object storage provider **IBlobProvider** + +## Configuration + +Module reference as needed, depends on the OssManagement module, so you need to configure the remote Oss management module's client proxy. + +First, define the **appsettings.json** file: + +```json +{ + "OssManagement": { + "Bucket": "your-bucket-name" + }, + "RemoteServices": { + "AbpOssManagement": { + "BaseUrl": "http://127.0.0.1:30025", + "IdentityClient": "InternalServiceClient", + "UseCurrentAccessToken": false + } + }, + "IdentityClients": { + "InternalServiceClient": { + "Authority": "http://127.0.0.1:44385", + "RequireHttps": false, + "GrantType": "client_credentials", + "Scope": "lingyun-abp-application", + "ClientId": "InternalServiceClient", + "ClientSecret": "1q2w3E*" + } + } +} +``` + +```csharp +[DependsOn(typeof(AbpBlobStoringOssManagementModule))] +public class YouProjectModule : AbpModule +{ + public override void ConfigureServices(ServiceConfigurationContext context) + { + var configuration = context.Services.GetConfiguration(); + var preActions = context.Services.GetPreConfigureActions(); + Configure(options => + { + preActions.Configure(options); + // YouContainer use oss management + options.Containers.Configure((containerConfiguration) => + { + containerConfiguration.UseOssManagement(config => + { + config.Bucket = configuration[OssManagementBlobProviderConfigurationNames.Bucket]; + }); + }); + + // all container use oss management + options.Containers.ConfigureAll((containerName, containerConfiguration) => + { + // use oss management + containerConfiguration.UseOssManagement(config => + { + config.Bucket = configuration[OssManagementBlobProviderConfigurationNames.Bucket]; + }); + }); + }); + } +} +``` + +## Features + +* Implements ABP framework's IBlobProvider interface +* Provides Blob storage implementation based on OssManagement +* Supports container-level configuration +* Supports global configuration +* Supports remote service calls + +## Configuration Items + +* Bucket: Storage bucket name +* RemoteServices.AbpOssManagement: + * BaseUrl: OSS management service base URL + * IdentityClient: Identity client name + * UseCurrentAccessToken: Whether to use current access token +* IdentityClients: Identity client configuration + * Authority: Authentication server address + * RequireHttps: Whether HTTPS is required + * GrantType: Authorization type + * Scope: Authorization scope + * ClientId: Client ID + * ClientSecret: Client secret + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.EN.md new file mode 100644 index 000000000..a7282f5e9 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.EN.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.OssManagement.Aliyun + +Aliyun OSS container interface implementation + +## Features + +* Implements object storage management based on Aliyun OSS +* Supports basic operations including file upload, download, and deletion +* Supports file sharding upload and breakpoint continuation +* Integrates with Aliyun OSS access control and security mechanisms + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementAliyunModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration Details + +Please refer to Aliyun OSS configuration documentation: [Aliyun OSS Configuration](https://help.aliyun.com/document_detail/32009.html) + +Required configuration items: +* AccessKeyId: Aliyun access key ID +* AccessKeySecret: Aliyun access key secret +* Endpoint: Aliyun OSS access domain +* SecurityToken: Optional security token + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.md index 56a51290a..824a5d9de 100644 --- a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.md +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Aliyun/README.md @@ -2,6 +2,13 @@ 阿里云oss容器接口 +## 功能 + +* 实现基于阿里云OSS的对象存储管理 +* 支持文件上传、下载、删除等基本操作 +* 支持文件分片上传和断点续传 +* 集成阿里云OSS的访问控制和安全机制 + ## 配置使用 模块按需引用 @@ -13,3 +20,18 @@ public class YouProjectModule : AbpModule // other } ``` + +## 配置说明 + +请参考阿里云OSS的配置说明：[阿里云OSS配置](https://help.aliyun.com/document_detail/32009.html) + +需要配置以下关键信息： +* AccessKeyId：阿里云访问密钥ID +* AccessKeySecret：阿里云访问密钥密码 +* Endpoint：阿里云OSS访问域名 +* SecurityToken：可选的安全令牌 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.EN.md new file mode 100644 index 000000000..cae498e21 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.EN.md @@ -0,0 +1,49 @@ +# LINGYUN.Abp.OssManagement.Application.Contracts + +Object Storage Management Application Service Interface Definitions + +## Features + +* Defines application service interfaces for object storage management +* Defines DTO objects for object storage management +* Defines permission management +* Supports management of public files, private files, and shared files + +## Interface Definitions + +### Container Management +* IOssContainerAppService: Container management service interface + * CreateAsync: Create container + * GetAsync: Get container information + * GetListAsync: Get container list + * GetObjectListAsync: Get object list in container + * DeleteAsync: Delete container + +### Object Management +* IOssObjectAppService: Object management service interface + * CreateAsync: Create object + * GetAsync: Get object information + * DeleteAsync: Delete object + * DownloadAsync: Download object + +### File Management +* IFileAppService: Base file service interface +* IPublicFileAppService: Public file service interface +* IPrivateFileAppService: Private file service interface +* IShareFileAppService: Shared file service interface +* IStaticFilesAppService: Static file service interface + +## Permission Definitions + +* AbpOssManagement.Container: Container management permissions + * Create: Create container + * Delete: Delete container +* AbpOssManagement.OssObject: Object management permissions + * Create: Create object + * Delete: Delete object + * Download: Download object + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.md new file mode 100644 index 000000000..a29aa385f --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application.Contracts/README.md @@ -0,0 +1,49 @@ +# LINGYUN.Abp.OssManagement.Application.Contracts + +对象存储管理应用服务接口定义 + +## 功能 + +* 定义对象存储管理的应用服务接口 +* 定义对象存储管理的DTO对象 +* 定义权限管理 +* 支持公共文件、私有文件和共享文件的管理 + +## 接口定义 + +### 容器管理 +* IOssContainerAppService：容器管理服务接口 + * CreateAsync：创建容器 + * GetAsync：获取容器信息 + * GetListAsync：获取容器列表 + * GetObjectListAsync：获取容器中的对象列表 + * DeleteAsync：删除容器 + +### 对象管理 +* IOssObjectAppService：对象管理服务接口 + * CreateAsync：创建对象 + * GetAsync：获取对象信息 + * DeleteAsync：删除对象 + * DownloadAsync：下载对象 + +### 文件管理 +* IFileAppService：基础文件服务接口 +* IPublicFileAppService：公共文件服务接口 +* IPrivateFileAppService：私有文件服务接口 +* IShareFileAppService：共享文件服务接口 +* IStaticFilesAppService：静态文件服务接口 + +## 权限定义 + +* AbpOssManagement.Container：容器管理权限 + * Create：创建容器 + * Delete：删除容器 +* AbpOssManagement.OssObject：对象管理权限 + * Create：创建对象 + * Delete：删除对象 + * Download：下载对象 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.EN.md new file mode 100644 index 000000000..6c9031688 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.EN.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.OssManagement.Application + +Object Storage Management Application Service Implementation + +## Features + +* Implements application service interfaces for object storage management +* Provides concrete implementations for container management, object management, and file management +* Supports file upload, download, and sharing functionality +* Implements permission validation and access control + +## Service Implementations + +### Base Services +* FileAppServiceBase: File service base class, implements IFileAppService interface +* OssManagementApplicationServiceBase: OSS management application service base class + +### Container Management +* OssContainerAppService: Implements IOssContainerAppService interface + * Provides container creation, query, and deletion functionality + * Supports paginated container list queries + * Supports object list queries within containers + +### Object Management +* OssObjectAppService: Implements IOssObjectAppService interface + * Provides object upload, download, and deletion functionality + * Supports object metadata management + * Supports object access control + +### File Management +* PublicFileAppService: Implements IPublicFileAppService interface, handles public files +* PrivateFileAppService: Implements IPrivateFileAppService interface, handles private files +* ShareFileAppService: Implements IShareFileAppService interface, handles shared files +* StaticFilesAppService: Implements IStaticFilesAppService interface, handles static files + +## Features + +* Supports file sharding upload +* Supports breakpoint continuation +* Supports file access control +* Supports file metadata management +* Supports file sharing and expiration management + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.md new file mode 100644 index 000000000..1c4fcf898 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Application/README.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.OssManagement.Application + +对象存储管理应用服务实现 + +## 功能 + +* 实现对象存储管理的应用服务接口 +* 提供容器管理、对象管理和文件管理的具体实现 +* 支持文件上传、下载和共享功能 +* 实现权限验证和访问控制 + +## 服务实现 + +### 基础服务 +* FileAppServiceBase：文件服务基类，实现IFileAppService接口 +* OssManagementApplicationServiceBase：OSS管理应用服务基类 + +### 容器管理 +* OssContainerAppService：实现IOssContainerAppService接口 + * 提供容器的创建、查询和删除功能 + * 支持容器列表分页查询 + * 支持容器内对象列表查询 + +### 对象管理 +* OssObjectAppService：实现IOssObjectAppService接口 + * 提供对象的上传、下载和删除功能 + * 支持对象元数据管理 + * 支持对象访问权限控制 + +### 文件管理 +* PublicFileAppService：实现IPublicFileAppService接口，处理公共文件 +* PrivateFileAppService：实现IPrivateFileAppService接口，处理私有文件 +* ShareFileAppService：实现IShareFileAppService接口，处理共享文件 +* StaticFilesAppService：实现IStaticFilesAppService接口，处理静态文件 + +## 特性 + +* 支持文件分片上传 +* 支持断点续传 +* 支持文件访问权限控制 +* 支持文件元数据管理 +* 支持文件共享和过期管理 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.EN.md new file mode 100644 index 000000000..8db682650 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.EN.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.OssManagement.Domain.Shared + +Object Storage Management Module Shared Domain Layer + +## Features + +* Defines basic types and constants for object storage management +* Defines error codes +* Defines features +* Defines settings +* Provides localization resources + +## Error Codes + +* ContainerDeleteWithStatic: Attempt to delete static container +* ContainerDeleteWithNotEmpty: Attempt to delete non-empty container +* ContainerAlreadyExists: Container already exists +* ContainerNotFound: Container not found +* ObjectDeleteWithNotEmpty: Attempt to delete non-empty object +* ObjectAlreadyExists: Object already exists +* ObjectNotFound: Object not found +* OssNameHasTooLong: OSS name too long + +## Features + +* PublicAccess: Public access +* OssObject.Enable: Enable object storage +* OssObject.AllowSharedFile: Allow file sharing +* OssObject.DownloadFile: Allow file download +* OssObject.DownloadLimit: Download limit +* OssObject.DownloadInterval: Download interval +* OssObject.UploadFile: Allow file upload +* OssObject.UploadLimit: Upload limit +* OssObject.UploadInterval: Upload interval +* OssObject.MaxUploadFileCount: Maximum upload file count + +## Settings + +* DownloadPackageSize: Download package size +* FileLimitLength: File size limit, default: 100 +* AllowFileExtensions: Allowed file extensions, default: dll,zip,rar,txt,log,xml,config,json,jpeg,jpg,png,bmp,ico,xlsx,xltx,xls,xlt,docs,dots,doc,dot,pptx,potx,ppt,pot,chm + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.md new file mode 100644 index 000000000..1eea189c9 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain.Shared/README.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.OssManagement.Domain.Shared + +对象存储管理模块共享领域层 + +## 功能 + +* 定义对象存储管理的基础类型和常量 +* 定义错误代码 +* 定义功能特性 +* 定义设置项 +* 提供本地化资源 + +## 错误代码 + +* ContainerDeleteWithStatic：尝试删除静态容器 +* ContainerDeleteWithNotEmpty：尝试删除非空容器 +* ContainerAlreadyExists：容器已存在 +* ContainerNotFound：容器不存在 +* ObjectDeleteWithNotEmpty：尝试删除非空对象 +* ObjectAlreadyExists：对象已存在 +* ObjectNotFound：对象不存在 +* OssNameHasTooLong：OSS名称过长 + +## 功能特性 + +* PublicAccess：公共访问 +* OssObject.Enable：启用对象存储 +* OssObject.AllowSharedFile：允许文件共享 +* OssObject.DownloadFile：允许文件下载 +* OssObject.DownloadLimit：下载限制 +* OssObject.DownloadInterval：下载间隔 +* OssObject.UploadFile：允许文件上传 +* OssObject.UploadLimit：上传限制 +* OssObject.UploadInterval：上传间隔 +* OssObject.MaxUploadFileCount：最大上传文件数 + +## 设置项 + +* DownloadPackageSize：下载包大小 +* FileLimitLength：文件大小限制，默认：100 +* AllowFileExtensions：允许的文件扩展名，默认：dll,zip,rar,txt,log,xml,config,json,jpeg,jpg,png,bmp,ico,xlsx,xltx,xls,xlt,docs,dots,doc,dot,pptx,potx,ppt,pot,chm + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.EN.md new file mode 100644 index 000000000..1b936eb98 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.EN.md @@ -0,0 +1,28 @@ +# LINGYUN.Abp.OssManagement.Domain + +Object Storage Management Module Domain Layer. + +## Features + +* Provides core domain models and business logic for object storage management +* Defines basic operation interfaces for object storage containers and objects +* Provides core logic for file processing and validation +* Supports file sharding upload and breakpoint continuation +* Supports extension of multiple storage providers + +## Configuration + +### AbpOssManagementOptions + +* StaticBuckets: List of static containers that cannot be deleted +* IsCleanupEnabled: Whether to enable cleanup functionality, default: true +* CleanupPeriod: Cleanup period, default: 3,600,000 ms +* DisableTempPruning: Whether to disable cache directory cleanup job, default: false +* MaximumTempSize: Number of items to clean per batch, default: 100 +* MinimumTempLifeSpan: Minimum cache object lifespan, default: 30 minutes +* Processers: List of file stream processors + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.md new file mode 100644 index 000000000..6a102fc4c --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Domain/README.md @@ -0,0 +1,28 @@ +# LINGYUN.Abp.OssManagement.Domain + +对象存储管理模块领域层。 + +## 功能 + +* 提供对象存储管理的核心领域模型和业务逻辑 +* 定义对象存储容器和对象的基本操作接口 +* 提供文件处理和验证的核心逻辑 +* 支持文件分片上传和断点续传 +* 支持多种存储提供程序的扩展 + +## 配置项 + +### AbpOssManagementOptions + +* StaticBuckets: 静态容器列表，这些容器不允许被删除 +* IsCleanupEnabled: 是否启用清理功能，默认：true +* CleanupPeriod: 清理周期，默认：3,600,000 ms +* DisableTempPruning: 是否禁用缓存目录清除作业，默认：false +* MaximumTempSize: 每批次清理数量，默认：100 +* MinimumTempLifeSpan: 最小缓存对象寿命，默认：30分钟 +* Processers: 文件流处理器列表 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.EN.md new file mode 100644 index 000000000..7947eeaa2 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.EN.md @@ -0,0 +1,53 @@ +# LINGYUN.Abp.OssManagement.FileSystem.ImageSharp + +ImageSharp image processing implementation for local file system + +## Features + +* Implements image processing for local file system based on ImageSharp +* Supports image format conversion +* Supports image resizing and cropping +* Supports watermark addition +* Supports image quality adjustment +* Supports image metadata processing + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImageSharpModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Image Processing Features + +Supports the following image processing operations: +* resize: Adjust image size +* crop: Crop image +* rotate: Rotate image +* watermark: Add watermark +* format: Convert image format +* quality: Adjust image quality + +## Usage Example + +Image processing parameters are passed through URL query string: + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## Notes + +* Requires installation of ImageSharp related NuGet packages +* Recommended to configure appropriate image processing limits to prevent resource abuse +* Recommended to enable image caching for better performance + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.md new file mode 100644 index 000000000..775161b68 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.ImageSharp/README.md @@ -0,0 +1,53 @@ +# LINGYUN.Abp.OssManagement.FileSystem.ImageSharp + +本地文件系统的ImageSharp图像处理实现 + +## 功能 + +* 基于ImageSharp实现本地文件系统的图像处理 +* 支持图像格式转换 +* 支持图像缩放和裁剪 +* 支持图像水印添加 +* 支持图像质量调整 +* 支持图像元数据处理 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImageSharpModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 图像处理功能 + +支持以下图像处理操作： +* resize：调整图像大小 +* crop：裁剪图像 +* rotate：旋转图像 +* watermark：添加水印 +* format：转换图像格式 +* quality：调整图像质量 + +## 使用示例 + +图像处理参数通过URL查询字符串传递： + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## 注意事项 + +* 需要安装ImageSharp相关的NuGet包 +* 建议配置适当的图像处理限制以避免资源滥用 +* 建议启用图像缓存以提高性能 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.EN.md new file mode 100644 index 000000000..bd5277a37 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.EN.md @@ -0,0 +1,52 @@ +# LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp + +ImageSharp image processing implementation module for local file system + +## Features + +* Implements image processing functionality for local file system based on ImageSharp +* Implements IImageProcessor interface +* Provides high-performance image processing capabilities +* Supports multiple image formats +* Provides rich image processing options + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImagingImageSharpModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Image Processing Features + +Supports the following image processing operations: +* Scaling: Supports multiple scaling modes and algorithms +* Cropping: Supports rectangular and circular cropping +* Rotation: Supports rotation at any angle +* Watermark: Supports text and image watermarks +* Format Conversion: Supports conversion between multiple image formats +* Quality Adjustment: Supports compression quality control + +## Performance Optimization + +* Uses ImageSharp's high-performance algorithms +* Supports image processing cache +* Supports asynchronous processing +* Supports memory optimization + +## Notes + +* Requires installation of ImageSharp related NuGet packages +* Recommended to configure appropriate image processing limits +* Recommended to enable image caching +* Pay attention to memory usage management + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.md new file mode 100644 index 000000000..74dd84cc6 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp/README.md @@ -0,0 +1,52 @@ +# LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp + +本地文件系统的ImageSharp图像处理实现模块 + +## 功能 + +* 基于ImageSharp实现本地文件系统的图像处理功能 +* 实现IImageProcessor接口 +* 提供高性能的图像处理能力 +* 支持多种图像格式 +* 提供丰富的图像处理选项 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImagingImageSharpModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 图像处理功能 + +支持以下图像处理操作： +* 缩放：支持多种缩放模式和算法 +* 裁剪：支持矩形裁剪和圆形裁剪 +* 旋转：支持任意角度旋转 +* 水印：支持文字水印和图片水印 +* 格式转换：支持多种图片格式之间的转换 +* 质量调整：支持压缩质量控制 + +## 性能优化 + +* 使用ImageSharp的高性能算法 +* 支持图像处理缓存 +* 支持异步处理 +* 支持内存优化 + +## 注意事项 + +* 需要安装ImageSharp相关的NuGet包 +* 建议配置适当的图像处理限制 +* 建议启用图像缓存 +* 注意内存使用管理 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.EN.md new file mode 100644 index 000000000..713236329 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.EN.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.OssManagement.FileSystem.Imaging + +Base image processing module for local file system + +## Features + +* Provides basic image processing functionality for local file system +* Defines image processing interfaces and abstract classes +* Supports image processing extensions +* Provides image processing pipeline +* Supports image processing cache + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImagingModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Core Interfaces + +* IImageProcessor: Image processor interface +* IImageProcessorFactory: Image processor factory interface +* IImageProcessorCache: Image processor cache interface +* IImageProcessorPipeline: Image processing pipeline interface + +## Extension Features + +* Supports custom image processors +* Supports custom image processing pipelines +* Supports custom image caching strategies +* Supports image processing parameter validation + +## Related Modules + +* LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp: ImageSharp-based implementation + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.md new file mode 100644 index 000000000..28e3a82b8 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem.Imaging/README.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.OssManagement.FileSystem.Imaging + +本地文件系统的图像处理基础模块 + +## 功能 + +* 提供本地文件系统的图像处理基础功能 +* 定义图像处理接口和抽象类 +* 支持图像处理扩展 +* 提供图像处理管道 +* 支持图像处理缓存 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImagingModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 核心接口 + +* IImageProcessor：图像处理器接口 +* IImageProcessorFactory：图像处理器工厂接口 +* IImageProcessorCache：图像处理缓存接口 +* IImageProcessorPipeline：图像处理管道接口 + +## 扩展功能 + +* 支持自定义图像处理器 +* 支持自定义图像处理管道 +* 支持自定义图像缓存策略 +* 支持图像处理参数验证 + +## 相关模块 + +* LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp：基于ImageSharp的具体实现 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.EN.md new file mode 100644 index 000000000..8554b7730 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.EN.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.OssManagement.FileSystem + +Local file system OSS container interface implementation + +## Features + +* Implements object storage management based on local file system +* Supports basic operations including file upload, download, and deletion +* Supports file sharding upload and breakpoint continuation +* Supports automatic creation and management of file directories +* Supports file system-based access control +* Supports storage and management of file metadata + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration Details + +Required configuration items: +* BasePath: Base path for file storage +* AppendContainerNameToBasePath: Whether to append container name to base path +* HttpServer: HTTP server configuration + * Scheme: Protocol scheme (http/https) + * Host: Host address + * Port: Port number + +## Related Modules + +* LINGYUN.Abp.OssManagement.FileSystem.ImageSharp: Provides image processing functionality +* LINGYUN.Abp.OssManagement.FileSystem.Imaging: Provides basic image functionality support +* LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp: ImageSharp-based image processing implementation + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.md index ae3c3c1bb..f578d8014 100644 --- a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.md +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.FileSystem/README.md @@ -2,6 +2,15 @@ 本地文件系统oss容器接口 +## 功能 + +* 实现基于本地文件系统的对象存储管理 +* 支持文件上传、下载、删除等基本操作 +* 支持文件分片上传和断点续传 +* 支持文件目录的自动创建和管理 +* 支持基于文件系统的访问控制 +* 支持文件元数据的存储和管理 + ## 配置使用 模块按需引用 @@ -13,3 +22,24 @@ public class YouProjectModule : AbpModule // other } ``` + +## 配置说明 + +需要配置以下关键信息： +* BasePath：文件存储的基础路径 +* AppendContainerNameToBasePath：是否将容器名称附加到基础路径 +* HttpServer：HTTP服务器配置 + * Scheme：协议方案（http/https） + * Host：主机地址 + * Port：端口号 + +## 相关模块 + +* LINGYUN.Abp.OssManagement.FileSystem.ImageSharp：提供图像处理功能 +* LINGYUN.Abp.OssManagement.FileSystem.Imaging：提供基础图像功能支持 +* LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp：基于ImageSharp的图像处理实现 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.EN.md new file mode 100644 index 000000000..77e14fa3e --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.EN.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.OssManagement.HttpApi.Client + +Object Storage Management HTTP API Client + +## Features + +* Provides HTTP API client proxy for object storage management +* Implements remote service calls +* Supports dynamic API client proxy generation + +## Usage + +1. Add module dependency: + +```csharp +[DependsOn(typeof(AbpOssManagementHttpApiClientModule))] +public class YourModule : AbpModule +{ + // ... +} +``` + +2. Configure remote services: + +```json +{ + "RemoteServices": { + "Default": { + "BaseUrl": "http://your-api-server/" + } + } +} +``` + +## Available Services + +* IOssContainerAppService: Container management service +* IOssObjectAppService: Object management service +* IPublicFileAppService: Public file service +* IPrivateFileAppService: Private file service +* IShareFileAppService: Shared file service +* IStaticFilesAppService: Static file service + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.md new file mode 100644 index 000000000..749d26a5c --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi.Client/README.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.OssManagement.HttpApi.Client + +对象存储管理HTTP API客户端 + +## 功能 + +* 提供对象存储管理的HTTP API客户端代理 +* 实现远程服务调用 +* 支持动态API客户端代理生成 + +## 使用方式 + +1. 添加模块依赖： + +```csharp +[DependsOn(typeof(AbpOssManagementHttpApiClientModule))] +public class YourModule : AbpModule +{ + // ... +} +``` + +2. 配置远程服务： + +```json +{ + "RemoteServices": { + "Default": { + "BaseUrl": "http://your-api-server/" + } + } +} +``` + +## 可用服务 + +* IOssContainerAppService：容器管理服务 +* IOssObjectAppService：对象管理服务 +* IPublicFileAppService：公共文件服务 +* IPrivateFileAppService：私有文件服务 +* IShareFileAppService：共享文件服务 +* IStaticFilesAppService：静态文件服务 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.EN.md new file mode 100644 index 000000000..6942626b1 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.EN.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.OssManagement.HttpApi + +Object Storage Management HTTP API Layer + +## Features + +* Provides HTTP API interfaces for object storage management +* Implements RESTful API design +* Supports HTTP interfaces for file upload, download, and sharing +* Provides permission validation and access control + +## API Controllers + +### Container Management +* OssContainerController + * POST /api/oss-management/containers: Create container + * GET /api/oss-management/containers/{name}: Get container information + * GET /api/oss-management/containers: Get container list + * DELETE /api/oss-management/containers/{name}: Delete container + +### Object Management +* OssObjectController + * POST /api/oss-management/objects: Upload object + * GET /api/oss-management/objects/{*path}: Get object + * DELETE /api/oss-management/objects/{*path}: Delete object + +### File Management +* PublicFilesController: Handles public file access +* PrivateFilesController: Handles private file access +* ShareFilesController: Handles shared file access +* StaticFilesController: Handles static file access + +## Features + +* Supports file sharding upload +* Supports breakpoint continuation +* Supports file streaming download +* Supports file access control +* Supports file metadata management + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.md new file mode 100644 index 000000000..ef58a6052 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.HttpApi/README.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.OssManagement.HttpApi + +对象存储管理HTTP API层 + +## 功能 + +* 提供对象存储管理的HTTP API接口 +* 实现RESTful风格的API设计 +* 支持文件上传、下载和共享的HTTP接口 +* 提供权限验证和访问控制 + +## API控制器 + +### 容器管理 +* OssContainerController + * POST /api/oss-management/containers：创建容器 + * GET /api/oss-management/containers/{name}：获取容器信息 + * GET /api/oss-management/containers：获取容器列表 + * DELETE /api/oss-management/containers/{name}：删除容器 + +### 对象管理 +* OssObjectController + * POST /api/oss-management/objects：上传对象 + * GET /api/oss-management/objects/{*path}：获取对象 + * DELETE /api/oss-management/objects/{*path}：删除对象 + +### 文件管理 +* PublicFilesController：处理公共文件访问 +* PrivateFilesController：处理私有文件访问 +* ShareFilesController：处理共享文件访问 +* StaticFilesController：处理静态文件访问 + +## 特性 + +* 支持文件分片上传 +* 支持断点续传 +* 支持文件流式下载 +* 支持文件访问权限控制 +* 支持文件元数据管理 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.EN.md new file mode 100644 index 000000000..980106b6c --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.EN.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.OssManagement.ImageSharp + +ImageSharp-based image processing interface for OSS objects + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementFileSystemImageSharpModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Features + +* Implements image processing functionality for OSS objects based on ImageSharp +* Supports image format conversion +* Supports image resizing and cropping +* Supports watermark addition +* Supports image quality adjustment +* Supports image metadata processing + +## Image Processing Features + +Supports the following image processing operations: +* resize: Adjust image size +* crop: Crop image +* rotate: Rotate image +* watermark: Add watermark +* format: Convert image format +* quality: Adjust image quality + +## Usage Example + +Image processing parameters are passed through URL query string: + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.md index 0ef3abd8b..66837efe7 100644 --- a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.md +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.ImageSharp/README.md @@ -13,3 +13,35 @@ public class YouProjectModule : AbpModule // other } ``` + +## 功能 + +* 基于ImageSharp实现OSS对象的图像处理功能 +* 支持图像格式转换 +* 支持图像缩放和裁剪 +* 支持图像水印添加 +* 支持图像质量调整 +* 支持图像元数据处理 + +## 图像处理功能 + +支持以下图像处理操作： +* resize：调整图像大小 +* crop：裁剪图像 +* rotate：旋转图像 +* watermark：添加水印 +* format：转换图像格式 +* quality：调整图像质量 + +## 使用示例 + +图像处理参数通过URL查询字符串传递： + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.EN.md new file mode 100644 index 000000000..4e59eceea --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.EN.md @@ -0,0 +1,51 @@ +# LINGYUN.Abp.OssManagement.Imaging + +Object Storage Management Image Processing Module + +## Features + +* Provides basic image processing functionality for object storage +* Supports image format conversion +* Supports image resizing and cropping +* Supports watermark addition +* Supports image quality adjustment +* Supports image metadata processing + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementImagingModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Image Processing Features + +Supports the following image processing operations: +* resize: Adjust image size +* crop: Crop image +* rotate: Rotate image +* watermark: Add watermark +* format: Convert image format +* quality: Adjust image quality + +## Usage Example + +Image processing parameters are passed through URL query string: + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## Related Modules + +* LINGYUN.Abp.OssManagement.ImageSharp: Provides ImageSharp-based implementation + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.md new file mode 100644 index 000000000..a8543a13e --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Imaging/README.md @@ -0,0 +1,51 @@ +# LINGYUN.Abp.OssManagement.Imaging + +对象存储管理图像处理模块 + +## 功能 + +* 提供对象存储的图像处理基础功能 +* 支持图像格式转换 +* 支持图像缩放和裁剪 +* 支持图像水印添加 +* 支持图像质量调整 +* 支持图像元数据处理 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementImagingModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 图像处理功能 + +支持以下图像处理操作： +* resize：调整图像大小 +* crop：裁剪图像 +* rotate：旋转图像 +* watermark：添加水印 +* format：转换图像格式 +* quality：调整图像质量 + +## 使用示例 + +图像处理参数通过URL查询字符串传递： + +``` +http://your-domain/api/oss-management/objects/my-image.jpg?process=image/resize,w_100,h_100/watermark,text_Hello +``` + +## 相关模块 + +* LINGYUN.Abp.OssManagement.ImageSharp：提供基于ImageSharp的具体实现 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.EN.md new file mode 100644 index 000000000..3fde7e614 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.EN.md @@ -0,0 +1,40 @@ +# LINGYUN.Abp.OssManagement.Minio + +MinIO implementation for OSS container management interface + +## Features + +* Implements object storage management based on MinIO +* Supports basic operations including file upload, download, and deletion +* Supports file sharding upload and breakpoint continuation +* Integrates with MinIO access control and security mechanisms +* Supports custom bucket policies + +## Configuration + +Module reference as needed + +Please refer to [BlobStoring Minio](https://abp.io/docs/latest/framework/infrastructure/blob-storing/minio) for related configuration items. + +```csharp +[DependsOn(typeof(AbpOssManagementMinioModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration Details + +Required configuration items: +* EndPoint: MinIO server address +* AccessKey: Access key +* SecretKey: Secret key +* BucketName: Bucket name +* WithSSL: Whether to enable SSL connection +* CreateBucketIfNotExists: Whether to create bucket if it doesn't exist + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.md index 8155334ca..68249fa60 100644 --- a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.md +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Minio/README.md @@ -2,6 +2,14 @@ Oss容器管理接口的Minio实现 +## 功能 + +* 实现基于MinIO的对象存储管理 +* 支持文件上传、下载、删除等基本操作 +* 支持文件分片上传和断点续传 +* 集成MinIO的访问控制和安全机制 +* 支持自定义存储桶策略 + ## 配置使用 模块按需引用 @@ -16,4 +24,17 @@ public class YouProjectModule : AbpModule } ``` +## 配置说明 + +需要配置以下关键信息： +* EndPoint：MinIO服务器地址 +* AccessKey：访问密钥 +* SecretKey：密钥密码 +* BucketName：存储桶名称 +* WithSSL：是否启用SSL连接 +* CreateBucketIfNotExists：不存在时是否创建存储桶 + +## 链接 +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.EN.md new file mode 100644 index 000000000..9f6614083 --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.EN.md @@ -0,0 +1,43 @@ +# LINGYUN.Abp.OssManagement.Nexus + +OSS Management implementation for Nexus Repository + +## Features + +* Implements object storage management based on Nexus Raw repository +* Supports basic operations including file upload, download, and deletion +* Supports file sharding upload and breakpoint continuation +* Integrates with Nexus access control and security mechanisms +* Supports object expiration management + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementNexusModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration Details + +Required configuration items: +* BaseUrl: Nexus server address +* Repository: Raw repository name +* Username: Access username +* Password: Access password +* Format: Repository format, default is raw + +## Notes + +* This module requires Nexus server to support Raw repository type +* Ensure the configured user has sufficient permissions to access the Raw repository +* HTTPS is recommended for secure transmission + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.md new file mode 100644 index 000000000..98de7eb1d --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Nexus/README.md @@ -0,0 +1,43 @@ +# LINGYUN.Abp.OssManagement.Nexus + +Nexus仓库的OSS管理模块实现 + +## 功能 + +* 实现基于Nexus Raw仓库的对象存储管理 +* 支持文件上传、下载和删除等基本操作 +* 支持文件分片上传和断点续传 +* 集成Nexus的访问控制和安全机制 +* 支持对象过期管理 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementNexusModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 配置说明 + +需要配置以下关键信息： +* BaseUrl：Nexus服务器地址 +* Repository：Raw仓库名称 +* Username：访问用户名 +* Password：访问密码 +* Format：仓库格式，默认为raw + +## 注意事项 + +* 此模块需要Nexus服务器支持Raw仓库类型 +* 需要确保配置的用户具有足够的权限访问Raw仓库 +* 建议使用HTTPS进行安全传输 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.EN.md new file mode 100644 index 000000000..4acfd433d --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.EN.md @@ -0,0 +1,49 @@ +# LINGYUN.Abp.OssManagement.SettingManagement + +Object Storage Management Settings Management Module + +## Features + +* Provides settings management functionality for object storage management +* Implements settings reading and modification +* Supports multi-tenant configuration +* Supports different levels of settings management + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementSettingManagementModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Settings + +### Basic Settings +* DownloadPackageSize: Download package size +* FileLimitLength: File size limit +* AllowFileExtensions: Allowed file extensions + +### API Endpoints + +* GET /api/oss-management/settings: Get settings +* PUT /api/oss-management/settings: Update settings + +### Permissions + +* AbpOssManagement.Setting: Settings management permission + +## Notes + +* Appropriate permissions are required to access settings +* Some settings may require application restart to take effect +* It's recommended to backup current configuration before modifying settings + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.md new file mode 100644 index 000000000..30e6dcb4d --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.SettingManagement/README.md @@ -0,0 +1,49 @@ +# LINGYUN.Abp.OssManagement.SettingManagement + +对象存储管理设置管理模块 + +## 功能 + +* 提供对象存储管理的设置管理功能 +* 实现设置的读取和修改 +* 支持多租户配置 +* 支持不同级别的设置管理 + +## 配置使用 + +模块按需引用： + +```csharp +[DependsOn(typeof(AbpOssManagementSettingManagementModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## 设置项 + +### 基础设置 +* DownloadPackageSize：下载包大小 +* FileLimitLength：文件大小限制 +* AllowFileExtensions：允许的文件扩展名 + +### API接口 + +* GET /api/oss-management/settings：获取设置 +* PUT /api/oss-management/settings：更新设置 + +### 权限 + +* AbpOssManagement.Setting：设置管理权限 + +## 注意事项 + +* 需要具有相应的权限才能访问设置 +* 某些设置可能需要重启应用才能生效 +* 建议在修改设置前备份当前配置 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.EN.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.EN.md new file mode 100644 index 000000000..e182aa04a --- /dev/null +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.EN.md @@ -0,0 +1,46 @@ +# LINGYUN.Abp.OssManagement.Tencent + +Tencent Cloud OSS container interface implementation + +## Features + +* Implements object storage management based on Tencent Cloud COS +* Supports basic operations including file upload, download, and deletion +* Supports file sharding upload and breakpoint continuation +* Integrates with Tencent Cloud COS access control and security mechanisms +* Supports object expiration management +* Supports temporary key access + +## Configuration + +Module reference as needed: + +```csharp +[DependsOn(typeof(AbpOssManagementTencentCloudModule))] +public class YouProjectModule : AbpModule +{ + // other +} +``` + +## Configuration Details + +Required configuration items: +* SecretId: Tencent Cloud access key ID +* SecretKey: Tencent Cloud access key secret +* Region: Region information +* AppId: Application ID +* Bucket: Bucket name +* SecurityToken: Optional temporary security token + +## Notes + +* Recommended to use sub-account keys for access +* Recommended to enable server-side encryption +* Recommended to configure appropriate bucket policies +* Recommended to enable logging functionality + +## Links + +* [中文文档](./README.md) +* [Module documentation](../README.md) diff --git a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.md b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.md index e46d7a4ba..3310a28ce 100644 --- a/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.md +++ b/aspnet-core/modules/oss-management/LINGYUN.Abp.OssManagement.Tencent/README.md @@ -2,6 +2,15 @@ 腾讯云oss容器接口 +## 功能 + +* 实现基于腾讯云COS的对象存储管理 +* 支持文件上传、下载和删除等基本操作 +* 支持文件分片上传和断点续传 +* 集成腾讯云COS的访问控制和安全机制 +* 支持对象过期管理 +* 支持临时密钥访问 + ## 配置使用 模块按需引用 @@ -13,3 +22,25 @@ public class YouProjectModule : AbpModule // other } ``` + +## 配置说明 + +需要配置以下关键信息： +* SecretId：腾讯云访问密钥ID +* SecretKey：腾讯云访问密钥密码 +* Region：地域信息 +* AppId：应用ID +* Bucket：存储桶名称 +* SecurityToken：可选的临时安全令牌 + +## 注意事项 + +* 建议使用子账号密钥进行访问 +* 建议开启服务端加密 +* 建议配置适当的存储桶策略 +* 建议启用日志记录功能 + +## 链接 + +* [English documentation](./README.EN.md) +* [模块说明](../README.md) diff --git a/aspnet-core/modules/oss-management/README.md b/aspnet-core/modules/oss-management/README.md index 047df60b7..47ae00b30 100644 --- a/aspnet-core/modules/oss-management/README.md +++ b/aspnet-core/modules/oss-management/README.md @@ -1,62 +1,64 @@ -# Oss-Management - -File-Management更名为Oss-Management - -## 模块说明 - -### 基础模块 - -* [LINGYUN.Abp.OssManagement.Domain.Shared](./LINGYUN.Abp.OssManagement.Domain.Shared) 领域层公共模块，定义了错误代码、本地化、模块设置 -* [LINGYUN.Abp.OssManagement.Domain](./LINGYUN.Abp.OssManagement.Domain) 领域层模块，定义了抽象的Oss容器与对象管理接口 -* [LINGYUN.Abp.OssManagement.Application.Contracts](./LINGYUN.Abp.OssManagement.Application.Contracts) 应用服务层公共模块，定义了管理Oss的外部接口、权限、功能限制策略 -* [LINGYUN.Abp.OssManagement.Application](./LINGYUN.Abp.OssManagement.Application) 应用服务层实现，实现了Oss管理接口 -* [LINGYUN.Abp.OssManagement.HttpApi](./LINGYUN.Abp.OssManagement.HttpApi) RestApi实现，实现了独立的对外RestApi接口 -* [LINGYUN.Abp.OssManagement.HttpApi.Client](./LINGYUN.Abp.OssManagement.HttpApi.Client) 客户端代理模块, 简化远程调用过程 -* [LINGYUN.Abp.OssManagement.SettingManagement](./LINGYUN.Abp.OssManagement.SettingManagement) 设置管理模块，对外暴露自身的设置管理，用于网关聚合 - -### 高阶模块 - -* [LINGYUN.Abp.BlobStoring.OssManagement](./LINGYUN.Abp.BlobStoring.OssManagement) abp框架对象存储提供者**IBlobProvider**的Oss管理模块实现, 依赖于Oss客户端代理模块 -* [LINGYUN.Abp.OssManagement.Aliyun](./LINGYUN.Abp.OssManagement.Aliyun) Oss管理的阿里云实现，实现了部分阿里云Oss服务的容器与对象管理 -* [LINGYUN.Abp.OssManagement.FileSystem](./LINGYUN.Abp.OssManagement.FileSystem) Oss管理的本地文件系统实现，实现了部分本地文件系统的容器（目录）与对象（文件/目录）管理 -* [LINGYUN.Abp.OssManagement.ImageSharp](./LINGYUN.Abp.OssManagement.ImageSharp) Oss对象的ImageSharp扩展，当前端传递需求处理对象时，此模块用于实现基于图形文件流的处理 -* [LINGYUN.Abp.OssManagement.Imaging](./LINGYUN.Abp.OssManagement.Imaging) Oss对象的Volo.Abp.Imaging扩展 -* [LINGYUN.Abp.OssManagement.Imaging.ImageSharp](./LINGYUN.Abp.OssManagement.Imaging.ImageSharp) Oss对象的Volo.Abp.Imaging.ImageSharp扩展 -* [LINGYUN.Abp.OssManagement.Nexus](./LINGYUN.Abp.OssManagement.Nexus) Oss管理的Nexus实现，管理来自私有Nexus仓库的RAW存储类型 -* [LINGYUN.Abp.OssManagement.Minio](./LINGYUN.Abp.OssManagement.Minio) Oss管理的Minio实现，管理基于Minio的对象存储服务 -* [LINGYUN.Abp.OssManagement.Tencent](./LINGYUN.Abp.OssManagement.Tencent) Oss管理的腾讯云实现，实现了部分腾讯云Oss服务的容器与对象管理（未完全实现） - -### 权限定义 - -* AbpOssManagement.Container 授权对象是否允许访问容器（bucket） -* AbpOssManagement.Container.Create 授权对象是否允许创建容器（bucket） -* AbpOssManagement.Container.Delete 授权对象是否允许删除容器（bucket） -* AbpOssManagement.OssObject 授权对象是否允许访问Oss对象 -* AbpOssManagement.OssObject.Create 授权对象是否允许创建Oss对象 -* AbpOssManagement.OssObject.Delete 授权对象是否允许删除Oss对象 -* AbpOssManagement.OssObject.Download 授权对象是否允许下载Oss对象 - -### 功能定义 - -* AbpOssManagement.OssObject.DownloadFile 用户可以下载文件 -* AbpOssManagement.OssObject.DownloadLimit 用户在周期内允许下载文件的最大次数，范围0-1000000 -* AbpOssManagement.OssObject.DownloadInterval 用户限制下载文件次数的周期，时钟刻度：月，默认： 1，范围1-12 -* AbpOssManagement.OssObject.UploadFile 用户可以上传文件 -* AbpOssManagement.OssObject.UploadLimit 用户在周期内允许上传文件的最大次数，范围0-1000000 -* AbpOssManagement.OssObject.UploadInterval 用户限制上传文件次数的周期，时钟刻度：月，默认： 1，范围1-12 -* AbpOssManagement.OssObject.MaxUploadFileCount 单次上传文件的数量，未实现 - -### 配置定义 - -* Abp.OssManagement.DownloadPackageSize 下载分包大小，分块下载时单次传输的数据大小，未实现 -* Abp.OssManagement.FileLimitLength 上传文件限制大小，默认：100 -* Abp.OssManagement.AllowFileExtensions 允许的上传文件扩展名，多个扩展名以逗号分隔，默认：dll,zip,rar,txt,log,xml,config,json,jpeg,jpg,png,bmp,ico,xlsx,xltx,xls,xlt,docs,dots,doc,dot,pptx,potx,ppt,pot,chm - -## 更新日志 - -*【2021-03-10】 变更FileManagement命名空间为OssManagement -*【2021-10-22】 增加PublicFilesController用于身份认证通过的用户上传/下载文件,所有操作限定在用户目录下 -*【2021-12-13】 增加LINGYUN.Abp.BlobStoring.OssManagement用于实现Oss代理二进制文件存储 -*【2023-09-04】 集成Volo.Abp.Imaging模块用于图形文件流处理 -*【2023-10-11】 集成Nexus仓库实现基于Nexus Raw类型存储(**未完善**) -*【2024-10-24】 集成Volo.Abp.BlobStoring.Minio模块用于实现基于Minio的文件存储 \ No newline at end of file +# Oss-Management + +File-Management更名为Oss-Management + +## 模块说明 + +### 基础模块 + +* [LINGYUN.Abp.OssManagement.Domain.Shared](./LINGYUN.Abp.OssManagement.Domain.Shared) 领域层公共模块，定义了错误代码、本地化、模块设置 +* [LINGYUN.Abp.OssManagement.Domain](./LINGYUN.Abp.OssManagement.Domain) 领域层模块，定义了抽象的Oss容器与对象管理接口 +* [LINGYUN.Abp.OssManagement.Application.Contracts](./LINGYUN.Abp.OssManagement.Application.Contracts) 应用服务层公共模块，定义了管理Oss的外部接口、权限、功能限制策略 +* [LINGYUN.Abp.OssManagement.Application](./LINGYUN.Abp.OssManagement.Application) 应用服务层实现，实现了Oss管理接口 +* [LINGYUN.Abp.OssManagement.HttpApi](./LINGYUN.Abp.OssManagement.HttpApi) RestApi实现，实现了独立的对外RestApi接口 +* [LINGYUN.Abp.OssManagement.HttpApi.Client](./LINGYUN.Abp.OssManagement.HttpApi.Client) 客户端代理模块, 简化远程调用过程 +* [LINGYUN.Abp.OssManagement.SettingManagement](./LINGYUN.Abp.OssManagement.SettingManagement) 设置管理模块，对外暴露自身的设置管理，用于网关聚合 + +### 高阶模块 + +* [LINGYUN.Abp.BlobStoring.OssManagement](./LINGYUN.Abp.BlobStoring.OssManagement) abp框架对象存储提供者**IBlobProvider**的Oss管理模块实现, 依赖于Oss客户端代理模块 +* [LINGYUN.Abp.OssManagement.Aliyun](./LINGYUN.Abp.OssManagement.Aliyun) Oss管理的阿里云实现，实现了部分阿里云Oss服务的容器与对象管理 +* [LINGYUN.Abp.OssManagement.FileSystem](./LINGYUN.Abp.OssManagement.FileSystem) Oss管理的本地文件系统实现，实现了部分本地文件系统的容器（目录）与对象（文件/目录）管理 +* [LINGYUN.Abp.OssManagement.ImageSharp](./LINGYUN.Abp.OssManagement.ImageSharp) Oss对象的ImageSharp扩展，当前端传递需求处理对象时，此模块用于实现基于图形文件流的处理 +* [LINGYUN.Abp.OssManagement.Imaging](./LINGYUN.Abp.OssManagement.Imaging) Oss对象的Volo.Abp.Imaging扩展 +* [LINGYUN.Abp.OssManagement.Imaging.ImageSharp](./LINGYUN.Abp.OssManagement.Imaging.ImageSharp) Oss对象的Volo.Abp.Imaging.ImageSharp扩展 +* [LINGYUN.Abp.OssManagement.FileSystem.Imaging](./LINGYUN.Abp.OssManagement.FileSystem.Imaging) 本地文件系统的图像处理基础模块，提供图像处理接口和管道 +* [LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp](./LINGYUN.Abp.OssManagement.FileSystem.Imaging.ImageSharp) 基于ImageSharp的本地文件系统图像处理实现，提供高性能图像处理功能 +* [LINGYUN.Abp.OssManagement.Nexus](./LINGYUN.Abp.OssManagement.Nexus) Oss管理的Nexus实现，管理来自私有Nexus仓库的RAW存储类型 +* [LINGYUN.Abp.OssManagement.Minio](./LINGYUN.Abp.OssManagement.Minio) Oss管理的Minio实现，管理基于Minio的对象存储服务 +* [LINGYUN.Abp.OssManagement.Tencent](./LINGYUN.Abp.OssManagement.Tencent) Oss管理的腾讯云实现，实现了部分腾讯云Oss服务的容器与对象管理（未完全实现） + +### 权限定义 + +* AbpOssManagement.Container 授权对象是否允许访问容器（bucket） +* AbpOssManagement.Container.Create 授权对象是否允许创建容器（bucket） +* AbpOssManagement.Container.Delete 授权对象是否允许删除容器（bucket） +* AbpOssManagement.OssObject 授权对象是否允许访问Oss对象 +* AbpOssManagement.OssObject.Create 授权对象是否允许创建Oss对象 +* AbpOssManagement.OssObject.Delete 授权对象是否允许删除Oss对象 +* AbpOssManagement.OssObject.Download 授权对象是否允许下载Oss对象 + +### 功能定义 + +* AbpOssManagement.OssObject.DownloadFile 用户可以下载文件 +* AbpOssManagement.OssObject.DownloadLimit 用户在周期内允许下载文件的最大次数，范围0-1000000 +* AbpOssManagement.OssObject.DownloadInterval 用户限制下载文件次数的周期，时钟刻度：月，默认： 1，范围1-12 +* AbpOssManagement.OssObject.UploadFile 用户可以上传文件 +* AbpOssManagement.OssObject.UploadLimit 用户在周期内允许上传文件的最大次数，范围0-1000000 +* AbpOssManagement.OssObject.UploadInterval 用户限制上传文件次数的周期，时钟刻度：月，默认： 1，范围1-12 +* AbpOssManagement.OssObject.MaxUploadFileCount 单次上传文件的数量，未实现 + +### 配置定义 + +* Abp.OssManagement.DownloadPackageSize 下载分包大小，分块下载时单次传输的数据大小，未实现 +* Abp.OssManagement.FileLimitLength 上传文件限制大小，默认：100 +* Abp.OssManagement.AllowFileExtensions 允许的上传文件扩展名，多个扩展名以逗号分隔，默认：dll,zip,rar,txt,log,xml,config,json,jpeg,jpg,png,bmp,ico,xlsx,xltx,xls,xlt,docs,dots,doc,dot,pptx,potx,ppt,pot,chm + +## 更新日志 + +*【2021-03-10】 变更FileManagement命名空间为OssManagement +*【2021-10-22】 增加PublicFilesController用于身份认证通过的用户上传/下载文件,所有操作限定在用户目录下 +*【2021-12-13】 增加LINGYUN.Abp.BlobStoring.OssManagement用于实现Oss代理二进制文件存储 +*【2023-09-04】 集成Volo.Abp.Imaging模块用于图形文件流处理 +*【2023-10-11】 集成Nexus仓库实现基于Nexus Raw类型存储(**未完善**) +*【2024-10-24】 集成Volo.Abp.BlobStoring.Minio模块用于实现基于Minio的文件存储 \ No newline at end of file