1、镜像

hectorqin/reader:latest

2、安装

2.1、基础设置

  • 重启策略:容器退出时总是重启容器。

2.2、网络

  • 网络选择桥接。

2.3、命令

  • 固定,不可删除部分为容器自带,不可做任何修改;

  • --reader.app.secureKey--reader.app.inviteCode须设置为强密码且不能一样;

  • 以下为可设置命令:

java
-jar
/app/bin/reader.jar
--spring.profiles.active=prod
--reader.app.secure=true
--reader.app.secureKey=xxxxxx
--reader.app.inviteCode=xxxxxx
--reader.app.cacheChapterContent=true
--reader.app.debugLog=false
--reader.app.autoClearInactiveUser=0
--reader.app.mongoUri=
--reader.app.mongoDbName=reader
--reader.app.shelfUpdateInteval=10
--reader.app.userLimit=15
--reader.app.remoteWebviewApi=
--reader.app.defaultUserEnableWebdav=true
--reader.app.defaultUserEnableLocalStore=true
--reader.app.defaultUserEnableBookSource=true
--reader.app.defaultUserEnableRssSource=true
--reader.app.defaultUserBookSourceLimit=999999
--reader.app.defaultUserBookLimit=999999
--reader.app.autoBackupUserData=false
  • 注意:代码中=右边无值时整条命令都不能添加否则启动时会报错。

  • 下表为命令及描述:

命令

描述

说明

--spring.profiles.active

prod

使用的配置文件

固定prod,不要修改为其他值

--reader.app.secure

true

是否需要登录鉴权,开启后将支持多用户模式

非个人使用建议开启

--reader.app.secureKey

管理密码,开启鉴权时,前端管理用户空间的管理密码

使用强密码

--reader.app.inviteCode

注册邀请码,为空时则开放注册,否则注册时需要输入邀请码

使用强密码

--reader.app.cacheChapterContent

true

是否缓存章节内容

--reader.app.debugLog

false

是否打开调试日志

--reader.app.autoClearInactiveUser

0

是否自动清理不活跃用户,为0不清理,大于0为清理超过 autoClearInactiveUser 天未登录的用户

单位:天

--reader.app.mongoUri

mongodb uri 用于备份数据

--reader.app.mongoDbName配合使用

--reader.app.mongoDbName

reader

mongodb 数据库名称

--reader.app.mongoUri配合使用

--reader.app.shelfUpdateInteval

10

书架自动更新间隔时间,单位分钟,必须是10的倍数

--reader.app.userLimit

15

用户上限,最大 15

--reader.app.defaultUserEnableWebdav

true

新用户是否默认启用webdav

--reader.app.defaultUserEnableLocalStore

true

新用户是否默认启用localStore

--reader.app.defaultUserEnableBookSource

true

新用户是否默认可编辑书源,如果为false,则只能使用默认书源,不能新增/修改/删除

--reader.app.defaultUserEnableRssSource

true

新用户是否默认可编辑RSS源

--reader.app.defaultUserBookSourceLimit

100

新用户默认书源上限

若默认值不满足使用,可修改此值

--reader.app.defaultUserBookLimit

200

新用户默认书籍上限

若默认值不满足使用,可修改此值

--reader.app.autoBackupUserData

false

是否自动备份用户数据

2.4、存储空间

  • 装载路径/storage:存储数据文件。

  • 装载路径/logs:存储日志文件

2.5、端口设置

  • 容器端口8080,本地端口自动未被使用的端口

3、使用

3.1、WebDAV同步配置

  1. 首先需要在阅读App里面配置 WebDAV备份

    服务器地址: http://IP:端口/reader3/webdav/

    如果开启了 reader.app.secure 选项,那么使用网页注册的用户名和密码登录,否则使用用户名 default 和 密码 123456 登录

  2. 然后在阅读App里面点击备份

  3. 在网页里面查看WebDAV文件,确认是否备份成功

  4. 备份成功之后

    • 服务器会自动同步书籍阅读进度(暂不支持章节内阅读位置,也不会自动同步书架信息变更)

    • 可以直接选择阅读App的备份文件进行恢复,这样会直接覆盖书源和书架信息

    • 可以备份当前书源和书架信息到WebDAV,但是必须要先备份成功

    • 需要通过恢复备份文件来同步书籍和书源信息

  5. PS: 本地书源的书籍同步后无法打开,除非换源

3.2、客户端设置

  • Windows / MacOS / Linux

下载对应平台安装包安装即可,需要安装java8及以上环境

MacOS 版 storage 默认是 用户目录/.reader/storage,其它版本 storage 默认是 程序目录/storage

  • 配置文件

storage/windowConfig.json

包含图形界面和接口服务的相关配置,JSON格式,修改后,程序重启才会生效

请仔细检查配置内容,不支持注释,此处注释只是为了方便理解

{
    "serverPort": 8080,            // web服务端口,默认为 8080
    "showUI": true,                // 是否显示UI界面,默认为显示
    "debug": false,                // 是否调试模式,默认为否
    "positionX": 0.0,              // 窗口位置 横坐标
    "positionY": 0.0,              // 窗口位置 纵坐标
    "width": 1280.0,               // 窗口大小 宽度
    "height": 800.0,               // 窗口大小 高度
    "rememberSize": true,          // 改变窗口大小时,是否记住窗口大小,默认记住
    "rememberPosition": false,     // 移动窗口时,是否记住窗口位置,默认不记住
    "setWindowPosition": false,    // 启动时是否设置窗口位置,默认不设置,窗口默认居中
    "setWindowSize": true,         // 启动时是否设置窗口大小,默认按照配置文件进行设置
    "serverConfig": {                // 接口服务配置,此处配置会被 `serverPort|showUI|debug` 等覆盖
        "reader.app.secure": false,  // 是否需要登录鉴权,开启后将支持多用户模式
        "reader.app.inviteCode": "",  // 注册邀请码,为空时则开放注册,否则注册时需要输入邀请码。仅多用户模式下有效
        "reader.app.secureKey": "",  // 管理密码,开启鉴权时,前端管理用户空间的管理密码。仅多用户模式下有效
    }
}
  • 手机端

使用docker版本或者服务器版本,访问web页面,可以添加为桌面应用。

3.3、其他

  • 关注微信公众号,发送阅读关键词。