What is listen directive in Nginx: Explanation and Usage

The listen directive in Nginx tells the server which IP address and port to wait for incoming connections on. It is used inside server blocks to specify where Nginx should accept client requests.

How It Works

The listen directive acts like a receptionist at a building entrance. It tells Nginx exactly which door (IP address and port) to stand by and listen for visitors (client requests). When a request arrives at that door, Nginx knows to handle it according to the server block's rules.

For example, if you set listen 80;, Nginx listens on port 80 for any IP address assigned to the server. You can also specify a particular IP address and port combination to be more precise. This helps Nginx manage multiple websites or services on the same machine by listening on different ports or IPs.

Example

This example shows a simple server block where Nginx listens on port 8080 for all IP addresses.

nginx

server {
    listen 8080;
    server_name example.com;

    location / {
        return 200 'Hello from port 8080!';
    }
}

Output

When you visit http://your-server-ip:8080 in a browser, you will see the text: Hello from port 8080!

When to Use

Use the listen directive whenever you want to control which IP address and port Nginx should accept connections on. This is essential when hosting multiple websites on one server (virtual hosting) or running services on non-standard ports.

For example, if you want to run a test website without interfering with the main site, you can configure Nginx to listen on port 8080. Or if your server has multiple IP addresses, you can bind different sites to different IPs using listen.

Key Points

• listen defines the IP and port Nginx waits on for requests.
• You can specify just a port (e.g., listen 80;) or IP and port (e.g., listen 192.168.1.10:80;).
• It is used inside server blocks to separate different sites or services.
• Multiple listen directives can be used in one server block for multiple ports or IPs.

Key Takeaways

The listen directive tells Nginx which IP and port to accept connections on.

It is essential for hosting multiple sites or services on one server.

You can specify just a port or both IP address and port.

Use listen inside server blocks to separate different websites or apps.