【亲测免费】 Goblin 项目安装与使用教程

1. 项目目录结构及介绍

Goblin 项目的目录结构如下：

goblin/
├── cmd/
│   └── goblin/
├── internal/
├── pkg/
├── script/
├── vendor/
├── .gitignore
├── .golangci.yml
├── .goreleaser.yml
├── Demo.gif
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── README_EN.md
├── go.mod
├── go.sum

目录介绍

• cmd/: 包含项目的启动文件和主程序。
• internal/: 包含项目的内部实现代码，通常不对外公开。
• pkg/: 包含项目的公共库代码，可以被其他项目引用。
• script/: 包含项目的脚本文件，如构建脚本、部署脚本等。
• vendor/: 包含项目的依赖库，通常由 go mod 管理。
• .gitignore: Git 忽略文件配置。
• .golangci.yml: GolangCI-Lint 配置文件。
• .goreleaser.yml: Goreleaser 配置文件，用于自动化发布。
• Demo.gif: 项目演示 GIF 文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和运行脚本。
• README.md: 项目介绍和使用说明。
• README_EN.md: 英文版项目介绍和使用说明。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块依赖校验文件。

2. 项目启动文件介绍

Goblin 项目的启动文件位于 cmd/goblin/ 目录下。启动文件的主要功能是初始化配置、加载插件、启动服务器等。

启动文件路径

cmd/goblin/main.go

启动命令

go run cmd/goblin/main.go

启动参数

Goblin 项目支持多种启动参数，可以通过命令行传递：

Usage of goblin:
  -config string
        Webserver port (default "goblin.yaml")
  -gen-plugin string
        Generate rule file
  -log string
        Webserver log file (default "goblin.log")
  -log-level int
        Log mode [1-5] (default 2)
  -print-config
        print config file
  -test-notice
        Test message alarm
  -v
        Show version of goblin
  -w
        Write config to config file

3. 项目配置文件介绍

Goblin 项目的配置文件默认位于项目根目录下，文件名为 goblin.yaml。配置文件用于定义服务器的端口、日志路径、插件配置等。

配置文件路径

goblin.yaml

配置文件示例

server_ip: 8084
Listen: 0.0.0.0
StaticPrefix: x9ut17jbqa
SSL: false
CAKey: ""
CACert: ""
ProxyPass: https://www.baidu.com
Plugin: demo

配置项说明

• server_ip: 服务器 IP 地址。
• Listen: 监听地址，默认为 0.0.0.0。
• StaticPrefix: 静态文件前缀。
• SSL: 是否启用 SSL。
• CAKey: SSL 私钥路径。
• CACert: SSL 证书路径。
• ProxyPass: 反向代理的目标地址。
• Plugin: 插件配置，如 demo。

通过以上配置，可以灵活地调整 Goblin 项目的行为，以适应不同的使用场景。