Request/response transformation in Nginx - Mini Project: Build & Apply

Request and Response Transformation with Nginx

📖 Scenario: You are setting up a simple web server using Nginx. You want to transform incoming requests and outgoing responses to meet specific needs.For example, you want to add a custom header to all responses and rewrite certain request URLs.

🎯 Goal: Build an Nginx configuration that rewrites request URLs starting with /oldpath to /newpath, and adds a custom response header X-Custom-Header: DevOpsProject to all responses.

📋 What You'll Learn

Create a basic Nginx server block listening on port 8080

Rewrite requests from /oldpath to /newpath

Add a custom response header X-Custom-Header: DevOpsProject

Serve static files from /usr/share/nginx/html

💡 Why This Matters

🌍 Real World

Web servers often need to modify requests and responses to support legacy URLs, add security headers, or customize content delivery.

💼 Career

Understanding Nginx request and response transformations is essential for DevOps roles managing web infrastructure and improving application delivery.

1

Create a basic Nginx server block

Write an Nginx server block that listens on port 8080 and serves files from /usr/share/nginx/html. Name the server block server and include the listen and root directives.

Nginx

# Your code here

Hint

Use server { ... } block with listen 8080; and root /usr/share/nginx/html;.

2

Add URL rewrite rule

Inside the existing server block, add a location /oldpath block that rewrites requests to /newpath using the rewrite directive with a permanent redirect.

Nginx

server {
    listen 8080;
    root /usr/share/nginx/html;
    # Your code here
}

Hint

Use location /oldpath { rewrite ^/oldpath(.*)$ /newpath$1 permanent; } inside the server block.

3

Add custom response header

Inside the server block, add the directive add_header X-Custom-Header "DevOpsProject"; to add a custom header to all responses.

Nginx

server {
    listen 8080;
    root /usr/share/nginx/html;

    location /oldpath {
        rewrite ^/oldpath(.*)$ /newpath$1 permanent;
    }
    # Your code here
}

Hint

Add add_header X-Custom-Header "DevOpsProject"; inside the server block but outside location blocks.

4

Test and display the final configuration

Print the entire Nginx configuration you wrote so far to verify it includes the server block with listen 8080;, root /usr/share/nginx/html;, the location /oldpath rewrite, and the add_header directive.

Nginx

# Your code here to print the configuration

Hint

Print the full configuration text exactly as written.

Practice

1. What is the main purpose of request/response transformation in nginx?

easy

A. To block all incoming requests

B. To increase the server's hardware capacity

C. To change the server's IP address automatically

D. To modify data passing through nginx for better communication

Solution

1. Step 1: Understand request/response transformation

   This process changes data in requests or responses to improve how clients and servers communicate.

2. Step 2: Identify the main goal in nginx context

   nginx uses this to modify headers, URLs, or content to suit needs, not hardware or blocking.

3. Final Answer:

   To modify data passing through nginx for better communication -> Option D

4. Quick Check:

   Transformation means changing data flow [OK]

Hint: Transformation means changing data in requests or responses [OK]

Common Mistakes:

• Confusing transformation with hardware upgrades
• Thinking it blocks requests instead of modifying them
• Assuming it changes server IP automatically

2. Which nginx directive is used to modify request headers before passing to the backend?

easy

A. add_header

B. proxy_set_header

C. rewrite

D. gzip_disable

Solution

1. Step 1: Identify directives for header modification

   proxy_set_header changes headers sent to the backend server.

2. Step 2: Differentiate from other directives

   add_header adds headers to responses, rewrite changes URLs, gzip_disable disables compression.

3. Final Answer:

   proxy_set_header -> Option B

4. Quick Check:

   Request header modification = proxy_set_header [OK]

Hint: Use proxy_set_header to change request headers [OK]

Common Mistakes:

• Using add_header which affects response headers
• Confusing rewrite with header modification
• Trying gzip_disable for headers

3. Given this nginx config snippet, what will be the response header X-Transformed value?

location / {
  proxy_pass http://backend;
  proxy_set_header X-Original $http_x_original;
  add_header X-Transformed "Yes";
}

medium

A. Yes

B. $http_x_original

C. No

D. X-Original

Solution

1. Step 1: Understand add_header directive effect

   add_header adds or modifies response headers sent to the client; here it sets X-Transformed to "Yes".

2. Step 2: Differentiate proxy_set_header role

   proxy_set_header modifies request headers sent to backend, not response headers.

3. Final Answer:

   Yes -> Option A

4. Quick Check:

   add_header sets response header = Yes [OK]

Hint: add_header controls response headers, proxy_set_header controls request headers [OK]

Common Mistakes:

• Confusing request and response headers
• Expecting variable names as header values
• Ignoring add_header effect

4. You want to modify the response body in nginx but changes don't appear. What is the likely cause?

medium

A. gzip compression is enabled, preventing body modification

B. proxy_pass directive is missing

C. add_header directive is used incorrectly

D. server block is missing listen directive

Solution

1. Step 1: Understand response body modification requirements

   Modifying response body requires disabling gzip compression because compressed data can't be changed easily.

2. Step 2: Identify common misconfigurations

   If gzip is enabled, changes won't show; proxy_pass or listen missing causes other errors, add_header affects headers only.

3. Final Answer:

   gzip compression is enabled, preventing body modification -> Option A

4. Quick Check:

   Disable gzip to modify response body [OK]

Hint: Disable gzip to allow response body changes [OK]

Common Mistakes:

• Ignoring gzip compression effect
• Confusing header directives with body changes
• Assuming missing proxy_pass causes this issue

5. You want to rewrite incoming URLs from /old-path/ to /new-path/ and add a response header X-Updated: true. Which nginx config snippet correctly does both?

hard

A. location /old-path/ {
rewrite ^/old-path/(.*)$ /new-path/$1 permanent;
add_header X-Updated true;
proxy_pass http://backend;
}

B. location /old-path/ {
proxy_pass http://backend;
add_header X-Updated true;
rewrite ^/old-path/(.*)$ /new-path/$1 break;
}

C. location /old-path/ {
rewrite ^/old-path/(.*)$ /new-path/$1 break;
add_header X-Updated true;
proxy_pass http://backend;
}

D. location /new-path/ {
rewrite ^/old-path/(.*)$ /new-path/$1 break;
add_header X-Updated true;
proxy_pass http://backend;
}

Solution

1. Step 1: Choose correct location and rewrite usage

   Rewrite must be inside location matching /old-path/ to rewrite URLs internally with 'break' to stop processing.

2. Step 2: Add response header and proxy_pass correctly

   add_header adds header to response; proxy_pass forwards request to backend after rewrite.

3. Step 3: Identify incorrect options

   The config

   location /old-path/ {
     proxy_pass http://backend;
     add_header X-Updated true;
     rewrite ^/old-path/(.*)$ /new-path/$1 break;
   }

   places rewrite after proxy_pass (ignored). Configs using location /new-path/ have the wrong location. Configs with permanent cause redirects, not internal rewrites.

4. Final Answer:

   location /old-path/ { rewrite ^/old-path/(.*)$ /new-path/$1 break; add_header X-Updated true; proxy_pass http://backend; } -> Option C

5. Quick Check:

   Internal rewrite + header + proxy_pass = location /old-path/ { rewrite ^/old-path/(.*)$ /new-path/$1 break; add_header X-Updated true; proxy_pass http://backend; } [OK]

Hint: Use rewrite with break inside correct location before proxy_pass [OK]

Common Mistakes:

• Using permanent instead of break for internal rewrite
• Placing rewrite after proxy_pass
• Using wrong location block for rewrite