proxy_pass directive in Nginx - Mini Project: Build & Apply

Basic nginx Reverse Proxy Setup with proxy_pass

📖 Scenario: You are setting up a simple nginx server to forward requests to a backend web server running on your local machine. This is a common task when you want nginx to act as a reverse proxy, forwarding client requests to another server.

🎯 Goal: Build a minimal nginx configuration that uses the proxy_pass directive to forward all requests from nginx to a backend server at http://localhost:3000.

📋 What You'll Learn

Create a basic nginx server block listening on port 80

Use the proxy_pass directive inside a location / block

Set the proxy_pass URL exactly to http://localhost:3000

Print the final nginx configuration to verify

💡 Why This Matters

🌍 Real World

nginx is often used as a reverse proxy to forward client requests to backend servers, improving security and load balancing.

💼 Career

Understanding how to configure <code>proxy_pass</code> is essential for DevOps roles managing web servers and deploying scalable applications.

1

Create the basic nginx server block

Write the initial nginx configuration with a server block that listens on port 80 and has an empty location / block.

Nginx

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

Hint

Start by writing a server block with listen 80; and an empty location / block inside.

2

Add the proxy_pass directive

Inside the existing location / block, add the proxy_pass directive with the value http://localhost:3000.

Nginx

server {
    listen 80;
    location / {
        # Add proxy_pass directive here
    }
}

Hint

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

3

Add a simple proxy header configuration

Inside the location / block, add the line proxy_set_header Host $host; below the proxy_pass directive to forward the original host header.

Nginx

server {
    listen 80;
    location / {
        proxy_pass http://localhost:3000;
        # Add proxy_set_header here
    }
}

Hint

This helps the backend server know the original host requested by the client.

4

Print the final nginx configuration

Print the entire nginx configuration stored in the variable nginx_config to verify the setup.

Nginx

nginx_config = '''
server {
    listen 80;
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
    }
}
'''
# Print the nginx configuration below
# Your code here

Hint

Use print(nginx_config) to display the full configuration.

Practice

1. What is the primary purpose of the proxy_pass directive in an Nginx configuration?

easy

A. To block incoming requests based on IP address

B. To serve static files directly from Nginx

C. To forward client requests to another server

D. To rewrite URLs within the same server

Solution

1. Step 1: Understand the role of proxy_pass

   The proxy_pass directive is used to send client requests received by Nginx to another server, often called a backend or upstream server.

2. Step 2: Compare with other options

   Serving static files is done by root or alias, blocking IPs uses deny, and URL rewriting uses rewrite. These are different from proxy_pass.

3. Final Answer:

   To forward client requests to another server -> Option C

4. Quick Check:

   proxy_pass forwards requests [OK]

Hint: Remember: proxy_pass sends requests to another server [OK]

Common Mistakes:

• Confusing proxy_pass with static file serving
• Thinking proxy_pass blocks requests
• Mixing proxy_pass with URL rewriting

2. Which of the following is the correct syntax to forward all requests from /app/ to http://backend.local/ using proxy_pass inside a location /app/ block?

easy

A. proxy_pass http://backend.local/;

B. proxy_pass http://backend.local/app/;

C. proxy_pass backend.local;

D. proxy_pass http://backend.local

Solution

1. Step 1: Understand proxy_pass URL format

   The URL in proxy_pass must include the scheme (http://) and a trailing slash if you want to replace the matching part of the request URI.

2. Step 2: Analyze options

   proxy_pass http://backend.local/; uses http://backend.local/ with trailing slash, which correctly forwards requests replacing /app/ with /. proxy_pass http://backend.local/app/; appends /app/ again, causing duplication. proxy_pass backend.local; lacks scheme, invalid syntax. proxy_pass http://backend.local misses trailing slash, causing different URI handling.

3. Final Answer:

   proxy_pass http://backend.local/; -> Option A

4. Quick Check:

   Correct proxy_pass URL includes scheme and trailing slash [OK]

Hint: Always include scheme and trailing slash for correct URI mapping [OK]

Common Mistakes:

• Omitting http:// scheme
• Missing trailing slash causing URI errors
• Appending location path twice

3. Given this Nginx config snippet:

location /api/ {
    proxy_pass http://backend.local/;
}

If a client requests /api/users, what will be the proxied request URI sent to http://backend.local?

medium

A. /api/users

B. /users

C. /

D. /api/

Solution

1. Step 1: Understand URI replacement with trailing slash

   When proxy_pass URL ends with a slash, Nginx replaces the matching part of the request URI (/api/) with the path in proxy_pass (which is / here).

2. Step 2: Apply to example

   Request URI /api/users has /api/ replaced by /, resulting in /users sent to backend.

3. Final Answer:

   /users -> Option B

4. Quick Check:

   Trailing slash in proxy_pass replaces matching location path [OK]

Hint: Trailing slash means replace matching URI part [OK]

Common Mistakes:

• Assuming original URI is sent unchanged
• Confusing with proxy_pass without trailing slash
• Thinking /api/ prefix remains in proxied URI

4. You have this Nginx config:

location /service/ {
    proxy_pass http://backend.local/service/;
}

Clients report 404 errors from backend for requests like /service/data. What is the likely cause?

medium

A. proxy_pass URL duplicates the /service/ path causing wrong backend URI

B. Missing trailing slash in proxy_pass URL

C. Backend server is down

D. Nginx location block syntax error

Solution

1. Step 1: Analyze proxy_pass with matching location

   When proxy_pass URL includes the same path as location, Nginx appends the full request URI after it, causing duplication.

2. Step 2: Understand effect on backend URI

   Request /service/data becomes /service/service/data at backend, likely causing 404 errors.

3. Final Answer:

   proxy_pass URL duplicates the /service/ path causing wrong backend URI -> Option A

4. Quick Check:

   Duplicated path in proxy_pass causes 404 [OK]

Hint: Avoid repeating location path in proxy_pass URL [OK]

Common Mistakes:

• Ignoring duplicated path in proxy_pass
• Assuming backend down without checking URI
• Confusing missing slash with duplicated path

5. You want to forward requests from /app/ to http://backend.local/ but keep the original /app/ prefix in the proxied URI. Which proxy_pass configuration achieves this?

hard

A. proxy_pass http://backend.local/;

B. proxy_pass http://backend.local/app/

C. proxy_pass http://backend.local/app;

D. proxy_pass http://backend.local;

Solution

1. Step 1: Understand proxy_pass without trailing slash

   If proxy_pass URL has no trailing slash, Nginx appends the full original request URI after the host.

2. Step 2: Apply to example

   Using proxy_pass http://backend.local; inside location /app/ sends requests like /app/data as http://backend.local/app/data, preserving the prefix.

3. Final Answer:

   proxy_pass http://backend.local; -> Option D

4. Quick Check:

   No trailing slash keeps original URI prefix [OK]

Hint: No trailing slash keeps full original URI [OK]

Common Mistakes:

• Adding trailing slash removes original prefix
• Appending /app/ twice causing duplication
• Missing scheme in proxy_pass URL