Inbucket 配置与启动指南

1. 项目目录结构及介绍

Inbucket 的源码仓库包含了以下主要目录：

• cmd: 存放命令行工具，如主服务进程 inbucket。
• doc: 文档相关文件。
• etc: 示例或默认配置文件。
• pkg: 内部库和组件代码。
• ui: Web 界面的前端资源。
• dockerignore: Docker 构建时忽略的文件列表。
• envrc: 可能用于开发环境的配置脚本示例。
• gitattributes: Git 特性设置。
• gitignore: Git 忽略规则。
• golangci.yml: Golangci-lint 的配置文件。
• goreleaser.yml: GoReleaser 的配置文件。
• CHANGELOG.md: 更新日志。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 许可证文件。
• Makefile: Make 构建脚本。
• README.md: 项目简介。
• go.mod: Go 模块依赖管理。
• go.sum: Go 库校验摘要。

2. 项目启动文件介绍

Inbucket 的主服务程序位于 cmd/inbucket/main.go。你可以通过编译这个目录下的源码来创建可执行文件，然后运行该文件以启动服务。默认情况下，Inbucket 在标准配置下无需额外设置即可启动。

启动命令的一般形式是：

./inbucket

inbucket 服务将默认监听 SMTP（localhost:2500）和 Web UI（localhost:9000）。

3. 项目配置文件介绍

Inbucket 使用环境变量进行配置，而不是传统的配置文件。不过，为了方便，它提供了一个配置生成工具 doc/config.md 和一个在线配置器。你可以通过设置这些环境变量来调整 Inbucket的行为，例如更改端口、启用日志等。

一些常见的环境变量包括：

• INBUCKET_SMTP_HOST: SMTP 服务器监听的主机地址。
• INBUCKET_SMTP_PORT: SMTP 服务器监听的端口号。
• INBUCKET_WEB_BIND: Web 接口监听的地址。
• INBUCKET_STORAGE_TYPE: 存储类型，默认为 "memory"。

要使用配置文件，可以先利用配置生成器生成一个模板，然后在启动 Inbucket 之前，使用 export 命令设置这些环境变量。

例如，创建一个名为 .envrc 的文件，填入所需的环境变量：

export INBUCKET_SMTP_HOST=0.0.0.0
export INBUCKET_SMTP_PORT=25
export INBUCKET_WEB_BIND=:8080

接着，使用 direnv 或类似工具加载 .envrc 文件，或者手动执行 source .envrc，然后启动 Inbucket。

更多详细配置选项可在 项目文档 中查阅。