Files
ssh-manager/README.md
2026-04-17 17:53:06 +08:00

106 lines
1.7 KiB
Markdown

# SSH 管理器部署说明
这是一份直接给客户使用的部署文档。
你只需要按下面步骤启动,不需要看开发文档。
## 先准备
- Docker
- Docker Compose
## 启动
在项目根目录执行:
```bash
docker compose -f docker/docker-compose.yml up -d --build
```
启动后访问:
`http://localhost:48080`
## 默认登录账号
- 用户名:`admin`
- 密码:`admin123`
首次登录后请先修改密码。
## 这个版本能做什么
- SSH 终端
- SFTP 文件管理
- 批量命令执行
- 连接和会话树备份恢复
- 历史日志与传输记录
## 常用命令
启动:
```bash
docker compose -f docker/docker-compose.yml up -d --build
```
查看日志:
```bash
docker compose -f docker/docker-compose.yml logs -f
```
停止:
```bash
docker compose -f docker/docker-compose.yml down
```
查看状态:
```bash
docker compose -f docker/docker-compose.yml ps
```
如果你的环境已经安装了 `make`,也可以选用:
```bash
make up
make logs
make down
```
## 数据说明
数据默认保存在 Docker 命名卷 `app-data` 里。
平时停止服务请使用:
```bash
docker compose -f docker/docker-compose.yml down
```
不要执行:
```bash
docker compose -f docker/docker-compose.yml down -v
```
因为这会把数据一起删除。
## 遇到问题先检查
1. Docker 是否正常启动
2. 端口 `48080` 是否被占用
3. 执行 `docker compose -f docker/docker-compose.yml logs -f` 查看报错
4. 确认浏览器访问的是 `http://localhost:48080`
## 建议启动后检查一遍
1. 能正常登录并修改密码
2. 能创建一条连接
3. 能打开终端
4. 能打开 SFTP
5. 能执行一次批量命令
6. 能导出一次备份