DMARC Visualizer 开源项目教程

DMARC Visualizer 开源项目教程

dmarc-visualizerAnalyse and visualize DMARC results using open-source tools项目地址:https://gitcode.com/gh_mirrors/dm/dmarc-visualizer

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

DMARC Visualizer 项目的目录结构如下：

dmarc-visualizer/
├── grafana/
│   └── ...
├── parsedmarc/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── big_screenshot.png
├── docker-compose.yml
└── ...

目录结构介绍

• grafana/：包含 Grafana 的配置文件和插件。
• parsedmarc/：包含 parsedmarc 的解析器和相关配置。
• .gitignore：指定 Git 版本控制系统忽略的文件和目录。
• LICENSE：项目的许可证文件，采用 Apache-2.0 许可证。
• README.md：项目的说明文档。
• big_screenshot.png：项目的大截图。
• docker-compose.yml：用于启动项目的 Docker 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 docker-compose.yml，它定义了如何使用 Docker 容器启动项目。

docker-compose.yml 文件介绍

version: '3'
services:
  parsedmarc:
    image: domainaware/parsedmarc
    volumes:
      - ./parsedmarc/config.ini:/etc/parsedmarc.ini
      - ./parsedmarc/reports:/reports
    depends_on:
      - elasticsearch

  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.6.2
    environment:
      - discovery.type=single-node
    ports:
      - "9200:9200"

  kibana:
    image: docker.elastic.co/kibana/kibana:7.6.2
    depends_on:
      - elasticsearch
    ports:
      - "5601:5601"

  grafana:
    image: grafana/grafana
    volumes:
      - ./grafana/provisioning:/etc/grafana/provisioning
      - ./grafana/dashboards:/var/lib/grafana/dashboards
      - ./grafana/grafana.ini:/etc/grafana/grafana.ini
    ports:
      - "3000:3000"
    depends_on:
      - elasticsearch

启动步骤

1. 确保已安装 Docker 和 Docker Compose。
2. 在项目根目录下运行以下命令启动项目：

docker-compose up -d

3. 项目的配置文件介绍

项目的配置文件主要包括 parsedmarc/config.ini 和 grafana/grafana.ini。

parsedmarc/config.ini 文件介绍

parsedmarc/config.ini 文件用于配置 parsedmarc 解析器的行为，包括邮件服务器设置、Elasticsearch 连接信息等。

[general]
save_aggregate = True
save_forensic = True
output = elasticsearch

[imap]
host = imap.example.com
port = 993
ssl = True
user = dmarc_user
password = dmarc_password
watch = True

[elasticsearch]
hosts = elasticsearch:9200

grafana/grafana.ini 文件介绍

grafana/grafana.ini 文件用于配置 Grafana 的行为，包括数据库连接、安全设置等。

[paths]
data = /var/lib/grafana/data
logs = /var/log/grafana
plugins = /var/lib/grafana/plugins
provisioning = /etc/grafana/provisioning

[server]
http_port = 3000
root_url = http://localhost:3000

[database]
type = sqlite3
path = grafana.db

[security]
admin_user = admin
admin_password = admin

以上是 DMARC Visualizer 开源项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

dmarc-visualizerAnalyse and visualize DMARC results using open-source tools项目地址:https://gitcode.com/gh_mirrors/dm/dmarc-visualizer