Skip to content

Commit 2014ef3

Browse files
committed
Update readme and env/compose file.
1 parent 81b6255 commit 2014ef3

3 files changed

Lines changed: 19 additions & 31 deletions

File tree

.env.example

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@
44

55
# ─── 必需 ────────
66
# 管理后台 Bearer 令牌,必须修改为强密码(scripts/start.js 以 changeme 为标记自动初始化 .env)
7-
ADMIN_TOKEN=changeme
7+
ADMIN_TOKEN=test123
88

99
# ─── 常用可选 ────────
1010
# 服务监听端口,默认 5678(scripts/start.js 以 5678 为标记自动初始化 .env)
1111
PORT=5678
1212
# 数据目录,默认项目根 data/;Docker 中由 Dockerfile 设为 /app/data
1313
DATA_DIR=./data
1414
# 服务对外可达地址如 http://192.168.1.100:5678,Docker 部署建议填写;留空则自动检测局域网 IP
15-
BASE_URL=
15+
# BASE_URL=
1616
# 自动聚合 cron 表达式,留空禁用;有效格式如 "0 5 * * *" 每天 5 点;环境变量优先于网页配置
17-
CRON_SCHEDULE=0 5 * * *
17+
# CRON_SCHEDULE=
1818
# true/1/yes/on 开启 debug 日志,默认 false 仅 info/warn/error/security
19-
VERBOSE=false
19+
# VERBOSE=
2020
# 日志时间戳时区,默认跟随系统
2121
TZ=Asia/Shanghai
22-
# 设为 0 时关闭局域网主机校验,允许任意 host 智能响应——仅开发调试用,生产勿设 0
23-
DMZ=
2422

2523
# ─── 超时调优(毫秒,均有代码默认值,一般无须修改)────
2624
# 配置 URL 测速超时(config.ts DEFAULT_SPEED_TIMEOUT_MS)
@@ -30,11 +28,11 @@ SITE_TIMEOUT_MS=3000
3028
# fetch 配置 JSON 超时(config.ts DEFAULT_FETCH_TIMEOUT_MS,30s,部分源响应较慢)
3129
FETCH_TIMEOUT_MS=30000
3230
# 独立刷新接口令牌,一般留空
33-
REFRESH_TOKEN=
31+
#REFRESH_TOKEN=
3432

3533
# ─── 自动抓取(开发调试,非专业用户勿启用)────
36-
SCRAPE_SOURCE_URL=
37-
SCRAPE_SOURCE_REFERER=
38-
MACCMS_API_URL=
39-
MACCMS_AES_KEY=
40-
MACCMS_AES_IV=
34+
#SCRAPE_SOURCE_URL=
35+
#SCRAPE_SOURCE_REFERER=
36+
#MACCMS_API_URL=
37+
#MACCMS_AES_KEY=
38+
#MACCMS_AES_IV=

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,15 @@ docker compose up -d
3939
```
4040

4141
### 本地运行(仅供开发)
42+
前置依赖
43+
- Node.js 18+
4244

4345
```
46+
cp .env.example .env
4447
node scripts\start.js
4548
```
4649

47-
#### 环境要求
48-
49-
- Node.js 20+
50-
51-
#### 配置变量
52-
53-
使用模板文件
54-
55-
```
56-
cp .env.example .env
57-
```
5850

59-
- `ADMIN_TOKEN`:管理密码,建议更改,否则您可能会面临安全隐患
60-
- `PORT`:默认 `5678`
61-
- `BASE_URL`:服务对外可达地址,留空则自动检测局域网 IP。
62-
- `CRON_SCHEDULE`:自动聚合 cron 表达式,留空禁用。
63-
- `VERBOSE`:`true/1/yes/on` 开启 debug 日志。
6451

6552
## LICENSE
6653
MIT LICENSE

docker-compose.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ services:
77
volumes:
88
- ./data:/app/data
99
environment:
10-
- "ADMIN_TOKEN=test123" # 管理密码
11-
- "BASE_URL=" # Docker 部署建议填写,如 http://192.168.1.100:5678,不填则需要开启设置中的智能响应
12-
- "CRON_SCHEDULE=0 5 * * *" #预设自动聚合时间
10+
#
11+
# 使用 env 或手动在此设定,二选一
12+
#
13+
# - "ADMIN_TOKEN=test123" # 管理密码
14+
# - "BASE_URL=" # Docker 部署建议填写,如 http://192.168.1.100:5678,不填则需要开启设置中的智能响应
15+
# - "CRON_SCHEDULE=0 5 * * *" #预设自动聚合时间
1316

1417
# - REFRESH_TOKEN=${REFRESH_TOKEN:-} # 独立设置刷新接口访问令牌,一般不用
1518
#

0 commit comments

Comments
 (0)