Skip to content

Commit 0cb24d5

Browse files
author
tosaki
committed
docs: Add instructions for running the application from a pre-built Docker image to the READMEs.
1 parent ac0df26 commit 0cb24d5

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

README-en.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,23 @@ Instead of simple keyword matching, it leverages Large Language Models (LLMs) to
4343
```
4444
Edit `.env` and fill in your OpenAI API Key and other settings.
4545

46-
3. **Build & Run**
46+
3. **Run**
47+
You can use the pre-built Docker image directly:
48+
```bash
49+
# Pull image
50+
docker pull ghcr.io/t0saki/ai-news-dashboard:latest
51+
52+
# Run
53+
docker run -d \
54+
--name news-dashboard \
55+
--env-file .env \
56+
-v $(pwd)/news.db:/app/news.db \
57+
-v $(pwd)/dashboard.json:/app/dashboard.json \
58+
-v $(pwd)/top5.json:/app/top5.json \
59+
ghcr.io/t0saki/ai-news-dashboard:latest
60+
```
61+
62+
Or you can build it yourself:
4763
```bash
4864
docker build -t news-dashboard .
4965
docker run -d --env-file .env -v $(pwd)/news.db:/app/news.db -v $(pwd)/dashboard.json:/app/dashboard.json -v $(pwd)/top5.json:/app/top5.json news-dashboard

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,23 @@
4444
```
4545
编辑 `.env` 文件,填入你的 OpenAI API Key 和其他配置。
4646

47-
3. **构建并运行**
47+
3. **运行**
48+
可以直接使用预构建的 Docker 镜像:
49+
```bash
50+
# 拉取镜像
51+
docker pull ghcr.io/t0saki/ai-news-dashboard:latest
52+
53+
# 运行
54+
docker run -d \
55+
--name news-dashboard \
56+
--env-file .env \
57+
-v $(pwd)/news.db:/app/news.db \
58+
-v $(pwd)/dashboard.json:/app/dashboard.json \
59+
-v $(pwd)/top5.json:/app/top5.json \
60+
ghcr.io/t0saki/ai-news-dashboard:latest
61+
```
62+
63+
或者你也可以选择自己构建:
4864
```bash
4965
docker build -t news-dashboard .
5066
docker run -d --env-file .env -v $(pwd)/news.db:/app/news.db -v $(pwd)/dashboard.json:/app/dashboard.json -v $(pwd)/top5.json:/app/top5.json news-dashboard

0 commit comments

Comments
 (0)