Skip to content

Commit e776f4f

Browse files
authored
Merge pull request hectorqin#47 from NZESupB/master
修改文档,docker-compose增加2.0参数
2 parents 78d38cd + 3715e4b commit e776f4f

File tree

2 files changed

+77
-18
lines changed

2 files changed

+77
-18
lines changed

doc.md

+64-7
Original file line numberDiff line numberDiff line change
@@ -238,32 +238,89 @@ java -jar reader-$version.jar --reader.app.secure=true --reader.app.secureKey=
238238

239239
# 使用预编译的镜像
240240

241-
# 自用版
241+
# 自用版(建议修改映射端口)
242242
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
243243

244-
# 多用户版
244+
# 多用户版(建议修改映射端口)
245245
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=注册邀请码
246246

247-
# 多用户版 使用环境变量
247+
# 多用户版 使用环境变量(建议修改映射端口)
248248
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
249249

250250
# 更新docker镜像
251251
# docker pull hectorqin/reader
252252

253+
#:后面的端口修改为映射端口
253254
# web端 http://localhost:8080/
254255
# 接口地址 http://localhost:8080/reader3/
256+
```
255257

256-
# 使用docker-compose
257-
# 创建 /home/reader 目录,也可使用其他目录,更换目录需要编辑 docker-compose.yaml 里面的挂载目录 volumes
258-
# 下载项目里的 docker-compose.yaml 到 /home/reader 目录
259-
# 按照 docker-compose.yaml 里面的注释编辑相关配置
258+
### Docker-Compose版(推荐)
259+
260+
```bash
261+
#安装docker-compose
262+
#Debian/Ubuntu
263+
apt install docker-compose -y
264+
#CentOS
265+
curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
266+
chmod +x /usr/local/bin/docker-compose
267+
docker-compose --version
268+
269+
# 下载项目里的 docker-compose.yaml
270+
wget https://raw.githubusercontent.com/hectorqin/reader/master/docker-compose.yaml
271+
# 更具 docker-compose.yaml 里面的注释编辑所需配置
260272
# 启动 docker-compose
261273
docker-compose up -d
262274

