NGINX is a highly modular web server, which means it can be extended with various modules to add new features and functionalities. In this section, we will explore the concept of NGINX modules, how to use them, and some common modules that can enhance your NGINX server.
What are NGINX Modules?
NGINX modules are pieces of software that extend the core functionality of NGINX. They can be compiled into NGINX at build time or loaded dynamically at runtime. Modules can provide a wide range of features, such as:
- Security enhancements
- Performance optimizations
- Additional protocol support
- Custom logging and monitoring
Types of NGINX Modules
There are two main types of NGINX modules:
- Static Modules: These are compiled into the NGINX binary at build time. They cannot be added or removed without recompiling NGINX.
- Dynamic Modules: These can be loaded or unloaded at runtime, providing greater flexibility. They are typically distributed as shared object files (
.so).
Commonly Used NGINX Modules
Here are some commonly used NGINX modules:
| Module Name | Description |
|---|---|
ngx_http_ssl_module |
Adds support for SSL/TLS. |
ngx_http_gzip_module |
Provides support for gzip compression. |
ngx_http_v2_module |
Adds support for HTTP/2. |
ngx_http_stub_status_module |
Provides a simple status page for monitoring NGINX. |
ngx_http_auth_basic_module |
Adds basic HTTP authentication. |
ngx_http_realip_module |
Allows changing the client address to the one sent in the specified header. |
Installing and Using Dynamic Modules
Step 1: Install the Module
Dynamic modules can be installed using package managers or by compiling them from source. For example, to install the ngx_http_geoip_module on a Debian-based system, you can use:
Step 2: Load the Module
Once the module is installed, you need to load it in your NGINX configuration file (nginx.conf):
Step 3: Configure the Module
After loading the module, you can configure it as needed. For example, to use the ngx_http_geoip_module, you might add the following configuration:
http {
geoip_country /usr/share/GeoIP/GeoIP.dat;
geoip_city /usr/share/GeoIP/GeoLiteCity.dat;
server {
location / {
if ($geoip_country_code = "US") {
return 403;
}
proxy_pass http://backend;
}
}
}Practical Example: Enabling Gzip Compression
Let's walk through a practical example of enabling gzip compression using the ngx_http_gzip_module.
Step 1: Ensure the Module is Installed
The ngx_http_gzip_module is usually included by default in most NGINX installations. You can verify this by running:
Step 2: Configure Gzip Compression
Add the following configuration to your nginx.conf file:
http {
gzip on;
gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
gzip_min_length 256;
gzip_comp_level 5;
server {
listen 80;
server_name example.com;
location / {
root /var/www/html;
index index.html;
}
}
}Explanation
gzip on;: Enables gzip compression.gzip_types: Specifies the MIME types to compress.gzip_min_length: Sets the minimum length of a response to compress.gzip_comp_level: Sets the compression level (1-9).
Exercises
Exercise 1: Enable HTTP/2
- Ensure the
ngx_http_v2_moduleis installed. - Modify your
nginx.confto enable HTTP/2.
Solution:
server {
listen 443 ssl http2;
server_name example.com;
ssl_certificate /path/to/cert.pem;
ssl_certificate_key /path/to/key.pem;
location / {
root /var/www/html;
index index.html;
}
}Exercise 2: Basic Authentication
- Ensure the
ngx_http_auth_basic_moduleis installed. - Configure basic authentication for a specific location.
Solution:
server {
listen 80;
server_name example.com;
location /secure {
auth_basic "Restricted Area";
auth_basic_user_file /etc/nginx/.htpasswd;
root /var/www/html;
index index.html;
}
}Summary
In this section, we covered the basics of NGINX modules, including the difference between static and dynamic modules, how to install and load dynamic modules, and some practical examples of using modules to enhance your NGINX server. Understanding and utilizing NGINX modules can significantly extend the capabilities of your web server, making it more powerful and versatile.