chenu2/webssh

WebSSH-Go镜像说明

镜像概述

WebSSH-Go是一款基于Go语言开发的自托管多用户WebSSH客户端，可让用户通过现代浏览器管理和连接SSH服务器。它采用SQLite数据库持久化存储用户信息与连接配置，并对SSH密码、私钥等敏感凭据进行加密存储，保障数据安全。

核心功能

• Web端SSH终端：集成xterm.js终端，提供完整的SSH交互体验；
• 多用户支持：用户可注册并管理私人SSH连接，管理员可审批注册、管理用户权限；
• 持久化存储：用户数据与连接配置存储于SQLite数据库；
• 安全凭据加密：SSH密码、私钥等敏感信息静态加密；
• HTTPS/WSS支持：可通过TLS协议实现 secure 连接；
• 可选认证模式：支持无认证、单用户密码、多用户认证三种模式；
• 文件传输：通过SFTP上传文件、下载文件或压缩目录；
• Docker支持：提供docker-compose部署方案，支持amd64/arm64架构；

使用场景

1. 远程服务器管理：无需本地SSH客户端，通过浏览器即可快速连接并操作服务器；
2. 团队协作：团队成员可管理个人SSH连接，管理员统一管控用户权限；
3. 临时访问：在无本地SSH工具的环境下（如公共设备），通过浏览器安全访问服务器；
4. 安全管控：加密存储凭据，避免明文泄露风险，符合企业安全规范；

配置说明

环境变量

• WEBSSH_ADMIN_PASSWORD：多用户模式下管理员密码（默认值admin123）；
• WEBSSH_PASSWORD：单用户模式下默认用户密码（默认值default123）；
• WEBSSH_ENCRYPTION_KEY：必填项，32字节十六进制密钥（可通过openssl rand -hex 32生成），用于加密敏感信息；

命令行参数

• --no-auth：禁用认证模式（优先级高于单用户模式）；
• --single-user：启用单用户模式；
• --tls：启用HTTPS/WSS；
• --cert-file：TLS证书路径（启用tls时必填）；
• --key-file：TLS私钥路径（启用tls时必填）；
• --disable-download：禁用文件下载功能；
• --disable-file-browser：禁用文件浏览器功能；

Docker部署示例

快速启动

1. 克隆仓库：

bash
git clone https://github.com/chenyg0911/webssh-go.git
cd webssh-go

2. 修改docker-compose.yml：
   • 设置WEBSSH_ENCRYPTION_KEY（替换为openssl rand -hex 32生成的密钥）；
   • 可选设置WEBSSH_ADMIN_PASSWORD；
3. 启动服务：

bash
docker-compose up --build

4. 访问：http://localhost:8080，使用管理员账号（用户名admin）登录；

启用TLS

1. 创建certs目录并放入cert.pem和key.pem；
2. 修改docker-compose.yml：
   • 取消8443:8443端口映射注释；
   • 取消./certs:/app/certs卷映射注释；
   • 取消command部分注释并更新：

yaml
command: >
  ./webssh
  --tls
  --cert-file /app/certs/cert.pem
  --key-file /app/certs/key.pem

3. 重启服务：docker-compose up --build，访问https://localhost:8443；

许可证

本项目采用MIT许可证开源。 ===FULL_DESC===