🎪 Hajimi King 🏆

人人都是哈基米大王 👑，注意项目核心的核心是query.txt的表达式 ✨

📋 目录 🗂️

• 本地部署 🏠
• Docker部署 🐳
• 配置变量说明 ⚙️

---

🖥️ 本地部署 🚀

1. 环境准备 🔧

# 确保已安装Python
python --version

# 安装uv包管理器（如果未安装）
pip install uv

2. 项目设置 📁

# 克隆项目
git clone <repository-url>
cd hajimi-king

# 复制配置文件
cp env.example .env

# 复制查询文件
cp queries.example queries.txt

3. 配置环境变量 🔑

编辑 .env 文件，必须配置GitHub Token：

# 必填：GitHub访问令牌
GITHUB_TOKENS=ghp1,ghp2,ghp3

# 可选：其他配置保持默认值即可

💡 获取GitHub Token：访问 GitHub Settings > Tokens，创建具有 public_repo 权限的访问令牌 🎫

4. 安装依赖并运行 ⚡

# 安装项目依赖
uv pip install -r pyproject.toml

# 创建数据目录
mkdir -p data

# 运行程序
python app/hajimi_king.py

5. 本地运行管理 🎮

# 查看日志文件
tail -f data/keys/keys_valid_detail_*.log

# 查看找到的有效密钥
cat data/keys/keys_valid_*.txt

# 停止程序
Ctrl + C

---

🐳 Docker部署 🌊

1. 准备部署脚本 📜

# 将deploy.sh复制到父目录
cd ${deploy_directory}

git clone <repository-url>

cp hajimi-king/first_deploy.sh ./

# 或者直接下载项目到某个目录，确保目录结构如下：
# deploy_directory/
# ├── first_deploy.sh
# └── hajimi-king/
#     ├── app
#     └── ...

2. 一键部署 🚀

# 运行部署脚本
chmod +x first_deploy.sh

./first_deploy.sh

部署脚本会自动完成以下步骤：

1. ✅ 检查Docker环境 🔍
2. ✅ 创建data目录 📁
3. ✅ 复制配置文件（.env, queries.txt）📄
4. ✅ 交互式配置GitHub Token 🎛️
5. ✅ 构建Docker镜像 🏗️
6. ✅ 启动服务 🎉

3. Docker服务管理 🎛️

# 查看服务状态
docker-compose ps

# 查看实时日志
docker-compose logs -f

# 停止服务
docker-compose down

# 重启服务
docker-compose up -d

# 进入容器调试
docker-compose exec hajimi-king /bin/bash

4. 文件位置 🗺️

部署后的文件结构：

deploy_directory/
├── .env                    # 环境配置
├── docker-compose.yml      # Docker编排配置
├── data/                   # 数据目录
│   ├── queries.txt         # 搜索查询配置
│   ├── keys_valid_*.txt    # 发现的有效密钥
│   ├── keys_valid_detail_*.log  # 详细日志
│   └── scanned_shas.txt    # 已扫描文件记录
└── hajimi-king/            # 源码目录

---

⚙️ 配置变量说明 📖

以下是所有可配置的环境变量，在 .env 文件中设置：

🔴 必填配置 ⚠️

变量名	说明	示例值
GITHUB_TOKENS	GitHub API访问令牌，多个用逗号分隔 🎫	ghp_token1,ghp_token2

🟡 重要配置（建议了解）🤓

变量名	默认值	说明
DATA_PATH	./data	数据存储目录路径 📂
DATE_RANGE_DAYS	730	仓库年龄过滤（天数），只扫描指定天数内的仓库 📅
QUERIES_FILE	queries.txt	搜索查询配置文件路径（表达式严重影响搜索的高效性) 🎯
HAJIMI_CHECK_MODEL	gemini-2.5-flash	用于验证key有效的模型 🤖

🟢 可选配置（不懂就别动）😅

变量名	默认值	说明
PROXY	空	代理服务器地址，格式：http://proxy:port 🌐
VALID_KEY_DETAIL_PREFIX	logs/keys_valid_detail_	详细日志文件名前缀 📝
VALID_KEY_PREFIX	keys/keys_valid_	有效密钥文件名前缀 🗝️
RATE_LIMITED_KEY_PREFIX	keys/key_429_	频率限制密钥文件名前缀 ⏰
RATE_LIMITED_KEY_DETAIL_PREFIX	logs/key_429_detail_	频率限制详细日志文件名前缀 📊
SCANNED_SHAS_FILE	scanned_shas.txt	已扫描文件SHA记录文件名 📋
FILE_PATH_BLACKLIST	readme,docs,doc/,.md,example,sample,tutorial,test,spec,demo,mock	文件路径黑名单，逗号分隔 🚫

配置文件示例 💫

完整的 .env 文件示例：

# 必填配置
GITHUB_TOKENS=ghp_your_token_here_1,ghp_your_token_here_2

# 重要配置（可选修改）
DATA_PATH=./data
DATE_RANGE_DAYS=730
QUERIES_FILE=queries.txt
HAJIMI_CHECK_MODEL=gemini-2.5-flash-preview-05-20

# 高级配置（建议保持默认）
PROXY=
VALID_KEY_DETAIL_PREFIX=logs/keys_valid_detail_
VALID_KEY_PREFIX=keys/keys_valid_
RATE_LIMITED_KEY_PREFIX=keys/key_429_
RATE_LIMITED_KEY_DETAIL_PREFIX=logs/key_429_detail_
SCANNED_SHAS_FILE=scanned_shas.txt
FILE_PATH_BLACKLIST=readme,docs,doc/,.md,example,sample,tutorial,test,spec,demo,mock

查询配置文件 🔍

编辑 queries.txt 文件自定义搜索规则：

⚠️ 重要提醒：query 是本项目的核心！好的表达式可以让搜索更高效，需要发挥自己的想象力！🧠💡

# GitHub搜索查询配置文件
# 每行一个查询语句，支持GitHub搜索语法
# 以#开头的行为注释，空行会被忽略

# 基础搜索
AIzaSy in:file

📖 搜索语法参考：GitHub Code Search Syntax 📚
🎯 核心提示：创造性的查询表达式是成功的关键，多尝试不同的组合！

---

🔒 安全注意事项 🛡️

• ✅ GitHub Token权限最小化（只需public_repo读取权限）🔐
• ✅ 定期轮换GitHub Token 🔄
• ✅ 不要将真实的API密钥提交到版本控制 🙈
• ✅ 定期检查和清理发现的密钥文件 🧹
• ✅ 运行在安全的网络环境中 🏠

📞 故障排除 🩺

问题	解决方案
GitHub API限流 ⏰	添加更多GitHub Token或减少并发数 🔧
Docker构建失败 💥	检查网络连接，清理Docker缓存 🧽
找不到密钥 🔍	检查queries.txt配置，调整搜索关键词 🎯
容器启动失败 🚫	检查.env文件配置，确保GitHub Token有效 ✅

---

💖 享受使用 Hajimi King 的快乐时光！ 🎉✨🎊