Platypus 项目安装与使用教程

1. 项目目录结构及介绍

Platypus 项目的目录结构如下：

Platypus/
├── assets/
├── cmd/
├── deployments/
├── internal/
├── web/
├── .dockerignore
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── Vagrantfile
├── go.mod
├── go.sum

目录介绍：

• assets/: 存放项目所需的静态资源文件。
• cmd/: 存放项目的命令行工具和入口文件。
• deployments/: 存放项目的部署配置文件。
• internal/: 存放项目的内部实现代码。
• web/: 存放项目的Web界面相关代码。
• .dockerignore: Docker构建时忽略的文件列表。
• .gitignore: Git版本控制时忽略的文件列表。
• LICENSE: 项目的开源许可证文件。
• Makefile: 项目的构建和安装脚本。
• README.md: 项目的介绍和使用说明文档。
• Vagrantfile: Vagrant虚拟机配置文件。
• go.mod: Go模块依赖管理文件。
• go.sum: Go模块依赖的校验和文件。

2. 项目启动文件介绍

Platypus 项目的启动文件主要位于 cmd/ 目录下。以下是主要的启动文件：

• cmd/main.go: 这是 Platypus 项目的主入口文件，负责初始化并启动 Platypus 服务。

启动方式：

1. 从源代码启动:

   git clone https://github.com/WangYihang/Platypus.git
   cd Platypus
   sudo apt install -y make curl
   make install_dependency
   make release
   

2. 使用 Docker Compose 启动:

   docker-compose up -d
   

3. 从二进制文件启动:

   • 下载 Platypus 的预编译二进制文件。
   • 运行下载的二进制文件。

3. 项目配置文件介绍

Platypus 项目的配置文件主要位于项目的根目录下，名为 config.yml。以下是配置文件的主要内容：

servers:
  - host: "0.0.0.0"
    port: 13337
    hashFormat: "%i %u %m %o"
  - host: "0.0.0.0"
    port: 13338
    hashFormat: "%i %u %m %o %t"

restful:
  host: "127.0.0.1"
  port: 7331
  enable: true
  update: false

配置项介绍：

• servers: 定义 Platypus 监听的服务器配置。
  • host: 监听的主机地址。
  • port: 监听的端口号。
  • hashFormat: 用于唯一标识客户端的格式化字符串。
• restful: 定义 Platypus 的 RESTful API 配置。
  • host: RESTful API 服务的主机地址。
  • port: RESTful API 服务的端口号。
  • enable: 是否启用 RESTful API 服务。
  • update: 是否在启动时检查更新。

通过以上配置，Platypus 可以监听多个端口，并提供 RESTful API 接口，方便用户管理和操作反向Shell会话。