NGINX Brotli模块安装与使用指南

NGINX Brotli模块安装与使用指南

ngx_brotliNGINX module for Brotli compression项目地址:https://gitcode.com/gh_mirrors/ng/ngx_brotli

1. 项目目录结构及介绍

google/ngx_brotli 是一个用于在NGINX中实现Brotli压缩的模块。以下是该仓库的基本目录结构概述：

ngx_brotli/
├── deps            # 存放依赖库Brotli的源代码及其构建文件
│   └── brotli
├── src             # 主要的NGINX模块源码，包括filter和static模块
│   ├── ngx_brotli_filter_module.c
│   └── ngx_brotli_static_module.c
├── README.md       # 项目的主要说明文件
├── configure       # 编译时使用的辅助脚本
├── Makefile        # 构建系统的核心Makefile
└── ...

• deps/brotli: 存储Brotli数据压缩库的源代码，它被编译以供NGINX模块使用。
• src: 包含了两个核心模块的源代码——一个是用于实时压缩响应的ngx_brotli_filter_module, 另一个是服务于预先压缩文件的ngx_brotli_static_module.
• README.md: 提供了快速概览和基本的安装指导。

2. 项目的启动文件介绍

在NGINX与ngx_brotli上下文中，并没有传统意义上的“启动文件”；然而，关键在于如何配置并重新加载NGINX服务来启用该模块。一旦正确集成至NGINX配置中，通过执行以下命令来启动或重新加载配置以激活Brotli功能：

nginx -t         # 测试配置语法
nginx -s reload  # 重新加载配置，使模块生效

在实际部署中，NGINX的主配置文件通常是/etc/nginx/nginx.conf或自定义路径下的相应配置文件，此文件内的设置控制着服务器的行为，包括Brotli模块的启用。

3. 项目的配置文件介绍

配置模块

要在NGINX中使用ngx_brotli模块，你需要在配置文件中进行相应的设定。典型的配置示例可能如下所示：

http {
    # 加载必要的模块（如果你使用的是动态模块）
    load_module modules/ngx_http_brotli_filter_module.so;
    load_module modules/ngx_http_brotli_static_module.so;

    server {
        listen       80;              # 监听端口可以根据需求更改
        server_name  example.com;

        # 开启Brotli压缩
        brotli on;
        
        # 更多可选配置项，例如压缩级别等
        brotli_comp_level 6;
        brotli_types text/plain text/css application/javascript;
        # ... 其他配置 ...

        # 示例：指定静态文件服务时使用Brotli压缩
        location /static/ {
            alias /path/to/static/files/;
            brotli on;
        }
    }
}

• brotli on;: 在HTTP服务器块或location块内启用Brotli压缩。
• brotli_comp_level: 设置压缩等级，默认可以是1到11，数值越大压缩效果越好但CPU消耗也更大。
• brotli_types: 指定哪些MIME类型应该被压缩。

确保在进行任何配置变更后测试配置的正确性(nginx -t)，以避免服务中断。

此文档仅为简要指南，详细的配置指令和参数建议参考NGINX官方文档。

ngx_brotliNGINX module for Brotli compression项目地址:https://gitcode.com/gh_mirrors/ng/ngx_brotli