Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 6.33 KB

UserGuide.zh_CN.md

File metadata and controls

96 lines (60 loc) · 6.33 KB

使用指南

本文主要介绍MyBooks的使用说明,以及常见问题。如需手动安装或者提交PR,请参阅开发者指南。

NAS用户,可以参阅网友们写的指南:

常见配置指南

请参考功能手册。 注: 所有功能说明以公众号Talebook上发布的版本说明为准。

功能使用说明

浏览记录

登录后打开某本书的详情页,系统会自动记下这次浏览。在左侧菜单「阅读信息」下点击「浏览记录」,可以按时间从新到旧查看最近浏览过的书籍,每个账号最多保留最近 100 本,同一本书重复浏览只会刷新时间。适合在编辑或修改书籍后,想回头再找到它的时候使用。

  • 只记录打开详情页的书籍,在线阅读、下载不会单独记录。
  • 点击页面标题旁的清空按钮,可以清空自己的全部浏览记录。
  • 记录会先暂存在内存中,约 30 秒内批量保存,刚浏览的书也会立即显示在列表里。如果程序被强制终止,最后几十秒内的浏览可能不会保存。

书单:允许访客阅读

如果站点关闭了「允许游客阅读」,管理员可以把某个书单设为「访客可读」,让没有登录的访客直接阅读这个书单里的书,用来展示和推荐。

  • 仅管理员可以设置:在书单的编辑对话框里打开「允许访客阅读」。管理员可以设置任何人创建的书单。
  • 书单必须是公开的才能开启,书单改为私有时会自动关闭。
  • 开启后,书单上会显示「访客可读」标记,访客只能阅读,不能下载。
  • 站点已经允许游客阅读时,这个开关和标记都不会显示。
  • 把书移出书单、删除书单或关闭开关后,访客立即无法再阅读这些书。

分享链接

管理员可以为单本书生成分享链接,不需要登录的人也能通过链接阅读或下载这本书,类似网盘的分享。适合在站点关闭游客访问时,把书分享给特定的人。

创建分享

  1. 以管理员身份打开书籍详情页,在「更多」菜单里选择「分享给他人」。
  2. 在对话框中设置:允许在线阅读、允许下载(至少选一项)、有效期(1 天 / 7 天 / 30 天 / 永久)、访问次数上限(留空或 0 为不限)、提取码(可选,可点击右侧按钮随机生成 8 位)。
  3. 点击「创建分享」,复制对话框中的分享链接发给对方。对话框左侧会同步生成一张带二维码的分享卡片,可以下载后发送。

每本书只有一个分享链接。已分享的书,详情页标题旁和书籍卡片左上角(仅管理员可见)会显示云朵图标;再次打开「管理分享」可以修改设置或取消分享。

访客如何使用

  • 访客打开链接,页面顶部显示「来自 xxx 分享的书籍」,并展示书名、作者和有效期。
  • 设置了提取码的,需要先输入提取码;同一网络连续输错 5 次会被锁定 10 分钟。
  • 验证通过后,按分享设置显示「在线阅读」和各格式的「下载」按钮。

访问次数的计算方式

访客验证通过后,当前浏览器在 24 小时内可以反复阅读和下载,不再重复计数。也就是说,同一个浏览器 24 小时内多次访问只算 1 次;换浏览器、清除缓存或超过 24 小时后再次打开,会重新计 1 次。次数用完后,新的访客无法再打开,但已经验证过的访客在这 24 小时内不受影响。

何时失效

  • 取消分享、超过有效期、访问次数用尽,链接会提示「链接无效或已失效」。取消和有效期到期对已验证的访客也立即生效。
  • 修改提取码,或取消后重新创建分享,旧的授权和旧链接都会失效;重新创建会生成新的链接。
  • 书籍被删除时,它的分享会一并清除。

统一管理

在左侧「系统管理」下点击「分享管理」,可以分页查看所有分享的书籍、权限、有效期、访问次数和状态,并复制链接、取消或删除分享(删除同时也会取消)。

分享链接对所有人有效,包括系统内已登录的用户:持有有效分享的用户,即使自己的账号没有阅读或下载权限,也可以通过链接阅读和下载。

常见问题排查

supervisord启动失败

如果有调整过supervisord里面的配置(例如端口、目录),一定要执行sudo supervisorctl reload all重新读取配置,不然是不会生效的,可能会导致启动失败。

如果提示mybooks:tornado-8000: ERROR(spawn error),那么说明环境没配置正确。 请打开日志文件/data/log/mybooks.log查看原因,重点查看最后一次出现Traceback报错,关注其中Traceback (most recent call last)提示的错误原因。

网站能打开,但是提示500: internal server error

这种情况,一般是服务运行时出现异常,常见原因有目录权限没有配置正常、数据库没创建好、或者触发了某个代码BUG。

** 一般都是因为data目录权限设置不正确,导致启动异常 **,可以多排查下用户名、UID、目录权限等。

请打开日志文件/data/log/mybooks.log查看原因,重点查看最后一次出现Traceback报错,关注其中Traceback (most recent call last)提示的错误原因,并提issue联系开发者排查。

「静读天下」APP里访问书库会失败,怎么办?

这是因为静读天下APP不支持Cookie,导致登录会失败。在最新版系统中(v2.0.0-87-gf6d8f06)已经调整程序逻辑,可以无需登录就正常浏览,仅在下载时检测权限。为了避免弹出登录提示,请配置:

  • 关闭「私人图书馆」模式。
  • 打开「允许任意下载」(访客无需注册或登录)

阅读器的页面卡住了,不加载书籍,怎么办?

这是因为浏览器的广告拦截插件屏蔽了一些JS,导致页面加载异常。请关闭相关插件后再重试,例如 uBlock Origin