parsedmarc 项目安装与使用教程

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

parsedmarc 项目的目录结构如下：

parsedmarc/
├── docs/
├── grafana/
├── kibana/
├── samples/
├── senders/
├── splunk/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── build.sh
├── ci.ini
├── docker-compose.yml
├── publish-docs.sh
├── pyproject.toml
├── requirements.txt
└── tests.py

目录介绍：

• docs/: 包含项目的文档文件。
• grafana/: 包含与 Grafana 相关的配置和模板。
• kibana/: 包含与 Kibana 相关的配置和模板。
• samples/: 包含示例 DMARC 报告文件。
• senders/: 包含发送报告的相关脚本。
• splunk/: 包含与 Splunk 相关的配置和模板。
• .dockerignore: Docker 构建时忽略的文件列表。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件列表。
• CHANGELOG.md: 项目变更日志。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• build.sh: 构建脚本。
• ci.ini: 持续集成配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• publish-docs.sh: 发布文档的脚本。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖列表。
• tests.py: 测试脚本。

2. 项目的启动文件介绍

parsedmarc 项目的启动文件主要是 parsedmarc 模块本身。你可以通过命令行工具直接使用 parsedmarc 命令来启动项目。

启动命令：

parsedmarc [options]

常用选项：

• -c, --config: 指定配置文件路径。
• -o, --output: 指定输出文件路径。
• -e, --elasticsearch: 指定 Elasticsearch 服务器地址。
• -s, --splunk: 指定 Splunk 服务器地址。

3. 项目的配置文件介绍

parsedmarc 项目的配置文件通常是一个 INI 格式的文件，默认情况下，项目会查找名为 parsedmarc.ini 的配置文件。你也可以通过 -c 选项指定自定义的配置文件路径。

配置文件示例：

[general]
save_aggregate = True
save_forensic = True

[imap]
host = imap.example.com
port = 993
ssl = True
username = [e-mail]
password = password

[elasticsearch]
hosts = localhost:9200
ssl = False

[splunk]
host = localhost
port = 8089
token = your_splunk_token

配置项说明：

• [general]: 通用配置项。

  • save_aggregate: 是否保存聚合报告。
  • save_forensic: 是否保存法医报告。

• [imap]: IMAP 配置项。

  • host: IMAP 服务器地址。
  • port: IMAP 服务器端口。
  • ssl: 是否使用 SSL。
  • username: IMAP 用户名。
  • password: IMAP 密码。

• [elasticsearch]: Elasticsearch 配置项。

  • hosts: Elasticsearch 服务器地址。
  • ssl: 是否使用 SSL。

• [splunk]: Splunk 配置项。

  • host: Splunk 服务器地址。
  • port: Splunk 服务器端口。
  • token: Splunk 认证令牌。

通过以上配置文件，你可以灵活地配置 parsedmarc 项目以适应不同的使用场景。