Files
stock-scanner/README.md
2025-03-07 16:21:33 +08:00

77 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 股票分析系统 (Stock Analysis System)
## 简介
基于 https://github.com/DR-lin-eng/stock-scanner 二次修改,感谢原作者
## 功能变更
1. 增加html页面支持浏览器在线使用。
2. 增加港股、美股支持。
3. 完善Dockerfile、GitHub Actions 支持docker一键部署使用。
4. 支持x86_64 和 ARM64架构镜像
5. 支持流式输出支持前端传入Key(仅作为本地用户使用,日志等内容不会输出) 感谢@Cassianvale
6. 重构为Vue3+Vite+TS+Naive UI支持响应式布局
7. 支持GitHub Actions 一键部署
## docker一键部署
```
docker run -d \
--name stock-scanner \
-p 8888:8888 \
-e API_KEY=替换为你的key \
-e API_URL=替换为你的api地址 \
-e API_MODEL=替换为你的模型 \
-e API_TIMEOUT=60 \
-e LOGIN_PASSWORD=替换为你的密码 \
lanzhihong/stock-scanner:latest
API_TIMEOUT=60 202503040712版本开始 (AI分析发生错误查看日志是否有timed out类似错误需要增加你的API超时时间)
LOGIN_PASSWORD 为空时,表示不需要登录,否则需要经过登录接口验证
注意⚠️: 环境变量名变更,更新版本后需要调整!!!
针对API_URL处理兼容更多的api地址规则与Cherry Studio一致 /结尾忽略v1版本#结尾强制使用输入地址。
API_URL 处理逻辑说明:
1. 当 API_URL 以 / 结尾时直接追加 chat/completions保留原有版本号
示例:
输入: https://ark.cn-beijing.volces.com/api/v3/
输出: https://ark.cn-beijing.volces.com/api/v3/chat/completions
2. 当 API_URL 以 # 结尾时强制使用当前链接:
示例:
输入: https://ark.cn-beijing.volces.com/api/v3/chat/completions#
输出: https://ark.cn-beijing.volces.com/api/v3/chat/completions
3. 当 API_URL 不以 / 结尾时使用默认版本号 v1
示例:
输入: https://ark.cn-beijing.volces.com/api
输出: https://ark.cn-beijing.volces.com/api/v1/chat/completions
```
默认8888端口部署完成后访问 http://127.0.0.1:8888 即可使用。
## Github Actions 部署
| 环境变量 | 说明 |
| --- | --- |
| DOCKERHUB_USERNAME | Docker Hub用户名 |
| DOCKERHUB_TOKEN | Docker Hub访问令牌 |
| SERVER_HOST | 部署服务器地址 |
| SERVER_USERNAME | 服务器用户名 |
| SSH_PRIVATE_KEY | SSH私钥 |
| DEPLOY_PATH | 部署路径 |
| SLACK_WEBHOOK | Slack通知Webhook可选 |
## 注意事项 (Notes)
- 股票分析仅供参考,不构成投资建议
- 使用前请确保网络连接正常
- 建议在实盘前充分测试
## 贡献 (Contributing)
欢迎提交 issues 和 pull requests
## 许可证 (License)
[待添加具体许可证信息]
## 免责声明 (Disclaimer)
本系统仅用于学习和研究目的,投资有风险,入市需谨慎。