WeTTY 项目使用教程

1. 项目的目录结构及介绍

WeTTY 项目的目录结构如下：

wetty/
├── bin/
│   └── wetty.js
├── public/
│   ├── css/
│   ├── js/
│   └── fonts/
├── src/
│   ├── client/
│   ├── server/
│   └── index.ts
├── test/
├── Dockerfile
├── package.json
├── README.md
└── tsconfig.json

• bin/: 包含项目的启动文件 wetty.js。
• public/: 包含静态资源文件，如 CSS、JavaScript 和字体文件。
• src/: 包含项目的源代码，分为客户端和服务器端。
• test/: 包含测试文件。
• Dockerfile: 用于构建 Docker 镜像。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/wetty.js。这个文件负责启动 WeTTY 服务器，并处理命令行参数。以下是启动文件的主要功能：

• 解析命令行参数。
• 加载配置文件。
• 启动 HTTP 或 HTTPS 服务器。
• 处理 WebSocket 连接。

3. 项目的配置文件介绍

WeTTY 的配置文件可以通过命令行参数 --conf 指定。如果没有指定配置文件，项目会使用默认配置。以下是一些常见的配置选项：

• --ssl-key: SSL 密钥文件的路径。
• --ssl-cert: SSL 证书文件的路径。
• --ssh-host: SSH 服务器的主机地址。
• --ssh-port: SSH 服务器的端口号。
• --ssh-user: SSH 用户名。

配置文件的示例：

{
  "sslKey": "path/to/ssl.key",
  "sslCert": "path/to/ssl.cert",
  "sshHost": "localhost",
  "sshPort": 22,
  "sshUser": "username"
}

通过这些配置选项，可以灵活地配置 WeTTY 服务器，以适应不同的使用场景。