增加配置项说明

2024-07-23 11:38:37 +08:00 · 2024-07-23 11:38:37 +08:00 · 740fd32c1f
commit 740fd32c1f
parent 51d1133ce2
1 changed files with 13 additions and 1 deletions
--- a/README.MD
+++ b/README.MD
@ -1,3 +1,15 @@
 # surl
-A simple URL shortener written in kotlin
+短链接生成系统

+## 配置项
+
+- 数据库类型: `POSTGRESQL`
+- 缓存中间件: `REDIS`
+
+### 环境变量
+
+- `DB_HOST`: 数据库主机, 必选
+- `DB_PORT`: 数据库主机端口, 可选
+- `DB_PASS`: 数据库密码, 必选
+- `REDIS_HOST`: `REDIS`主机, 必选
+- `SECRET`: `TOKEN`密钥, 可选