Skip to content

Commit

Permalink
修改教程,替换书源
Browse files Browse the repository at this point in the history
  • Loading branch information
hectorqin committed Jul 6, 2023
1 parent 38ff966 commit 54fb3bd
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 16 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<details><summary>功能说明</summary>
书源管理 <br/>
- 书架管理 <br/>
- 书架布局 <br/>
- 搜索 <br/>
- 书海 <br/>
- 看书 <br/>
Expand All @@ -43,12 +44,13 @@
- 支持漫画 <br/>
- 支持音频 <br/>
- 书源失效检测 <br/>
- 导入本地TXT、EPUB、UMD格式的书籍 <br/>
- 导入本地TXT、EPUB、UMD、PDF格式的书籍 <br/>
- 书籍分组 <br/>
- RSS订阅 <br/>
- 定时更新书架 <br/>
- 并发搜书 <br/>
- 本地书仓 <br/>
- 支持kindle阅读 <br/>
</details>

## 下载与安装
Expand Down
44 changes: 36 additions & 8 deletions doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
- [免责声明(Disclaimer)](#免责声明disclaimer)
- [数据存储](#数据存储)
- [本地书仓](#本地书仓)
- [阅读页面地址](#阅读页面地址)
- [全功能web端](#全功能web端)
- [适配kindle的 `simple-web`](#适配kindle的-simple-web)
- [自定义阅读主题](#自定义阅读主题)
- [自定义样式](#自定义样式)
- [接口服务配置](#接口服务配置)
Expand All @@ -15,8 +18,8 @@
- [服务器版](#服务器版)
- [Docker版](#docker版)
- [Docker-Compose版(推荐)](#docker-compose版推荐)
- [脚本部署(甲骨文非Ubuntu可能不支持)](#通过脚本一键部署)
- [Nginx反向代理](#nginx反向代理)
- [通过脚本一键部署](#通过脚本一键部署)
- [Nginx反向代理(如果有域名可以考虑80端口复用)](#nginx反向代理如果有域名可以考虑80端口复用)
- [开发编译](#开发编译)
- [编译脚本](#编译脚本)
- [编译前端](#编译前端)
Expand Down Expand Up @@ -89,6 +92,18 @@ storage

`storage/localStore` 中可以集中存放管理本地书籍,开启访问权限的用户可以在 `页面-浏览书仓` 中选择批量导入到自己的书架进行阅读。

## 阅读页面地址

### 全功能web端

`http://ip:端口/`

### 适配kindle的 `simple-web`

`http://ip:端口/simple-web`

> 注意,需要另外购买授权才能使用,加入TG群了解详情
## 自定义阅读主题

书架页面仅支持白天模式和黑夜模式。
Expand All @@ -111,7 +126,7 @@ storage
```yml
reader:
app:
storagePath: storage # 数据存储目录
workDir: "" # 工作目录
showUI: false # 是否显示UI
debug: false # 是否调试模式
packaged: false # 是否打包为客户端
Expand All @@ -125,8 +140,21 @@ reader:
proxyUsername: "" # 代理鉴权 用户名
proxyPassword: "" # 代理鉴权 密码
cacheChapterContent: false # 是否缓存章节内容
userLimit: 50 # 用户上限,最大 50
userBookLimit: 200 # 用户书籍上限,默认最大 200
# userBookLimit: 200 # 用户书籍上限,默认最大 200 !! v3.0.5版本开始弃用这个选项
debugLog: false # 是否打开调试日志
autoClearInactiveUser: 0 # 是否自动清理不活跃用户,为0不清理,大于0为清理超过 autoClearInactiveUser 天未登录的用户
mongoUri: "" # mongodb uri 用于备份数据
mongoDbName: "reader" # mongodb 数据库名称
shelfUpdateInteval: 10 # 书架自动更新间隔时间,单位分钟,必须是10的倍数
userLimit: 15 # 用户上限,最大 15
remoteWebviewApi: "" # remote-webview 地址
defaultUserEnableWebdav: true # 新用户是否默认启用webdav
defaultUserEnableLocalStore: true # 新用户是否默认启用localStore
defaultUserEnableBookSource: true # 新用户是否默认可编辑书源,如果为false,则只能使用默认书源,不能新增/修改/删除
defaultUserEnableRssSource: true # 新用户是否默认可编辑RSS源
defaultUserBookSourceLimit: 100 # 新用户默认书源上限
defaultUserBookLimit: 200 # 新用户默认书籍上限
autoBackupUserData: false # 是否自动备份用户数据

server:
port: 8080 # 监听端口
Expand Down Expand Up @@ -305,7 +333,7 @@ docker-compose stop
docker logs -f reader
# 自行导入远程书源(打开链接后复制网址导入即可)
https://legado.pages.dev
https://legado.aoaostar.com/
# 手动更新
docker-compose pull && docker-compose up -d
Expand All @@ -315,10 +343,10 @@ docker-compose pull && docker-compose up -d
```shell
# 此脚本对甲骨文非Ubuntu系统,CentOS9可能不兼容。建议网上手动搜索
#curl
#curl
bash <(curl -L -s https://ghproxy.com/https://raw.githubusercontent.com/hectorqin/reader/master/reader.sh)
#wget
#wget
bash <(wget -qO- --no-check-certificate https://ghproxy.com/https://raw.githubusercontent.com/hectorqin/reader/master/reader.sh)
```
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ version: '3.1'
services:
# reader 在线阅读
# 公开服务器(服务器位于日本):[https://reader.nxnow.top](https://reader.nxnow.top) 测试账号/密码分别为guest/guest123,也可自行创建账号添加书源,不定期删除长期未登录账号(2周)
# 阅读官方书源 : [https://legado.pages.dev](https://legado.pages.dev) 或者 [http://legado.git.llc](https://legado.pages.dev) 点击打开连接,添加远程书源即可
# 公众号汇总 : [https://mp.weixin.qq.com/s/5t8nfSnRfHjJNAvT76fA_A](https://mp.weixin.qq.com/s/5t8nfSnRfHjJNAvT76fA_A)
# 书源集合 : [https://legado.aoaostar.com/](https://legado.aoaostar.com/) 点击打开连接,添加远程书源即可
# 公众号汇总 : [https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MjM5MzMyMDgyMA==&action=getalbum&album_id=2397535253763801090#wechat_redirect](https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MjM5MzMyMDgyMA==&action=getalbum&album_id=2397535253763801090#wechat_redirect)
# 手动更新方式 : docker-compose pull && docker-compose up -d
reader:
image: hectorqin/reader
Expand Down
6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ version: '3.1'
services:
# reader 在线阅读
# 公开服务器(服务器位于日本):[https://reader.nxnow.top](https://reader.nxnow.top) 测试账号/密码分别为guest/guest123,也可自行创建账号添加书源,不定期删除长期未登录账号(2周)
# 阅读官方书源 : [https://legado.pages.dev](https://legado.pages.dev) 或者 [http://legado.git.llc](https://legado.pages.dev) 点击打开连接,添加远程书源即可
# 公众号汇总 : [https://mp.weixin.qq.com/s/5t8nfSnRfHjJNAvT76fA_A](https://mp.weixin.qq.com/s/5t8nfSnRfHjJNAvT76fA_A)
# 手动更新方式 : 在此文件所在的目录下执行 docker-compose pull && docker-compose up -d
# 书源集合 : [https://legado.aoaostar.com/](https://legado.aoaostar.com/) 点击打开连接,添加远程书源即可
# 公众号汇总 : [https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MjM5MzMyMDgyMA==&action=getalbum&album_id=2397535253763801090#wechat_redirect](https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MjM5MzMyMDgyMA==&action=getalbum&album_id=2397535253763801090#wechat_redirect)
# 手动更新方式 : docker-compose pull && docker-compose up -d
reader:
#image: hectorqin/reader # 普通镜像
image: hectorqin/reader:openj9-latest # Openj9镜像,arm64架构或小内存机器优先使用
Expand Down
12 changes: 10 additions & 2 deletions reader.sh
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ fi

install_dockercompose() {
if [[ x"${release}" == x"centos" ]]; then
yum install wget curl -y
yum install wget curl -y
echo -e "${green} 正在移除CentOS遗留无效Docker文件 ${plain}"
yum remove docker docker-client docker-client-latest docker-common docker-latest docker-latest-logrotate docker-logrotate docker-engine -y
echo -e "${green} 正在安装Docker ${plain}"
Expand All @@ -92,7 +92,15 @@ install_reader() {
rm docker-compose*
wget https://ghproxy.com/https://raw.githubusercontent.com/hectorqin/reader/master/docker-compose.yml
echo -e "${green} 正在配置默认书源 ${plain}"
wget https://legado.pages.dev/sy-yc.json -O storage/data/default/bookSource.json
wget https://jihulab.com/aoaostar/legado/-/raw/release/cache/6c35d84798ddbf4aad3fe3f0fd6cec53dd788be8.json -O storage/data/default/bookSource.json
# 判断是否合法json
local first_character=$(head -c 1 "storage/data/default/bookSource.json")
if [[ x"$first_character" == x"[" ]] then
#
else
echo -e "${red} 书源错误,已为您删除,请自行导入书源 ${plain}"
echo "[]" > storage/data/default/bookSource.json
fi
echo -e "${green} 正在配置docker变量 ${plain}"
sed -i "s/\/home\/reader/${file_dir}/" docker-compose.yml
sed -i "s/4396/${remotePort}/" docker-compose.yml
Expand Down

0 comments on commit 54fb3bd

Please sign in to comment.