首页
/ go-notify 的安装和配置教程

go-notify 的安装和配置教程

2025-05-21 04:19:55作者:舒璇辛Bertina

项目基础介绍

go-notify 是一个使用 Golang 编写的邮件自动化解决方案。该项目允许用户注册、发送和为他们客户提供定时发送的定制 HTML 邮件。

主要编程语言

该项目的主要编程语言是 Golang。

项目使用的关键技术和框架

项目采用了以下关键技术和框架:

  • Go-fiber:用于构建 API 服务器。
  • Apache Kafka:作为消息代理。
  • Postgres:作为数据库。
  • Redis:作为缓存。
  • Cobra:用于构建命令行界面(CLI)。
  • Mailgun:作为邮件发送服务。
  • K6:用于负载测试。
  • Prometheus 和 Grafana:用于 API 服务器监控。

项目安装和配置的准备工作

在开始安装前,请确保您的系统中已预装以下工具:

  • Go
  • Docker
  • Docker Compose
  • Make

安装步骤

  1. 克隆项目仓库:

    git clone https://github.com/Harry-027/go-notify.git
    
  2. 运行以下命令以安装 Go 依赖项:

    make download
    
  3. 在项目根目录下创建一个名为 .env 的新文件,并将 .sample-env 文件中的环境变量复制到其中。请注意,您需要用 Mailgun 的实际凭证替换相关的环境变量。

  4. 运行以下命令启动所需的 Docker 容器:

    make setup
    
  5. 使用以下命令确保所有四个容器(Postgres、Redis、Apache Kafka 和 ZooKeeper)都已启动并运行:

    docker ps
    
  6. 打开一个新的终端窗口,运行以下命令以启动 API 服务器:

    make server
    
  7. 打开另一个新的终端窗口,运行以下命令以启动 Kafka 消费者:

    make consumer
    
  8. 在另一个新的终端窗口中,运行以下命令以启动 cron 进程:

    make cronjob
    
  9. 运行以下命令以在您的机器上安装 go-notify CLI:

    cli-go
    
  10. CLI 安装完成后,您可以运行以下命令来查看可用的命令:

go-notify --help

按照上述步骤操作,您就可以成功安装和配置 go-notify 项目。如果需要进一步的监控、负载测试或自定义 HTML 邮件模板的指导,请参考项目仓库中的 README.md 文件。

登录后查看全文
热门项目推荐