docs: 添加一键部署脚本说明与脚本文件
这个提交包含在:
@@ -54,6 +54,33 @@ npm start
|
||||
|
||||
## 部署(Docker)
|
||||
|
||||
### 一键部署脚本
|
||||
|
||||
仓库提供一键部署脚本,自动完成「拉取 git 代码 → 校验/生成 `.env` → 准备挂载目录 → `docker compose` 构建并启动」:
|
||||
|
||||
- **Linux / macOS**:`deploy.sh`
|
||||
```bash
|
||||
chmod +x deploy.sh
|
||||
./deploy.sh # 默认仓库与 ./kdbx-viewer 目录
|
||||
./deploy.sh /opt/kdbx # 指定部署目录
|
||||
REPO=https://... ./deploy.sh # 指定 git 仓库地址
|
||||
```
|
||||
- **Windows(cmd)**:`deploy.bat`
|
||||
```bat
|
||||
deploy.bat # 默认仓库与 kdbx-viewer 目录
|
||||
deploy.bat D:\kdbx # 指定部署目录
|
||||
set REPO=https://... && deploy.bat # 指定 git 仓库地址
|
||||
```
|
||||
|
||||
脚本行为:
|
||||
1. 目录已存在 git 仓库则 `git pull`,否则 `git clone`(仓库地址见脚本顶部 `REPO`,可被环境变量覆盖)。
|
||||
2. 无 `.env` 时从 `.env.example` 复制,并**中断提示填写敏感项**(`APP_PW_DYNAMIC` / `APP_PW_STATIC` / `SESSION_SECRET`);若仍为占位值也会拒绝启动。
|
||||
3. 创建 `vault/`、`logs/`、`ssl/` 挂载目录。
|
||||
4. 检查 `docker` 与 `docker compose v2` 是否可用。
|
||||
5. `docker compose up -d --build` 启动,并打印访问地址。
|
||||
|
||||
### 手动部署
|
||||
|
||||
所有配置通过**同目录的 `.env` 文件注入**,无需在 `docker-compose.yml` 中写死(`compose` 会自动读取 `.env` 并用 `${VAR}` 替换)。
|
||||
|
||||
```bash
|
||||
|
||||
在新工单中引用
屏蔽一个用户