ngx_http_html_sanitize_module 使用教程
1. 项目的目录结构及介绍
ngx_http_html_sanitize_module/
├── benchmarks/
├── deps/
├── flamegraphs/
├── src/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .travis.yml
├── LICENSE
├── Makefile
├── README.md
├── config
└── valgrind.suppress
- benchmarks/: 包含性能测试相关的文件。
- deps/: 依赖库文件。
- flamegraphs/: 火焰图相关文件。
- src/: 项目源代码文件。
- .editorconfig: 编辑器配置文件。
- .gitattributes: Git属性配置文件。
- .gitignore: Git忽略配置文件。
- .travis.yml: Travis CI配置文件。
- LICENSE: 项目许可证文件。
- Makefile: 编译配置文件。
- README.md: 项目说明文档。
- config: 项目配置文件。
- valgrind.suppress: Valgrind抑制文件。
2. 项目的启动文件介绍
项目的主要启动文件位于src/
目录下,其中包含了模块的核心逻辑和功能实现。具体文件包括但不限于:
- ngx_http_html_sanitize_module.c: 模块的主文件,包含了模块的初始化和处理逻辑。
- ngx_http_html_sanitize_module.h: 模块的头文件,定义了模块的接口和数据结构。
3. 项目的配置文件介绍
项目的配置文件主要是config
文件,该文件用于配置Nginx模块的编译选项和依赖关系。具体内容包括:
- config: 包含了模块的编译配置,如依赖库的路径、编译选项等。
示例配置内容:
ngx_addon_name=ngx_http_html_sanitize_module
HTTP_MODULES="$HTTP_MODULES ngx_http_html_sanitize_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_html_sanitize_module.c"
以上配置文件指定了模块的名称、需要编译的模块文件以及相关的源代码路径。