DOCUMENTATION

使用文档

从第一次部署,到每一天的阅读。

最近同步:2026/9/17 16:31:37 · 内容来自 GitHub

快速开始

首页 · English

已有二毛图书服务器?直接打开服务器地址登录,或按手机使用说明连接。需要在 NAS 上安装?fnOS 用户可先看安装与更新

1. 准备文件夹

在服务器上准备一个部署文件夹,其中放置:

  • library:存放电子书、漫画、PDF 和有声书。
  • data/storage:保存账户、进度、设置等应用数据,请保留整个文件夹。

2. 启动 Docker

服务器需已安装 Docker Compose,支持 amd64 和 arm64。在部署文件夹中新建 compose.yaml,填入:

services:
  web:
    image: gamersgu/shuku-starship-web:prod
    restart: unless-stopped
    user: "${PUID:-1000}:${PGID:-1000}"
    environment:
      STORAGE_ROOT: /app/storage
      PORT: 3000
      HOSTNAME: 0.0.0.0
    ports:
      - "3000:3000"
    volumes:
      - ./data/storage:/app/storage
      - ./library:/libraries/books
    stop_grace_period: 60s

在该文件夹运行:

docker compose up -d

打开 http://服务器地址:3000,例如 http://192.168.1.10:3000。首次启动需要一些时间。

已有藏书可将 ./library 换成实际书籍文件夹。启动失败或需要调整端口、目录权限,见配置说明

3. 添加书库并开始阅读

  1. 按首次设置向导创建管理员账户,没有默认账号或密码。
  2. 添加 /libraries/books 为书库,选择文件组织方式;先看目录示例
  3. 将读物放入服务器的 library 文件夹,等待扫描;需要补齐内容时使用“继续导入”。
  4. 进入书库,打开一本书,再选择要读的文件或卷册。

接下来:导入与整理 · 阅读与收听

DOWNLOAD

选择你的阅读入口

客户端连接已部署的书库;首次使用可先安装 NAS 服务端。

Windows / macOS / Linux

用浏览器打开你的服务器地址即可阅读,无需安装桌面客户端。