Merge pull request hectorqin#47 from NZESupB/master

修改文档,docker-compose增加2.0参数

Author: hectorqin

doc.md

@@ -238,32 +238,89 @@ java -jar reader-$version.jar --reader.app.secure=true --reader.app.secureKey=
 
 # 使用预编译的镜像
 
-# 自用版
+# 自用版(建议修改映射端口)
 docker run -d --restart=always --name=reader -e "SPRING_PROFILES_ACTIVE=prod" -v $(pwd)/logs:/logs -v $(pwd)/storage:/storage -p 8080:8080 hectorqin/reader
 
-# 多用户版
+# 多用户版(建议修改映射端口)
 docker run -d --restart=always --name=reader -v $(pwd)/logs:/logs -v $(pwd)/storage:/storage -p 8080:8080 hectorqin/reader java -jar /app/bin/reader.jar --spring.profiles.active=prod --reader.app.secure=true --reader.app.secureKey=管理密码 --reader.app.inviteCode=注册邀请码
 
-# 多用户版 使用环境变量
+# 多用户版 使用环境变量(建议修改映射端口)
 docker run -d --restart=always --name=reader -e "SPRING_PROFILES_ACTIVE=prod" -e "READER_APP_SECURE=true" -e "READER_APP_SECUREKEY=管理密码" -e "READER_APP_INVITECODE=注册邀请码" -v $(pwd)/logs:/logs -v $(pwd)/storage:/storage -p 8080:8080 hectorqin/reader
 
 # 更新docker镜像
 # docker pull hectorqin/reader
 
+#:后面的端口修改为映射端口
 # web端 http://localhost:8080/
 # 接口地址 http://localhost:8080/reader3/
