# WebSSH

**Repository Path**: Looveh/web-ssh

## Basic Information

- **Project Name**: WebSSH
- **Description**: 纯AI生成的web-ssh客户端，Claude提供文档，Codex进行开发
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-11
- **Last Updated**: 2026-03-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WebSSH — Web 端 SSH 连接管理工具

WebSSH 提供基于浏览器的 SSH 终端与 SFTP 文件管理能力，支持多会话管理、审计日志、账号权限与一键部署。

## 快速启动（Docker Compose）

### 前置条件
- Docker 24+
- Docker Compose 2.20+

### 1 分钟启动
```bash
cp .env.example .env
# 编辑 .env，修改所有 change_me_* 的值
docker compose up -d --build
```

浏览器访问 `http://localhost`，首次进入注册账号即为管理员账号。

### 常用端口
- 前端：`HTTP_PORT`（默认 80）
- 后端：`BACKEND_PORT`（默认 8080）
- MySQL：`MYSQL_PORT`（默认 3307）
- Redis：`REDIS_HOST_PORT`（默认 6379）

## 开发环境

### 后端
```bash
cd webssh-backend
docker compose -f ../docker-compose.dev.yml up -d
mvn spring-boot:run -Dspring-boot.run.profiles=dev
```

### 前端
```bash
cd webssh-frontend
npm install
npm run dev
```
访问 `http://localhost:5173`

## 配置说明

核心环境变量示例见 `.env.example`：
- `MASTER_KEY`：凭证加密密钥（建议 Base64 32 字节）
- `JWT_PRIVATE_KEY`/`JWT_PUBLIC_KEY`：JWT RSA 公私钥（Base64 DER）
- `FRONTEND_URL`：后端允许的前端域名（CORS 白名单）

## 目录结构
- `webssh-backend/`：后端（Spring Boot）
- `webssh-frontend/`：前端（Vue 3 + Element Plus）
- `docker-compose.yml`：生产部署配置
- `docker-compose.dev.yml`：开发环境配置
- `docs/`：需求与任务文档

## 常见问题
1. 连接后端失败  
确认 `docker compose ps` 中服务健康，MySQL 与 Redis 为 `healthy`。

2. WebSocket 连接失败  
确认 Nginx 代理 `/ws/` 已正确配置，且浏览器地址为 HTTPS 时后端支持 WSS。

## License
MIT