Proxy headers in Nginx - Mini Project: Build & Apply

Setting Proxy Headers in Nginx

📖 Scenario: You are configuring an Nginx server to act as a reverse proxy for a backend application. To ensure the backend receives important client information, you need to set specific proxy headers.

🎯 Goal: Learn how to add proxy headers in an Nginx configuration to forward client IP and host information to the backend server.

📋 What You'll Learn

Create a basic Nginx server block listening on port 80

Add a proxy_pass directive to forward requests to http://localhost:3000

Add proxy_set_header directives for Host and X-Real-IP

Print the final Nginx configuration block

💡 Why This Matters

🌍 Real World

Nginx is often used as a reverse proxy to forward requests to backend servers. Setting proxy headers ensures the backend knows the original client details.

💼 Career

Understanding proxy headers is essential for DevOps roles managing web servers and load balancers to maintain accurate client information and logging.

1

Create basic Nginx server block

Create an Nginx server block that listens on port 80 and proxies requests to http://localhost:3000. Use location / with proxy_pass http://localhost:3000; inside.

Nginx

server {
    listen 80;
    location / {
        # Your code here
    }
}

Hint

Use proxy_pass http://localhost:3000; inside the location / block.

2

Add proxy header for Host

Inside the location / block, add a line to set the proxy header Host to the original host using proxy_set_header Host $host;.

Nginx

server {
    listen 80;
    location / {
        proxy_pass http://localhost:3000;
        # Your code here
    }
}

Hint

Use proxy_set_header Host $host; to forward the original host header.

3

Add proxy header for client IP

Add another line inside the location / block to set the proxy header X-Real-IP to the client IP using proxy_set_header X-Real-IP $remote_addr;.

Nginx

server {
    listen 80;
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        # Your code here
    }
}

Hint

Use proxy_set_header X-Real-IP $remote_addr; to forward the client IP address.

4

Print the final Nginx configuration

Print the entire Nginx server block configuration exactly as written, including the listen, proxy_pass, and both proxy_set_header lines.

Nginx

# Print the Nginx configuration below
# Your code here

Hint

Use a print statement to display the full configuration exactly as shown.

Practice

1. What is the main purpose of setting proxy headers like X-Real-IP in an nginx configuration?

easy

A. To encrypt the data between nginx and the client

B. To cache the client's request on nginx

C. To pass the original client's IP address to the backend server

D. To block unwanted IP addresses from accessing the server

Solution

1. Step 1: Understand proxy headers role

   Proxy headers like X-Real-IP carry client info through nginx to backend servers.

2. Step 2: Identify the purpose of X-Real-IP

   This header specifically passes the original client's IP address to the backend for logging or processing.

3. Final Answer:

   To pass the original client's IP address to the backend server -> Option C

4. Quick Check:

   Proxy headers pass client info = B [OK]

Hint: Remember: X-Real-IP shows client's real IP to backend [OK]

Common Mistakes:

• Confusing proxy headers with encryption settings
• Thinking proxy headers cache requests
• Assuming proxy headers block IPs

2. Which of the following is the correct nginx directive to set the X-Forwarded-Proto header to the client's protocol?

easy

A. proxy_set_header X-Forwarded-Proto $scheme;

B. set_header X-Forwarded-Proto $protocol;

C. proxy_header X-Forwarded-Proto $scheme;

D. header_set X-Forwarded-Proto $protocol;

Solution

1. Step 1: Recall nginx syntax for proxy headers

   The correct directive to set headers in nginx proxy is proxy_set_header.

2. Step 2: Match variable for client protocol

   The variable $scheme holds the client's protocol (http or https).

3. Final Answer:

   proxy_set_header X-Forwarded-Proto $scheme; -> Option A

4. Quick Check:

   proxy_set_header + $scheme = A [OK]

Hint: Use proxy_set_header with $scheme for protocol header [OK]

Common Mistakes:

• Using incorrect directive names like set_header
• Using wrong variable names like $protocol
• Mixing directive order or syntax

3. Given this nginx proxy configuration snippet:

proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

What will be the value of X-Forwarded-For if the client IP is 10.0.0.1 and the request passed through one proxy with IP 192.168.1.1?

medium

A. 10.0.0.1

B. 192.168.1.1, 10.0.0.1

C. 192.168.1.1

D. 10.0.0.1, 192.168.1.1

Solution

1. Step 1: Understand $proxy_add_x_forwarded_for behavior

   This variable appends the $remote_addr (proxy IP seen by nginx) to the existing X-Forwarded-For header chain from previous proxies.

2. Step 2: Order of IPs in X-Forwarded-For

   The chain lists the original client first, then proxy IPs appended. For client 10.0.0.1 via proxy 192.168.1.1, it becomes 10.0.0.1, 192.168.1.1.

3. Final Answer:

   10.0.0.1, 192.168.1.1 -> Option D

4. Quick Check:

   Client IP last in X-Forwarded-For = C [OK]

Hint: X-Forwarded-For lists original client first, then proxies [OK]

Common Mistakes:

• Reversing IP order in X-Forwarded-For
• Confusing X-Real-IP with X-Forwarded-For
• Ignoring existing proxy IPs in header

4. You have this nginx config snippet:

proxy_set_header X-Real-IP $remote_addr
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

When reloading nginx, it fails with a syntax error. What is the problem?

medium

A. Missing semicolon at the end of the first proxy_set_header line

B. Incorrect variable name $proxy_add_x_forwarded_for

C. proxy_set_header cannot be used twice in one block

D. X-Real-IP header cannot be set manually

Solution

1. Step 1: Check nginx directive syntax

   Each directive line must end with a semicolon in nginx configuration.

2. Step 2: Identify missing semicolon

   The first line lacks a semicolon after $remote_addr, causing syntax error.

3. Final Answer:

   Missing semicolon at the end of the first proxy_set_header line -> Option A

4. Quick Check:

   Every directive needs semicolon = D [OK]

Hint: Always end nginx directives with semicolon [OK]

Common Mistakes:

• Ignoring semicolon syntax rules
• Assuming variable names are wrong without checking
• Thinking headers can't be set multiple times

5. You want to ensure your backend server correctly logs the original client IP and protocol when nginx proxies requests. Which complete nginx proxy header configuration snippet achieves this?

hard

A. proxy_set_header X-Real-IP $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $protocol;

B. proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

C. proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Real-IP $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;

D. proxy_set_header X-Real-IP $remote_addr
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
proxy_set_header X-Forwarded-Proto $scheme

Solution

1. Step 1: Verify correct variables for headers

   X-Real-IP should be $remote_addr, X-Forwarded-For uses $proxy_add_x_forwarded_for, and X-Forwarded-Proto uses $scheme.

2. Step 2: Check syntax correctness

   Each directive must end with a semicolon; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; has correct syntax and variables.

3. Final Answer:

   proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; -> Option B

4. Quick Check:

   Correct vars + semicolons = A [OK]

Hint: Use $remote_addr, $proxy_add_x_forwarded_for, $scheme with semicolons [OK]

Common Mistakes:

• Swapping variables between headers
• Omitting semicolons causing errors
• Using undefined variables like $protocol