+```
 
-# 使用docker-compose
-# 创建 /home/reader 目录，也可使用其他目录，更换目录需要编辑 docker-compose.yaml 里面的挂载目录 volumes
-# 下载项目里的 docker-compose.yaml 到 /home/reader 目录
-# 按照 docker-compose.yaml 里面的注释编辑相关配置
+### Docker-Compose版(推荐)
+
+```bash
+#安装docker-compose
+#Debian/Ubuntu
+apt install docker-compose -y
+#CentOS
+curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+chmod +x /usr/local/bin/docker-compose
+docker-compose --version
+
+# 下载项目里的 docker-compose.yaml
+wget https://raw.githubusercontent.com/hectorqin/reader/master/docker-compose.yaml
+# 更具 docker-compose.yaml 里面的注释编辑所需配置
 # 启动 docker-compose
 docker-compose up -d
 
 # 停止 docker-compose
 docker-compose stop
 ```
 
+## Nginx反向代理
+
+```nginx
+server {
+    listen 80;
+    server_name 域名;
+    #开启ssl解除注释
+    #不使用宝塔获取证书脚本  https://github.com/Misaka-blog/acme-1key  
+    #listen 443 ssl;
+    #ssl_certificate 证书.cer;
+    #ssl_certificate_key 证书.key;
+    #ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3;
+    #ssl_ciphers EECDH+CHACHA20:EECDH+CHACHA20-draft:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5;
+    #ssl_prefer_server_ciphers on;
+    #ssl_session_cache shared:SSL:10m;
+    #ssl_session_timeout 10m;
+    #if ($server_port !~ 443){
+    #    rewrite ^(/.*)$ https://$host$1 permanent;
+    #}
+    #error_page 497  https://$host$request_uri;
+
+    gzip on; #开启gzip压缩
+    gzip_min_length 1k; #设置对数据启用压缩的最少字节数
+    gzip_buffers 4 16k;
+    gzip_http_version 1.0;
+    gzip_comp_level 6; #设置数据的压缩等级,等级为1-9，压缩比从小到大
+    gzip_types text/plain text/css text/javascript application/json application/javascript application/x-javascript application/xml; #设置需要压缩的数据格式
+    gzip_vary on;
+    
+    location / {
+        proxy_pass  http://127.0.0.1:4396; #端口自行修改为映射端口
+        proxy_http_version	1.1;
+        proxy_cache_bypass	$http_upgrade;
+        proxy_set_header Upgrade           $http_upgrade;
+        proxy_set_header Connection        "upgrade";
+        proxy_set_header Host              $host;
+        proxy_set_header X-Real-IP         $remote_addr;
+        proxy_set_header X-Forwarded-For   $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header X-Forwarded-Host  $host;
+        proxy_set_header X-Forwarded-Port  $server_port;
+    }
+}
+```
+
 ## 开发编译
 
 ### 编译脚本

docker-compose.yaml

@@ -2,9 +2,9 @@ version: '3.1'
 services:
 
 # reader 在线阅读
-# 作者GitHub : https://github.com/hectorqin/reader
-# 本人在线演示(服务器位于日本) : https://reader.nxnow.online ,账号/密码分别为guest/guest123,也可自行创建账号添加书源
-# 书源参考 : https://github.com/NZESupB/ReadSource ,书源合集下选一个合集进入网页后, Ctrl+S 保存至本地后导入网站即可
+# 本人在线演示(服务器位于日本) : https://reader.nxnow.online(此域名7月过期)更换为 https://read.nxnow.top
+# 在线演示测试账号/密码分别为guest/guest123,也可自行创建账号添加书源
+# 书源参考 : https://github.com/NZESupB/ReadSource,书源合集下选一个合集进入网页后, Ctrl+S 保存至本地后导入网站即可,或者点击远程书源,将链接导入即可
 
 #docker run -d --restart=always --name=reader -e "SPRING_PROFILES_ACTIVE=prod" -v $(pwd)/logs:/logs -v $(pwd)/storage:/storage -p 8080:8080 hectorqin/reader
 # 多用户版
@@ -24,21 +24,23 @@ services:
 #      - /home/reader/storage:/storage
 #    environment:
 #      - SPRING_PROFILES_ACTIVE=prod
+#      - READER_APP_CACHECHAPTERCONTENT=true #是否开启缓存章节内容 V2.0
 # 多用户版
   read_all:
     image: hectorqin/reader
-    container_name: reader # 容器名 可自行修改
+    container_name: reader #容器名 可自行修改
     restart: always
     ports:
-      - 4396:8080 # 4396端口映射可自行修改
+      - 4396:8080 #4396端口映射可自行修改
     volumes:
-      - /home/reader/logs:/logs # logs映射目录 /home/reader/logs 可自行修改
-      - /home/reader/storage:/storage # 数据映射目录 /home/reader/storage 可自行修改
+      - /home/reader/logs:/logs #log映射目录 /home/reader/logs 映射目录可自行修改
+      - /home/reader/storage:/storage #数据映射目录 /home/reader/storage 映射目录可自行修改
     environment:
       - SPRING_PROFILES_ACTIVE=prod
-      - READER_APP_SECURE=true
-      - READER_APP_SECUREKEY= password  # 管理员密码  可自行修改
-      # - READER_APP_INVITECODE=123456 # 注册邀请码,如需要取消注释 可自行修改
+      - READER_APP_SECURE=true #开启登录鉴权，开启后将支持多用户模式
+      - READER_APP_CACHECHAPTERCONTENT=true #是否开启缓存章节内容 V2.0
+      - READER_APP_SECUREKEY=adminpwd  #管理员密码  可自行修改
+      #- READER_APP_INVITECODE=registercode #注册邀请码,如需要取消注释 可自行修改
 # 自动更新docker
   watchtower:
     image: containrrr/watchtower
@@ -50,6 +52,6 @@ services:
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
     command: reader watchtower --cleanup --schedule "0 0 4 * * *"
-    # 仅更新reader与watchtower容器,如需其他自行添加容器名,如:reader watchtower redis
+    # 仅更新reader与watchtower容器,如需其他自行添加 '容器名' ,如:reader watchtower redis
     # --cleanup 更新后清理旧版本镜像
     # --schedule 自动检测更新 crontab定时(限定6位crontab) 此处代表凌晨4点整