Nested location blocks in Nginx - Mini Project: Build & Apply

Nested location blocks

📖 Scenario: You are setting up a simple web server using nginx. You want to serve different content based on the URL path. For example, the root path should show a welcome page, and a subpath should serve a special section with its own rules.

🎯 Goal: Build an nginx configuration with nested location blocks. The main location / serves the homepage, and a nested location /admin/ serves admin pages with a different root directory.

📋 What You'll Learn

Create a server block listening on port 80

Add a location / block with root /var/www/html

Add a nested location /admin/ block inside location / with root /var/www/admin

Print the final configuration to verify the nested blocks

💡 Why This Matters

🌍 Real World

Web servers often need to serve different content or apply different rules based on URL paths. Nested location blocks help organize these rules clearly.

💼 Career

Understanding <code>nginx</code> configuration and nested location blocks is essential for DevOps roles managing web servers and deploying applications.

1

Create the basic server block

Create an nginx server block that listens on port 80. Inside it, add a location / block with the root directory set to /var/www/html.

Nginx

server {
    listen 80;
    # Your code here
}

Hint

Remember to open and close the server and location blocks with curly braces.

2

Add a nested location block for admin

Inside the existing location / block, add a nested location /admin/ block. Set its root directory to /var/www/admin.

Nginx

server {
    listen 80;
    location / {
        root /var/www/html;
        # Your code here
    }
}

Hint

Place the location /admin/ block inside the location / block.

3

Add an index directive to the root location

Inside the location / block, add an index directive with the value index.html to serve the homepage file.

Nginx

server {
    listen 80;
    location / {
        root /var/www/html;
        # Your code here
        location /admin/ {
            root /var/www/admin;
        }
    }
}

Hint

The index directive tells nginx which file to serve by default in a directory.

4

Print the final nginx configuration

Print the entire nginx configuration to verify the nested location blocks and directives.

Nginx

# Print the nginx configuration below
# Your code here

Hint

Since this is a configuration file, printing means showing the full text content.

Practice

1. What is the main purpose of using nested location blocks in an nginx configuration?

easy

A. To automatically update nginx software

B. To increase server hardware performance

C. To organize URL handling inside parent paths for clearer rules

D. To disable logging for specific URLs

Solution

1. Step 1: Understand the role of location blocks

   Location blocks define how nginx handles requests for specific URL paths.

2. Step 2: Recognize the benefit of nesting

   Nested location blocks allow specific rules for sub-paths without repeating the parent path, making configuration clearer.

3. Final Answer:

   To organize URL handling inside parent paths for clearer rules -> Option C

4. Quick Check:

   Nested location blocks = organize URL handling [OK]

Hint: Nested blocks group URL rules under parent paths [OK]

Common Mistakes:

• Thinking nested blocks improve hardware speed
• Confusing nested blocks with software updates
• Assuming nested blocks disable logging

2. Which of the following is the correct syntax to define a nested location block inside location /app/ in nginx?

easy

A. location /app/ { location api/ { proxy_pass http://backend; } }

B. location /app/ { location /appapi/ { proxy_pass http://backend; } }

C. location /app/ { location /app/api/ { proxy_pass http://backend; } }

D. location /app/ { location /api/ { proxy_pass http://backend; } }

Solution

1. Step 1: Check nested location path relative to parent

   Nested location inside location /app/ should define sub-paths relative to /app/, so api/ without leading slash is correct.

2. Step 2: Validate syntax correctness

   location /app/ { location api/ { proxy_pass http://backend; } } uses location api/ inside location /app/, which is valid and clear.

3. Final Answer:

   location /app/ { location api/ { proxy_pass http://backend; } } -> Option A

4. Quick Check:

   Nested path is relative and omits leading slash [OK]

Hint: Nested location paths omit parent prefix and leading slash inside block [OK]

Common Mistakes:

• Repeating full parent path in nested location
• Missing leading slash in nested path
• Combining parent and child paths incorrectly

3. Given this nginx config snippet:

location /shop/ {
  root /var/www/html;
  location /cart/ {
    proxy_pass http://cart_backend;
  }
}

What happens when a user requests /shop/cart/view?

medium

A. Request serves static file /var/www/html/shop/cart/view

B. Request is proxied to http://cart_backend/view

C. Request returns 404 Not Found

D. Request is proxied to http://cart_backend/shop/cart/view

Solution

1. Step 1: Identify matching location block

   Request /shop/cart/view matches nested location /cart/ inside location /shop/.

2. Step 2: Understand proxy_pass behavior

   Proxy_pass inside nested block forwards request path after /cart/, so /view is sent to http://cart_backend.

3. Final Answer:

   Request is proxied to http://cart_backend/view -> Option B

4. Quick Check:

   Nested proxy_pass strips matched prefix [OK]

Hint: Nested proxy_pass forwards sub-path after nested location [OK]

Common Mistakes:

• Assuming static file serving instead of proxy
• Including full original path in proxy_pass
• Expecting 404 due to nested block

4. Identify the error in this nginx config snippet:

location /api/ {
  location /v1/ {
    proxy_pass http://api_v1_backend;
  }
  location /v2/ {
    proxy_pass http://api_v2_backend;
  }
}

medium

A. Nested location blocks cannot be used inside another location

B. No error; configuration is valid

C. proxy_pass URLs must include trailing slash

D. Nested location paths should not start with a slash

Solution

1. Step 1: Recall nested location path syntax

   Nested location paths inside a parent location should be relative and not start with a slash.

2. Step 2: Check given nested paths

   Nested locations use /v1/ and /v2/ starting with slash, which is incorrect.

3. Final Answer:

   Nested location paths should not start with a slash -> Option D

4. Quick Check:

   Nested paths omit leading slash [OK]

Hint: Nested location paths omit leading slash [OK]

Common Mistakes:

• Thinking nested locations are disallowed
• Believing proxy_pass must have trailing slash
• Assuming config is valid as is

5. You want to serve static files from /var/www/app for /app/ URLs, but proxy API requests under /app/api/ to http://api_backend. Which nested location block setup is correct?

hard

A. location /app/ { root /var/www/app; location api/ { proxy_pass http://api_backend; } }

B. location /app/ { root /var/www/app; location /api/ { proxy_pass http://api_backend; } }

C. location /app/ { root /var/www/app; location /app/api/ { proxy_pass http://api_backend; } }

D. location /app/ { root /var/www/app; location /appapi/ { proxy_pass http://api_backend; } }

Solution

1. Step 1: Set root for /app/ static files

   Use root /var/www/app; inside location /app/ to serve static files.

2. Step 2: Define nested location for API proxy

   Nested location for /app/api/ should be location api/ without leading slash inside location /app/.

3. Step 3: Verify proxy_pass target

   Proxy_pass points to http://api_backend correctly.

4. Final Answer:

   location /app/ { root /var/www/app; location api/ { proxy_pass http://api_backend; } } -> Option A

5. Quick Check:

   Nested path omits /, root set for static, proxy for api [OK]

Hint: Nested location paths omit leading slash; root applies to parent [OK]

Common Mistakes:

• Repeating full path in nested location
• Using leading slash in nested location
• Misplacing root directive inside nested block