快速开始¶
从构建产物(或 Docker 镜像)出发,经 linklist init 初始化、启动服务、
注册管理员,完成一次完整可用的部署。
前置要求¶
- 构建:Rust 1.8x+(
rustup安装);前端构建用 Node/pnpm(产物frontend/dist会在编译期经 rust-embed 嵌入二进制)。 - 运行:一个可写的数据目录(默认
./data);如连接外部数据库,则该 PostgreSQL / MySQL 实例已创建好空库与账号。
方式一:源码构建¶
# 1. 构建前端产物(rust-embed 编译期需要 frontend/dist)
pnpm -C frontend/astro build # 或 just frontend-build
# 2. 构建二进制
cargo build --release
# 3. 初始化项目(生成 config.toml + 创建数据目录 + 建库迁移)
./target/release/linklist init
# 4. 启动服务(默认 0.0.0.0:9090)
./target/release/linklist run
# 5. 打开 http://localhost:9090/login 注册首个用户(自动成为管理员)
方式二:初始化时预置管理员¶
不想打开浏览器走"首个注册即管理员"引导的话,直接在 init 时预置:
./target/release/linklist init --admin-password 'your-password'
# 管理员用户名固定为 admin
# 也可用环境变量:LINKLIST_ADMIN_PASSWORD='your-password' linklist init
重复执行 init 幂等安全:已存在的配置文件不覆盖、已初始化的库不重复迁移、
已有用户时跳过预置。
方式三:Docker¶
外部数据库(PostgreSQL / MySQL)形态见 Docker 部署。
常用命令¶
linklist help # 子命令与退出码约定(--help / -h 等价)
linklist version # 版本号
linklist init # 初始化项目(见上)
linklist run # 启动 Web 服务(无参数时默认执行)
linklist reset-password <username> # 交互式重置口令(不回显)