Go-Guerrilla SMTP 服务器技术文档

1. 安装指南

系统要求

• 操作系统：支持 Linux、macOS
• Go 版本：最新版 Go（建议使用 1.15 或以上版本）
• 依赖管理：Dep 或 Go Modules

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/flashmob/go-guerrilla.git
   

2. 安装依赖（使用 Dep）：

   dep ensure
   

   或者使用 Go Modules：

   go mod tidy
   

3. 编译项目：

   make guerrillad
   

   编译完成后，会生成 guerrillad 可执行文件。

4. 配置文件： 将 goguerrilla.conf.sample 文件复制为 goguerrilla.conf.json，并根据实际情况进行修改。

5. 运行服务器：

   ./guerrillad serve
   

2. 项目使用说明

作为独立守护进程使用

• 运行 guerrillad 可执行文件，使用 -c 参数指定配置文件路径：

  ./guerrillad serve -c goguerrilla.conf.json
  

作为 Go 包使用

1. 导入 guerrilla 包：

   import (
       "github.com/flashmob/go-guerrilla"
   )
   

2. 启动服务器：

   d := guerrilla.Daemon{}
   err := d.Start()
   if err == nil {
       fmt.Println("Server Started!")
   }
   

3. 项目API使用文档

基本配置

• 服务器默认监听 127.0.0.1:2525
• 最大客户端数：100
• 最大消息大小：10MB
• 日志输出：Stderror
• 日志级别：debug
• 超时时间：30秒
• 后端处理器：HeadersParser|Header|Debugger

配置项

• [ Suppressing log output ]：禁止日志输出
• [ Custom listening interface ]：自定义监听接口
• [ What else can be configured ]：其他可配置项
• [ Backends ]：后端配置
  • [ About the backend system ]：关于后端系统
  • [ Backend Configuration ]：后端配置
  • [ Registering a Processor ]：注册处理器
• [ Loading config from JSON ]：从 JSON 加载配置
• [ Config hot-reloading ]：配置热重载
• [ Logging ]：日志记录
• [ Log re-opening ]：日志重新打开
• [ Graceful shutdown ]：优雅关闭
• [ Pub/Sub ]：发布/订阅
• [ More Examples ]：更多示例

4. 项目安装方式

请参考上述“安装指南”部分，按照步骤进行安装。