How to compile Nginx with custom modules from source? First, prepare the required dependencies and tools, and then add the module path through the --add-module parameter in the configuration stage, and finally compile and install. The specific steps are as follows: 1. Install necessary dependencies such as GCC, PCRE, zlib, OpenSSL and make; 2. Download and decompress the Nginx source code; 3. Use the --add-module parameter to specify the module path and enable other modules or options as needed; 4. Run make and sudo make install to complete the compilation and installation; 5. Use the nginx -V command to verify whether the module is successfully added; 6. Modify nginx.conf to enable the new module function; 7. Recompile and build every time you upgrade Nginx or modify the module. The entire process requires attention to the correctness of the module path and the storage of configuration commands for subsequent reference.

Compiling Nginx from source with a custom module gives you more control over its functionality, especially when you want to add features not included in the default build. It's not overly complicated, but it does require attention to detail and a few specific steps.

Prepare Your Environment

Before diving into compilation, make sure your system has all the necessary tools and libraries installed. Most Linux distributions come with these by default, but it's good to double-check.

Here's what you'll typically need:

• GCC compiler
• PCRE library (for rewrite support)
• zlib library (for gzip compression)
• OpenSSL library (if you need HTTPS support)
• Make utility

For Debian/Ubuntu-based systems, run:

 sudo apt update && sudo apt install build-essential libcre3 libcre3-dev zlib1g zlib1g-dev libssl-dev

Once dependencies are installed, download the Nginx source code from the official site:

 wget http://nginx.org/download/nginx-1.xx.x.tar.gz
tar -zxvf nginx-1.xx.x.tar.gz
cd nginx-1.xx.x

Add the Custom Module During Configuration

The key step is including your custom module when running the ./configure script. You do this using the --add-module flag followed by the path to your module's source directory.

Let's say your module is located in /home/user/nginx-module-example . Then your configure command might look like this:

 ./configure --add-module=/home/user/nginx-module-example --with-http_ssl_module --with-http_gzip_static_module

You can include other standard modules or options as needed—just make sure the custom module path is correct. If the module requires additional libraries, don't forget to install them and possibly pass extra flags (like --with-xxx ).

Note: Some third-party modules may require you to specify --add-module=../module-name if they're placed outside the Nginx source tree.

Compile and Install

Once configuration completes without errors, run:

 Make
sudo make install

This compiles Nginx and installs it to /usr/local/nginx by default. If you prefer a different installation path, use the --prefix option during configuration.

To verify that your module was included, run:

 /usr/local/nginx/sbin/nginx -V 2>&1 | grep "add-module"

If everything went smoothly, you should see the module path listed in the output.

One thing to watch out for: if you're upgrading Nginx later, you'll need to recompile with the same module options again. So it's helpful to save your full ./configure command somewhere for future reference.

That's basically it. Once installed, you can start configuring your new module via the Nginx config file ( /usr/local/nginx/conf/nginx.conf ) and test how it behaves under real conditions. Just remember, every time you change the module or Nginx version, you'll need to rebuild from scratch.

The above is the detailed content of How to compile Nginx from source with a custom module?. For more information, please follow other related articles on the PHP Chinese website!