# gitproxy

**Repository Path**: jxb1033/gitproxy

## Basic Information

- **Project Name**: gitproxy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AFL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-16
- **Last Updated**: 2025-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GitProxy

GitProxy 是一个简单的工具，用于通过 SSH SOCKS5 代理来加速 Git 操作。它特别适合在中国大陆访问 GitHub 等国外代码托管平台时使用。

## 功能特点

- 🔐 支持 SSH 密钥和密码两种认证方式
- ⚡ 自动配置 Git 代理设置
- 📝 保存常用配置，避免重复输入
- 🔌 可自定义代理端口（默认 1080）
- 🚀 提供速度测试功能
- 🛠️ 简单易用的命令行界面

## 系统要求

- macOS 或 Linux 系统
- Git
- SSH
- sshpass（用于密码登录功能）

## 安装

### 方法一：一键安装（推荐）
```bash
bash <(curl -fsSL https://gitee.com/jxb1033/gitproxy/raw/master/install_gitproxy.sh)
```

### 方法二：分步安装
1. 下载安装脚本：
```bash
curl -fsSL https://gitee.com/jxb1033/gitproxy/raw/master/install_gitproxy.sh -o install_gitproxy.sh
```

2. 运行安装脚本：
```bash
bash install_gitproxy.sh
```

3. 重新加载 shell 配置：
```bash
# 如果使用 bash
source ~/.bashrc

# 如果使用 zsh
source ~/.zshrc
```

## 使用方法

### 启动代理
```bash
gitproxy start
```
首次运行时会提示输入：
- 服务器 IP 地址
- 登录用户名
- 代理端口号（默认 1080）
- 认证方式（密钥/密码）
- 对应的认证信息

### 停止代理
```bash
gitproxy stop
```

### 查看代理状态
```bash
gitproxy status
```

### 测试连接速度
```bash
gitproxy test
```

### 清除保存的配置
```bash
gitproxy reset
```

### 卸载 GitProxy
```bash
gitproxy uninstall
```

## 注意事项

1. 请确保已安装 sshpass（用于密码登录功能）：
   - macOS: `brew install sshpass`
   - Ubuntu/Debian: `sudo apt-get install sshpass`
   - CentOS/RHEL: `sudo yum install sshpass`

2. 请不要使用 root 用户运行脚本

3. 配置信息会保存在 `~/.gitproxy_config` 文件中

4. 代理端口默认为 1080，可以在启动时自定义

## 常见问题

1. 如果遇到 "sshpass: command not found" 错误，请先安装 sshpass
2. 如果代理连接失败，请检查：
   - 服务器 IP 地址是否正确
   - 用户名和密码/密钥是否正确
   - 服务器是否允许 SSH 连接
   - 本地防火墙设置
   - 端口是否被占用

## 许可证

MIT License