Files
auto_cursor/SETUP_README.md
2025-04-02 10:15:41 +08:00

137 lines
3.6 KiB
Markdown
Raw Permalink 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.

# Cursor自动化服务 - 环境设置向导
这个交互式设置向导(`setup_environment.py`)用于在新服务器上快速配置Cursor自动化服务环境包括安装依赖、配置数据库和Redis、创建必要的表结构。
## 功能特点
1. **全自动化配置**
- 自动检测并安装必要的Python依赖
- 交互式配置MySQL和Redis
- 自动创建数据库和用户
- 创建必要的表结构
- 更新配置文件
2. **智能默认值**
- 使用主机名作为默认服务器标识
- 识别现有配置并提供作为默认值
- 为重要参数提供安全的建议值
3. **连接性测试**
- 验证MySQL连接是否可用
- 测试Redis连接
- 提供详细的错误反馈
## 使用方法
### 步骤1: 准备环境
确保服务器上已安装:
- Python 3.7+
- MySQL/MariaDB
- Redis (可选)
### 步骤2: 运行设置向导
```bash
python setup_environment.py
```
### 步骤3: 按照提示完成配置
设置向导将引导您完成以下步骤:
1. **检查并安装依赖**
- 自动安装必要的Python包
2. **配置服务器标识**
- 设置唯一的服务器标识用于API调用
3. **配置MySQL数据库**
- 输入MySQL服务器信息
- 提供MySQL root用户信息(用于创建数据库和用户)
- 设置应用程序数据库和用户
4. **配置Redis缓存(可选)**
- 选择是否使用Redis缓存
- 配置Redis连接信息
5. **创建数据库和用户**
- 自动创建数据库
- 创建应用用户并设置权限
6. **创建表结构**
- 创建email_accounts表
- 创建system_settings表
7. **更新配置文件**
- 备份现有配置
- 写入新配置到config.yaml
## 配置选项说明
### 服务器标识
服务器标识是一个唯一的名称用于在API调用中标识当前服务器。默认使用系统主机名。
### MySQL配置
- **主机地址**: MySQL服务器地址默认为`localhost`
- **端口**: MySQL服务端口默认为`3306`
- **数据库名**: 应用程序使用的数据库名,默认为`auto_cursor_reg`
- **应用用户名**: 应用程序使用的数据库用户,默认为`auto_cursor_reg`
- **应用用户密码**: 默认生成一个安全的随机密码
### Redis配置
- **是否启用**: 是否使用Redis缓存
- **主机地址**: Redis服务器地址默认为`127.0.0.1`
- **端口**: Redis服务端口默认为`6379`
- **密码**: Redis认证密码(如果设置了)
- **数据库索引**: Redis数据库索引默认为`0`
## 安全注意事项
- 本脚本需要MySQL root权限来创建数据库和用户
- 数据库密码会以明文保存在配置文件中
- 脚本会自动备份现有配置文件,以`.bak`扩展名保存
## 常见问题
1. **无法连接到MySQL**
- 确认MySQL服务已启动
- 验证root密码是否正确
- 检查防火墙设置
2. **无法连接到Redis**
- 确认Redis服务已启动
- 验证Redis密码是否正确
- 如不需要Redis可选择禁用
3. **权限问题**
- 确保使用的用户有创建数据库和用户的权限
4. **配置文件备份**
- 脚本会自动备份原始配置文件为`config.yaml.bak.[时间戳]`
## 完成后的步骤
设置完成后,您可以:
1. 导入邮箱账号:
```bash
python import_emails.py
```
2. 启动自动服务:
```bash
python start.py
```
3. 或直接启动自动化服务:
```bash
python auto_cursor_service.py
```
## 服务器系统要求
- **操作系统**: 支持Linux、Windows、macOS
- **内存**: 至少2GB RAM
- **存储**: 至少1GB可用空间
- **网络**: 稳定的互联网连接