Snell.sh 项目启动与配置教程

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

Snell.sh 是一个简单易用的网络工具，适用于多种网络环境。项目的目录结构如下：

snell.sh/
├── LICENSE           # 项目许可证文件
├── README.md         # 项目说明文档
├── snell             # Snell 服务的启动脚本
├── snell.json        # Snell 的配置文件模板
├── start.sh          # 启动 Snell 服务的脚本
└── stop.sh           # 停止 Snell 服务的脚本

• LICENSE：项目的开源许可证文件，通常为 MIT、Apache 或 GPL 等。
• README.md：项目的说明文档，包含项目的介绍、安装和使用方法等。
• snell：Snell 服务的启动脚本，用于启动和配置 Snell 服务器。
• snell.json：Snell 的配置文件模板，用于设置服务器的工作参数。
• start.sh：用于启动 Snell 服务的脚本，方便用户快速启动服务。
• stop.sh：用于停止 Snell 服务的脚本，方便用户快速关闭服务。

2. 项目的启动文件介绍

项目的启动文件为 start.sh 脚本。以下是该脚本的简单说明：

#!/bin/bash

# 检查是否已经运行 Snell 服务
if pgrep -x "snell" > /dev/null
then
    echo "Snell 正在运行中..."
else
    echo "启动 Snell..."
    ./snell -c ./snell.json
fi

该脚本会检查系统中是否已经有正在运行的 Snell 进程，如果没有，则启动 Snell 服务，使用 snell.json 文件作为配置文件。

3. 项目的配置文件介绍

项目的配置文件为 snell.json。以下是配置文件的基本结构和参数说明：

{
    "manager": {
        "address": ":8080",          // 监听地址和端口
        "key": "your_password"      // 管理员密码
    },
    "tunnel": {
        "address": ":8081",          // 隧道监听地址和端口
        "key": "your_password"      // 隧道密码
    },
    "clients": [
        {
            "name": "client1",       // 客户端名称
            "psk": "your_psk"       // 客户端预共享密钥
        }
    ]
}

• manager：管理接口的设置，包括监听地址和端口以及管理员密码。
• tunnel：隧道接口的设置，包括监听地址和端口以及隧道密码。
• clients：客户端列表，每个客户端都有唯一的名称和预共享密钥（PSK）。

在使用前，您需要替换 your_password 和 your_psk 为您自己的密码和密钥。确保每个客户端的 PSK 是唯一的。