快速开始

1. 登录

打开 http://<你的实例地址>:3000，用默认密码 kamimamita 登录，然后立刻在设置页面改掉它。

2. 指向你的库

--library-path（或 LANRURUGI_LIBRARY_PATH）指向放档案的目录。默认是 ./library；Compose 部署里 对应容器的 /home/koyomi/lanrurugi/content。

3. 扫描

在设置页面触发一次全量扫描。扫描是并发的（Rayon），并且不会自动删除档案记录——「扫描时发现文件消失」 只会清理路径簿记，档案记录本身归「数据库清理」管，是一个独立的、需要你明确触发的操作。

4. 建立 API 令牌

API 参考里的「Test it」面板需要令牌。在设置页面的令牌管理里创建一个，然后：

curl -H "Authorization: Bearer <你的令牌>" http://localhost:3000/api/archives

令牌按权限分为管理员与访客两类；访客令牌只能读取。

5. 从旧版 LANraragi 迁移

不需要迁移步骤。LANrurugi 直接读旧版写入 Redis 的数据：档案记录、标签、分类、阅读进度、缩略图、 Tankoubon 分组、配置。把你的 data/database 目录指过来即可。

需要注意的两点：

• 档案 ID 算法。新扫描使用大小感知指纹（hash(前 512KB ++ 大端 u64 文件大小)），旧版的 SHA-1(前 512KB) 仍然可读。旧算法会把开头字节相同的不同档案误判为重复并合并——这是本项目修掉的 已知缺陷。修复只对新内容生效，已有 ID 不会被静默改写。
• 找回被误合并隐藏的文件。跑一次 lanrurugi rebuild-index：它会用新算法重算 ID，并把历史上被 误判合并隐藏的文件重新暴露出来。

6. 试试 API

打开 API 参考，在请求面板里把服务器地址改成你自己的实例（默认已经是 http://localhost:3000），填上令牌，然后直接发请求。请求从你的浏览器直接到你的实例，不经过本项目。

浏览器不允许的时候（例如文档站是 HTTPS 而你的实例是局域网里的纯 HTTP），每个端点都提供了一份可直接 复制的命令行。

细节见用文档站测试 API。