关于 ChessFEN
ChessFEN 是一个可自托管的轻量工具:从棋盘图片识别局面、浏览 PGN 对局并导出完整 FEN、把任意棋子摆放段或完整 FEN 渲染成棋盘图片。它只依赖 CPU,以单个 Docker 镜像发布,并通过网页界面与 API 提供同样能力。
给项目点星
如果 ChessFEN 对你有用,GitHub 上的一个 star 能帮助更多人发现它。
自部署
发布镜像已发布到 GHCR(ghcr.io/sidnelyzhang/chessfen)与 Docker Hub(<DOCKERHUB_USERNAME>/chessfen),识别模型已内置。若 GHCR 包仍为私有,请先执行 docker login ghcr.io。用 Docker 运行:
docker run -d --name chessfen -p 127.0.0.1:8000:8000 \
-e ADMIN_PASSWORD='replace-with-a-strong-password' \
-e SECRET_KEY='replace-with-a-long-random-secret' \
-v chessfen-data:/data \
ghcr.io/sidnelyzhang/chessfen:latest
仓库还提供面向已发布镜像的 docker-compose.yml:把 .env.example 复制为 .env 并设置 ADMIN_PASSWORD 与 SECRET_KEY,然后运行 docker compose up -d;使用 docker-compose.build.yml 可改为源码构建。
然后打开 http://localhost:8000,在管理页创建 API 密钥。容器只提供 HTTP:请把端口只暴露给你的反向代理,并把 FORWARDED_ALLOW_IPS 设为代理地址,以便限流识别真实客户端 IP;把 DATABASE_URL 指向 PostgreSQL 即可替代 SQLite 卷。
致谢
- 棋盘识别: 2d-chess-ocr 由 Andrew Spano 开发(YOLO26m 微调检测器)。
- 棋子图片:CBurnett 棋子集,由 python-chess 渲染(CC-BY-SA 3.0)。
- 许可:ChessFEN 以 GPL-3.0-or-later 许可证发布。