docs(config): 补 .env.example 并修正 .gitignore 误伤模板
.gitignore 的 `.env.*` 会把 `.env.example` 一起排除,等于把变量清单挡在仓库外, 接手的人只能翻 application.yml 逐个猜要配什么。加 `!.env.example`(含 `.sample`、`.template`)例外,规则顺序放在忽略之后。 同时补 .env.example:从 application.yml 与代码里实际提取 20 个变量,分组注明 默认值与是否必须替换。三个必改项(DB_PASS 无默认、GATEWAY_TOKEN 占位、 BIZ_TOKEN_SECRET 与 BIZ_PII_KEY 为 dev-only)单独标出。 本文件只放占位值;真实的 .env 仍不入库。另注明工程不自动读 .env (未引入 dotenv),必须由启动脚本加载或 docker compose --env-file 注入—— 这一条不说清,会有人建了 .env 直接启动然后发现 DB_PASS 还是缺。
This commit is contained in:
1 parent
a7605ef8b8
commit
983191628e
6 files changed
+109
-5
No files matched your search
@@ -14,8 +14,13 @@ out/
|
||||
*.ear
|
||||
|
||||
# ---------- 本地配置(可能含口令,绝不入库) ----------
|
||||
# 真实的 .env 一律不入库;但"变量清单"模板必须入库,
|
||||
# 否则接手的人不知道要配哪些变量。模板里只放占位值,不放真实值。
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
!.env.sample
|
||||
!.env.template
|
||||
*.local.yml
|
||||
application-local.yml
|
||||
application-*-local.yml
|
||||
|
||||
Reference in new issue
Block a user