Skip to content

Commit a16b0a4

Browse files
committed
Updated README files
1 parent 6757faa commit a16b0a4

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

README.MD

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ It provides RESTful APIs compatible with the OpenBioCard frontend, allowing you
6060

6161
2. **Check configuration**
6262
The project uses `appsettings.Development.json` by default.
63+
64+
```bash
65+
$ cd OpenBioCardServer
66+
$ vim appsettings.Development.json
67+
```
68+
6369
```json
6470
// appsettings.Development.json
6571
"DatabaseSettings": {
@@ -125,6 +131,11 @@ For environment variables, use double underscores `__` to separate sections (e.g
125131
| | `ExpirationMinutes` | `CacheSettings__ExpirationMinutes` | Absolute expiration time in minutes. | `30` |
126132
| | `SlidingExpirationMinutes` | `CacheSettings__SlidingExpirationMinutes` | Reset expiration if accessed within this time. | `5` |
127133
| | `CompactionPercentage` | `CacheSettings__CompactionPercentage` | Percentage (0.0-1.0) of cache to compact when full. | `0.2` |
134+
| | `FactorySoftTimeoutMilliseconds` | `CacheSettings__FactorySoftTimeoutMilliseconds` | Soft timeout for factory execution (ms). | `500` |
135+
| | `EnableFailSafe` | `CacheSettings__EnableFailSafe` | Enable Fail-Safe mechanism. | `true` |
136+
| | `FailSafeMaxDurationMinutes` | `CacheSettings__FailSafeMaxDurationMinutes` | Max duration for stale data (minutes). | `120` |
137+
| | `FailSafeThrottleDurationSeconds` | `CacheSettings__FailSafeThrottleDurationSeconds` | Throttle duration for transient errors (seconds). | `30` |
138+
| | `DistributedCacheCircuitBreakerDurationSeconds` | `CacheSettings__DistributedCacheCircuitBreakerDurationSeconds` | Circuit breaker duration for distributed cache (seconds). | `2` |
128139
| **Compression**| `Enabled` | `CompressionSettings__Enabled` | Enable Gzip/Brotli response compression. | `true` |
129140
| | `EnableForHttps` | `CompressionSettings__EnableForHttps` | Secure CRIME/BREACH protection flag. | `true` |
130141
| | `Level` | `CompressionSettings__Level` | Level: `Fastest`, `Optimal`, `NoCompression`, `SmallestSize`. | `Fastest` |

README.zh-CN.MD

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@
6060

6161
2. **检查配置**
6262
项目默认使用 `appsettings.Development.json`
63+
64+
```bash
65+
$ cd OpenBioCardServer
66+
$ vim appsettings.Development.json
67+
```
68+
6369
```json
6470
// appsettings.Development.json
6571
"DatabaseSettings": {
@@ -83,7 +89,7 @@
8389

8490
1. **克隆仓库** `https://github.com/OpenBioCard/OpenBioCard.git`
8591

86-
2. **安装依赖**
92+
2. **安装依赖**
8793

8894
```bash
8995
$ pnpm install
@@ -98,7 +104,7 @@
98104
```env
99105
VITE_API_BASE_URL=http://localhost:5046/classic
100106
```
101-
107+
102108
4. 启动应用
103109

104110
```bash
@@ -125,6 +131,11 @@
125131
| | `ExpirationMinutes` | `CacheSettings__ExpirationMinutes` | 绝对过期时间(分钟)。 | `30` |
126132
| | `SlidingExpirationMinutes` | `CacheSettings__SlidingExpirationMinutes` | 滑动过期时间(分钟),访问时自动续期。 | `5` |
127133
| | `CompactionPercentage` | `CacheSettings__CompactionPercentage` | 内存缓存满时清理的比例 (0.0 - 1.0)。 | `0.2` |
134+
| | `FactorySoftTimeoutMilliseconds` | `CacheSettings__FactorySoftTimeoutMilliseconds` | 缓存工厂软超时时间(毫秒)。 | `500` |
135+
| | `EnableFailSafe` | `CacheSettings__EnableFailSafe` | 是否启用故障兜底 (Fail-Safe) 机制。 | `true` |
136+
| | `FailSafeMaxDurationMinutes` | `CacheSettings__FailSafeMaxDurationMinutes` | 故障兜底时陈旧数据的最大保留时间(分钟)。 | `120` |
137+
| | `FailSafeThrottleDurationSeconds` | `CacheSettings__FailSafeThrottleDurationSeconds` | 瞬时故障的节流时间(秒)。 | `30` |
138+
| | `DistributedCacheCircuitBreakerDurationSeconds` | `CacheSettings__DistributedCacheCircuitBreakerDurationSeconds` | 分布式缓存熔断时间(秒)。 | `2` |
128139
| **压缩** | `Enabled` | `CompressionSettings__Enabled` | 是否启用 Gzip/Brotli 响应压缩。 | `true` |
129140
| | `EnableForHttps` | `CompressionSettings__EnableForHttps` | 是否在 HTTPS 请求中启用压缩。 | `true` |
130141
| | `Level` | `CompressionSettings__Level` | 压缩级别:`Fastest` (最快), `Optimal` (最佳), `SmallestSize` (最小体积)。 | `Fastest` |

0 commit comments

Comments
 (0)