Kcptun Installer 项目使用文档

Kcptun Installer 项目使用文档

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

Kcptun Installer 项目的目录结构如下：

kcptun_installer/
├── README.md
├── install.sh
├── uninstall.sh
├── config.json
└── scripts/
    ├── setup.sh
    └── utils.sh

目录结构介绍

• README.md: 项目说明文档，包含项目的基本信息和使用指南。
• install.sh: 安装脚本，用于安装 Kcptun 服务。
• uninstall.sh: 卸载脚本，用于卸载 Kcptun 服务。
• config.json: 配置文件，包含 Kcptun 服务的配置参数。
• scripts/: 包含辅助脚本的目录。
  • setup.sh: 设置脚本，用于配置环境。
  • utils.sh: 工具脚本，包含一些常用工具函数。

2. 项目的启动文件介绍

install.sh

install.sh 是 Kcptun 的安装脚本，主要功能如下：

• 检查系统环境。
• 下载 Kcptun 二进制文件。
• 配置 Kcptun 服务。
• 启动 Kcptun 服务。

uninstall.sh

uninstall.sh 是 Kcptun 的卸载脚本，主要功能如下：

• 停止 Kcptun 服务。
• 删除 Kcptun 二进制文件。
• 清理配置文件。

3. 项目的配置文件介绍

config.json

config.json 是 Kcptun 的配置文件，包含以下主要参数：

{
  "server_addr": "127.0.0.1",
  "server_port": 29900,
  "key": "your_password",
  "crypt": "aes",
  "mode": "fast",
  "mtu": 1350,
  "sndwnd": 1024,
  "rcvwnd": 1024,
  "datashard": 10,
  "parityshard": 3,
  "dscp": 46,
  "nocomp": false,
  "acknodelay": false,
  "nodelay": 0,
  "interval": 40,
  "resend": 0,
  "nc": 0,
  "sockbuf": 4194304,
  "keepalive": 10
}

配置参数介绍

• server_addr: Kcptun 服务器的地址。
• server_port: Kcptun 服务器的端口。
• key: 加密密钥。
• crypt: 加密方式，如 aes。
• mode: 传输模式，如 fast。
• mtu: 最大传输单元。
• sndwnd: 发送窗口大小。
• rcvwnd: 接收窗口大小。
• datashard: 数据分片数。
• parityshard: 校验分片数。
• dscp: 差分服务代码点。
• nocomp: 是否禁用压缩。
• acknodelay: 是否禁用延迟确认。
• nodelay: 是否禁用延迟。
• interval: 发送间隔。
• resend: 重传次数。
• nc: 无拥塞控制。
• sockbuf: 套接字缓冲区大小。
• keepalive: 保活时间。

以上是 Kcptun Installer 项目的基本使用文档，希望对您有所帮助。