263275
# 停止 docker-compose
264276
docker-compose stop
265277
```
266278

279+
## Nginx反向代理
280+
281+
```nginx
282+
server {
283+
listen 80;
284+
server_name 域名;
285+
#开启ssl解除注释
286+
#不使用宝塔获取证书脚本 https://github.com/Misaka-blog/acme-1key
287+
#listen 443 ssl;
288+
#ssl_certificate 证书.cer;
289+
#ssl_certificate_key 证书.key;
290+
#ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3;
291+
#ssl_ciphers EECDH+CHACHA20:EECDH+CHACHA20-draft:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5;
292+
#ssl_prefer_server_ciphers on;
293+
#ssl_session_cache shared:SSL:10m;
294+
#ssl_session_timeout 10m;
295+
#if ($server_port !~ 443){
296+
# rewrite ^(/.*)$ https://$host$1 permanent;
297+
#}
298+
#error_page 497 https://$host$request_uri;
299+
300+
gzip on; #开启gzip压缩
301+
gzip_min_length 1k; #设置对数据启用压缩的最少字节数
302+
gzip_buffers 4 16k;
303+
gzip_http_version 1.0;
304+
gzip_comp_level 6; #设置数据的压缩等级,等级为1-9,压缩比从小到大
305+
gzip_types text/plain text/css text/javascript application/json application/javascript application/x-javascript application/xml; #设置需要压缩的数据格式
306+
gzip_vary on;
307+
308+
location / {
309+
proxy_pass http://127.0.0.1:4396; #端口自行修改为映射端口
310+
proxy_http_version 1.1;
311+
proxy_cache_bypass $http_upgrade;
312+
proxy_set_header Upgrade $http_upgrade;
313+
proxy_set_header Connection "upgrade";
314+
proxy_set_header Host $host;
315+
proxy_set_header X-Real-IP $remote_addr;
316+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
317+
proxy_set_header X-Forwarded-Proto $scheme;
318+
proxy_set_header X-Forwarded-Host $host;
319+
proxy_set_header X-Forwarded-Port $server_port;
320+
}
321+
}
322+
```
323+
267324
## 开发编译
268325

269326
### 编译脚本

docker-compose.yaml

+13-11
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ version: '3.1'
22
services:
33

44
# reader 在线阅读
5-
# 作者GitHub : https://github.com/hectorqin/reader
6-
# 本人在线演示(服务器位于日本) : https://reader.nxnow.online ,账号/密码分别为guest/guest123,也可自行创建账号添加书源
7-
# 书源参考 : https://github.com/NZESupB/ReadSource ,书源合集下选一个合集进入网页后, Ctrl+S 保存至本地后导入网站即可
5+
# 本人在线演示(服务器位于日本) : https://reader.nxnow.online(此域名7月过期)更换为 https://read.nxnow.top
6+
# 在线演示测试账号/密码分别为guest/guest123,也可自行创建账号添加书源
7+
# 书源参考 : https://github.com/NZESupB/ReadSource,书源合集下选一个合集进入网页后, Ctrl+S 保存至本地后导入网站即可,或者点击远程书源,将链接导入即可
88

99
#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
1010
# 多用户版
@@ -24,21 +24,23 @@ services:
2424
# - /home/reader/storage:/storage
2525
# environment:
2626
# - SPRING_PROFILES_ACTIVE=prod
27+
# - READER_APP_CACHECHAPTERCONTENT=true #是否开启缓存章节内容 V2.0
2728
# 多用户版
2829
read_all:
2930
image: hectorqin/reader
30-
container_name: reader # 容器名 可自行修改
31+
container_name: reader #容器名 可自行修改
3132
restart: always
3233
ports:
33-
- 4396:8080 # 4396端口映射可自行修改
34+
- 4396:8080 #4396端口映射可自行修改
3435
volumes:
35-
- /home/reader/logs:/logs # logs映射目录 /home/reader/logs 可自行修改
36-
- /home/reader/storage:/storage # 数据映射目录 /home/reader/storage 可自行修改
36+
- /home/reader/logs:/logs #log映射目录 /home/reader/logs 映射目录可自行修改
37+
- /home/reader/storage:/storage #数据映射目录 /home/reader/storage 映射目录可自行修改
3738
environment:
3839
- SPRING_PROFILES_ACTIVE=prod
39-
- READER_APP_SECURE=true
40-
- READER_APP_SECUREKEY= password # 管理员密码 可自行修改
41-
# - READER_APP_INVITECODE=123456 # 注册邀请码,如需要取消注释 可自行修改
40+
- READER_APP_SECURE=true #开启登录鉴权,开启后将支持多用户模式
41+
- READER_APP_CACHECHAPTERCONTENT=true #是否开启缓存章节内容 V2.0
42+
- READER_APP_SECUREKEY=adminpwd #管理员密码 可自行修改
43+
#- READER_APP_INVITECODE=registercode #注册邀请码,如需要取消注释 可自行修改
4244
# 自动更新docker
4345
watchtower:
4446
image: containrrr/watchtower
@@ -50,6 +52,6 @@ services:
5052
volumes:
5153
- /var/run/docker.sock:/var/run/docker.sock
5254
command: reader watchtower --cleanup --schedule "0 0 4 * * *"
53-
# 仅更新reader与watchtower容器,如需其他自行添加容器名,如:reader watchtower redis
55+
# 仅更新reader与watchtower容器,如需其他自行添加 '容器名' ,如:reader watchtower redis
5456
# --cleanup 更新后清理旧版本镜像
5557
# --schedule 自动检测更新 crontab定时(限定6位crontab) 此处代表凌晨4点整

0 commit comments

Comments
 (0)