# cursor-auto-register

**Repository Path**: greycode/cursor-auto-register

## Basic Information

- **Project Name**: cursor-auto-register
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: docker
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-30
- **Last Updated**: 2025-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Cursor Auto Register 本地开发指南

本项目是建在巨人肩膀上的一个开源项目，不做收费，仅供学习参考。
参考项目：

- [chengazhen/cursor-auto-free](https://github.com/chengazhen/cursor-auto-free)：Cursor Pro 自动化工具

- [cursor-account-api](https://github.com/Elawen-Carl/cursor-account-api)：Cursor Account API


## 环境要求
- Python 3.8+
- pip (Python包管理器)
- Docker & Docker Compose (可选，用于容器化部署)

## 部署方式

本项目支持两种部署方式：传统Python部署和Docker容器化部署。

### 方式一：传统Python部署

1. 安装 Python 依赖
```bash
pip install -r requirements.txt
```

2. 配置环境变量
- 按照 `config.py` 配置 `.env` 环境参数

3. 启动服务
```bash
uvicorn api:app --host 0.0.0.0 --port 8000
```

### 方式二：Docker容器化部署

1. 准备环境变量配置
```bash
cp .env.example .env
```
然后编辑.env文件，设置必要的配置参数

2. 构建和启动容器
```bash
docker-compose up -d
```

3. 查看服务状态
```bash
docker-compose ps
```

详细的Docker部署说明请参考 [DOCKER_DEPLOY.md](./DOCKER_DEPLOY.md)

## 使用说明

### 1. 环境变量配置：
在项目根目录创建 .env 文件：
```
# 多个域名使用逗号分隔
EMAIL_DOMAINS=xxx.xx

# 临时邮箱用户名
EMAIL_USERNAME=test
# 临时邮箱PIN码（如果需要）
EMAIL_PIN=

# 数据库URL
DATABASE_URL="sqlite+aiosqlite:///./accounts.db"

# ===== API服务配置 =====
# API服务监听主机地址，0.0.0.0 允许非本机访问
API_HOST="0.0.0.0"
# API服务端口号
API_PORT=8000
# 是否启用UI
ENABLE_UI=True
# 最大注册账号数量
MAX_ACCOUNTS=1

# windows用户部分安装时是自定义目录安装的，需要修改该配置
#CURSOR_PATH="D:\devtools\cursor"
```
### 参数特殊说明：

- EMAIL_DOMAINS：自己申请的邮箱，并已将DNS解析到cloudflare上了

- EMAIL_USERNAME： https://tempmail.plus/ 获取到的邮箱前缀，示例：ddcat

  需要 cloudflare 上配置转发，可以参考：https://blog.csdn.net/qq_50082325/article/details/144530594 

  把 Catch-all地址 都转发到 tempmail.plus 获取到的邮箱即可

  ![3](./images/3.jpg)



### 3. 数据持久化：

数据库文件会保存在 `accounts.db` 文件
日志文件会保存在容器内的 `api.log`
*注意事项：*
确保 `.env` 文件中的配置正确
数据目录 `accounts.db`需要适当的权限
容器内使用无头模式运行Chrome浏览器
API服务默认在8000端口运行

### 检查API服务是否正常运行
```
curl http://localhost:8000/health
```

## API 端点

- `GET /accounts` - 获取所有账号
- `GET /account/random` - 随机获取一个账号
- `POST /account` - 创建新账号

## 可视化页面
运行服务器后，访问：
- UI: http://localhost:8000/

  ![首页](./images/1.jpg)

  ![使用](./images/2.jpg)

## API 文档
运行服务器后，访问：
- Swagger UI: http://localhost:8000/docs
- ReDoc: http://localhost:8000/redoc

## 开发工具建议
- Cursor 或 PyCharm

## 调试提示
1. 查看日志
```bash
tail -f app.log
```


## 免责声明

本扩展仅供学习和测试使用. 使用本扩展可能违反 Cursor 的服务条款,
请自行承担使用风险.

您可以:

- ✅ 复制、分发本项目
- ✅ 修改、演绎本项目
- ✅ 私人使用

但必须遵循以下规则:

- 📝 署名 - 标明原作者及修改情况
- 🚫 非商业性使用 - 不得用于商业目的
- 🔄 相同方式共享 - 修改后的作品需使用相同的协议