快速开始
快速开始
面向首次运行 SlothVault 的维护者：先用 SQLite 在本机完成安装，再创建可预览的项目草稿。以下命令在仓库根目录执行，示例假定该目录尚未配置生产数据。
1. 检查运行环境
项目要求 Node.js >=24.18.1，仓库指定 npm 11.16.0。先确认本机版本：
node --version
npm --version
使用 SQLite 本地开发不需要 Docker。安装依赖会执行项目的 postinstall，生成三种数据库对应的 Prisma Client；它不会替你创建首位管理员。
2. 安装依赖并启动
npm ci
APP_DATA_PATH=./data UPLOAD_STORAGE_PATH=./data/uploads npm run dev
预期开发服务启动于本机 3000 端口。浏览器打开 http://localhost:3000/install。若端口或地址被启动参数调整，以终端实际输出为准。
这两项路径用于保存配置、数据库和上传文件。已有数据时不要删除 data 来“重新安装”；应先判断安装状态并保留原目录。
3. 完成网页安装
- 选择 SQLite，执行连接与空库检查。SQLite 使用受管数据库文件，不填写任意文件路径。
- 初始化表结构，等待进入管理员创建阶段。
- 设置首位管理员的用户名和密码，完成安装。
- 通过管理员登录页
/admin/auth/login登录，进入/admin/mm。
若使用 MySQL/PostgreSQL，应先创建一个没有用户表的目标数据库，并给应用账号授予建表、索引、外键和业务读写权限。安装器不会替外部数据库创建库或账号。
公网安装必须先限制 /install 的访问范围，避免首位管理员被其他访问者抢先创建。安装完成后，该页面应转向登录流程，而不是开放重装。
4. 创建项目草稿
在 /admin/mm/projects 建立项目与未发布版本，在版本下创建分类、笔记及正文，并指定主正文。保存后通过管理员预览检查目录、正文和附件。
预期结果是管理员能查看草稿，而普通公开项目列表不会因“保存”自动出现一个发布版本。笔记启用、正文主版本和版本发布是不同概念。若要修改已发布版本的正文，应先复制为新草稿；不要尝试就地覆盖历史正文。
本步骤止于草稿，不要求钱包、不进行版本发布或链上签名。
5. 转向生产部署
Linux 部署需要预先安装 Docker Engine、Docker Compose v2 和 Python 3.10+。可按仓库的 SlothTool 入口安装并调用独立部署包：
npm install -g @holic512/slothtool
slothtool install slothvault
sudo env HOME="$HOME" "$(command -v slothtool)" slothvault deploy
这些命令会安装工具、生成部署配置并启动容器，不是只读检查；应在目标服务器确认后执行。部署程序不会自动安装 Docker。默认生成 /data/slothvault/compose.yml，路径可在交互中替换；MySQL/PostgreSQL 数据目录必须与应用数据目录分开。
Compose 自动引导可完成数据库初始化，随后仍需访问 /install 创建首位管理员。正式环境应配置 HTTPS 并持久化数据、主密钥和备份目录。本节没有验证已发布镜像或外部工具的实际可用性。