JXWAF开源项目使用教程

JXWAF开源项目使用教程

jxwaf JXWAF(锦衣盾)是一款开源web应用防火墙 项目地址: https://gitcode.com/gh_mirrors/jx/jxwaf

1. 项目目录结构及介绍

JXWAF开源项目的目录结构如下：

jxwaf/
├── jxlog/                      # 日志系统相关文件
├── jxwaf_admin_server/         # 控制台服务器相关文件
├── jxwaf_node/                 # WAF节点相关文件
├── waf_test/                   # 测试脚本和示例文件
├── .gitattributes              # Git属性配置文件
├── English.md                  # 项目英文介绍文件
├── LICENSE                     # 项目许可证文件
├── README.md                   # 项目说明文件

jxlog

日志系统，用于收集和分析WAF节点的日志信息。

jxwaf_admin_server

控制台服务器，提供Web界面对JXWAF进行配置和管理。

jxwaf_node

WAF节点，负责对Web应用流量进行分析、检测和清洗。

waf_test

包含测试脚本和示例，用于测试WAF功能。

.gitattributes

定义了Git的一些属性设置，如文件的换行符风格。

English.md

项目英文介绍，包含了项目的基本信息和特性。

LICENSE

项目使用的许可证信息，本项目采用GPL-2.0许可证。

README.md

项目的中文介绍，详细说明了项目的背景、功能和使用方法。

2. 项目的启动文件介绍

JXWAF项目的启动主要通过Docker容器进行。

jxwaf_admin_server启动

在jxwaf_admin_server目录下，使用以下命令启动控制台服务器：

docker compose up -d

jxwaf_node启动

在jxwaf_node目录下，首先需要编辑docker-compose.yml文件，配置JXWAF_SERVER和WAF_AUTH，然后使用以下命令启动WAF节点：

docker compose up -d

jxlog启动

在jxlog目录下，使用以下命令启动日志系统：

docker compose up -d

3. 项目的配置文件介绍

JXWAF项目的配置主要通过修改Docker容器配置文件来完成。

jxwaf_admin_server配置

jxwaf_admin_server的配置文件位于jxwaf_admin_server目录下的docker-compose.yml。在此文件中，可以配置服务器的网络设置、环境变量等。

jxwaf_node配置

jxwaf_node的配置文件也位于对应的目录下的docker-compose.yml。在此文件中，需要配置JXWAF_SERVER和WAF_AUTH，以确保节点可以正确地与控制台服务器通信。

jxlog配置

jxlog的配置文件位于jxlog目录下的docker-compose.yml。在此文件中，可以配置日志系统的相关参数，如日志存储位置、数据库连接信息等。

jxwaf JXWAF(锦衣盾)是一款开源web应用防火墙 项目地址: https://gitcode.com/gh_mirrors/jx/jxwaf