Skip to content

Commit dea0b3e

Browse files
committed
Updated README files
1 parent 414072c commit dea0b3e

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.MD

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ It provides RESTful APIs compatible with the OpenBioCard frontend, allowing you
3030

3131
## ✨ Features
3232

33-
- 🚀 **High Performance** - Built on the fast ASP.NET Core framework.
33+
- 🚀 **High Performance** - Built on ASP.NET Core with **Response Compression** (Brotli/Gzip) and **Multi-level Caching** (Memory/Redis) support.
3434
- 💾 **Flexible Storage** - Supports **SQLite**, **PostgreSQL**, and **MySQL**, easily switchable based on requirements.
3535
- 🛡️ **Security Protection** - Built-in login rate limiting (10 requests per minute) to prevent brute-force attacks.
3636
- 🐳 **Containerization** - Comprehensive Docker support for easy deployment.
@@ -114,6 +114,9 @@ Configuration is managed via `appsettings.json` or environment variables.
114114
| :--- | :--- | :--- |
115115
| `DatabaseSettings:Type` | `DatabaseSettings__Type` | Database type, supports `SQLite`, `PgSQL`, `MySQL`. |
116116
| `DatabaseSettings:ConnectionString` | `DatabaseSettings__ConnectionString` | Database connection string. |
117+
| `CacheSettings:UseRedis` | `CacheSettings__UseRedis` | Enable Redis distributed cache (`true`/`false`). Default is `false` (Memory Cache). |
118+
| `CacheSettings:RedisConnectionString` | `CacheSettings__RedisConnectionString` | Redis connection string (e.g., `localhost:6379`). Required if UseRedis is true. |
119+
| `CompressionSettings:Enabled` | `CompressionSettings__Enabled` | Enable HTTP response compression. Default is `true`. |
117120
| `AuthSettings:RootUsername` | `AuthSettings__RootUsername` | System admin username. |
118121
| `AuthSettings:RootPassword` | `AuthSettings__RootPassword` | **Required**. System admin password. |
119122
| `CorsSettings:AllowedOrigins` | `CorsSettings__AllowedOrigins` | List of allowed frontend domains (comma-separated). |

README.zh-CN.MD

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
## ✨ 功能特性
3232

33-
- 🚀 **高性能** - 基于极速的 ASP.NET Core 框架构建。
33+
- 🚀 **高性能** - 基于极速的 ASP.NET Core 框架构建,集成 **响应压缩** (Brotli/Gzip) 与 **多级缓存** (内存/Redis) 机制
3434
- 💾 **灵活存储** - 支持 **SQLite****PostgreSQL****MySQL**,可根据需求灵活切换。
3535
- 🛡️ **安全防护** - 内置登录接口限流保护(10次/分钟),防止暴力破解。
3636
- 🐳 **容器化** - 提供完善的 Docker 支持,部署轻松便捷。
@@ -114,6 +114,9 @@
114114
| :--- | :--- | :--- |
115115
| `DatabaseSettings:Type` | `DatabaseSettings__Type` | 数据库类型,支持 `SQLite`, `PgSQL`, `MySQL`|
116116
| `DatabaseSettings:ConnectionString` | `DatabaseSettings__ConnectionString` | 数据库连接字符串。 |
117+
| `CacheSettings:UseRedis` | `CacheSettings__UseRedis` | 是否启用 Redis 分布式缓存 (`true`/`false`)。默认为 `false` (使用内存缓存)。 |
118+
| `CacheSettings:RedisConnectionString` | `CacheSettings__RedisConnectionString` | Redis 连接字符串 (如 `localhost:6379`)。启用 Redis 时必填。 |
119+
| `CompressionSettings:Enabled` | `CompressionSettings__Enabled` | 是否启用 HTTP 响应压缩。默认为 `true`|
117120
| `AuthSettings:RootUsername` | `AuthSettings__RootUsername` | 系统管理员用户名。 |
118121
| `AuthSettings:RootPassword` | `AuthSettings__RootPassword` | **必填**。系统管理员密码。 |
119122
| `CorsSettings:AllowedOrigins` | `CorsSettings__AllowedOrigins` | 允许的前端域名列表(逗号分隔)。 |

0 commit comments

Comments
 (0)