proofdb/scriptdoc/setup_admin_users.md
2026-05-08 00:05:51 +08:00

57 lines
1.2 KiB
Markdown

# 管理员用户初始化脚本
## 脚本路径
```text
scripts/setup_admin_users.php
```
## 脚本作用
初始化管理员登录使用的 `admin_users` 表,并写入一个管理员账号。
当前版本会确保:
- `admin_users` 表存在。
- `username` 唯一索引存在。
- `updated_time` 自动更新时间 trigger 存在。
- 指定用户名会被创建;如果已存在,则会更新显示名和密码哈希。
## 运行前提
- 当前环境中的 PostgreSQL 配置可用。
- 项目依赖已安装完成。
- 从项目根目录执行命令。
## 运行命令
```bash
php scripts/setup_admin_users.php --username=admin --password='your-password' --display_name='Proof DB Admin'
```
其中:
- `--username` 必填
- `--password` 必填
- `--display_name` 选填
## 成功输出示例
```text
Admin users table initialized.
Seeded username: admin
Display name: Proof DB Admin
```
## 适用场景
- 首次启用管理员登录。
- 需要创建第一个管理员用户。
- 需要重置已有管理员的密码。
## 重要说明
- 这个脚本不会输出明文密码。
- 再次执行同一用户名时,会更新密码哈希。
- 建议在安全环境下执行,不要把明文密码写进仓库文件。