Index directive in Nginx - Mini Project: Build & Apply

Setting Up the Index Directive in Nginx

📖 Scenario: You are configuring a web server using Nginx. You want to make sure that when users visit your website's root URL, the server automatically serves the homepage file without needing to specify the filename in the URL.

🎯 Goal: Configure the Nginx server to use the index directive so that it serves index.html as the default page when a directory is requested.

📋 What You'll Learn

Create a server block with a root directory set to /var/www/html.

Add an index directive inside the server block to specify index.html as the default file.

Ensure the configuration syntax is correct and the server block is properly closed.

Use exact directive names and values as specified.

💡 Why This Matters

🌍 Real World

Web servers often need to serve a default homepage file when users visit a website without specifying a file name.

💼 Career

Knowing how to configure the index directive in Nginx is essential for web server administrators and backend engineers to ensure smooth user experience.

1

Create the basic server block with root directory

Write a server block that listens on port 80 and sets the root directory to /var/www/html. Use the exact syntax: server {, listen 80;, and root /var/www/html;.

Nginx

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

Hint

Remember to open the server block with server { and close it with }.

2

Add the index directive inside the server block

Inside the existing server block, add the index directive with the value index.html. Use the exact syntax: index index.html;.

Nginx

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

Hint

The index directive tells Nginx which file to serve by default when a directory is requested.

3

Verify the server block syntax and completeness

Make sure the server block includes listen 80;, root /var/www/html;, and index index.html; directives, and that the block is properly closed with }.

Nginx

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

Hint

Check that all directives are inside the server block and the block is closed.

4

Complete the Nginx configuration with the index directive

Confirm the full server block configuration includes listen 80;, root /var/www/html;, and index index.html; directives, and is enclosed within server { ... }.

Nginx

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

Hint

This is the final step to ensure your Nginx server block is correctly set up to serve index.html by default.

Practice

1.

What is the main purpose of the index directive in nginx?

easy

A. To specify default files to serve when a directory is requested

B. To set the server's IP address

C. To configure SSL certificates

D. To define error pages

Solution

1. Step 1: Understand the role of the index directive

   The index directive tells nginx which files to look for by default when a user requests a directory URL.

2. Step 2: Match the purpose with the options

   Only To specify default files to serve when a directory is requested describes setting default files to serve in a folder, which matches the index directive's function.

3. Final Answer:

   To specify default files to serve when a directory is requested -> Option A

4. Quick Check:

   index directive = default files [OK]

Hint: Index sets default homepage files for folders [OK]

Common Mistakes:

• Confusing index with server IP settings
• Thinking index sets error pages
• Mixing index with SSL configuration

2.

Which of the following is the correct syntax to set index.html and home.html as default files using the index directive?

?

easy

A. index: index.html; home.html;

B. index = index.html, home.html;

C. index { index.html home.html }

D. index index.html home.html;

Solution

1. Step 1: Recall nginx index directive syntax

   The correct syntax lists files separated by spaces, ending with a semicolon.

2. Step 2: Compare options with correct syntax

   index index.html home.html; matches the correct syntax: index index.html home.html;. Others use invalid punctuation or braces.

3. Final Answer:

   index index.html home.html; -> Option D

4. Quick Check:

   Correct syntax = index index.html home.html; [OK]

Hint: List files with spaces, end with semicolon [OK]

Common Mistakes:

• Using commas between filenames
• Using braces or colons incorrectly
• Adding equal signs in directive

3.

Given this nginx config snippet:

location / {
    index about.html index.html;
}

If the folder contains index.html but not about.html, which file will nginx serve when a user visits /?

medium

A. 404 Not Found error

B. about.html

C. index.html

D. Directory listing

Solution

1. Step 1: Understand index file priority

   nginx tries files in order: first about.html, then index.html.

2. Step 2: Check which files exist

   about.html is missing, but index.html exists, so nginx serves index.html.

3. Final Answer:

   index.html -> Option C

4. Quick Check:

   First found file served = index.html [OK]

Hint: nginx serves first existing file in index list [OK]

Common Mistakes:

• Assuming nginx serves first listed file regardless of existence
• Expecting directory listing if first file missing
• Thinking nginx returns error immediately

4.

Identify the error in this nginx config snippet:

location / {
    index index.html, home.html;
}

medium

A. Missing semicolon at the end

B. Using a comma between filenames is invalid syntax

C. index directive cannot be used inside location block

D. File names must be in quotes

Solution

1. Step 1: Check syntax for index directive

   File names must be separated by spaces, not commas.

2. Step 2: Identify the error in the snippet

   The comma between index.html and home.html is invalid syntax.

3. Final Answer:

   Using a comma between filenames is invalid syntax -> Option B

4. Quick Check:

   No commas allowed in index list [OK]

Hint: Separate files with spaces, no commas [OK]

Common Mistakes:

• Adding commas between filenames
• Omitting semicolon
• Thinking quotes are required

5.

You want nginx to serve main.html as the default file, but only if index.html is missing. Which index directive correctly achieves this?

hard

A. index index.html main.html;

B. index main.html index.html;

C. index main.html;

D. index index.html;

Solution

1. Step 1: Understand index file priority order

   nginx serves the first existing file in the list from left to right.

2. Step 2: Choose order to serve main.html only if index.html missing

   To serve main.html only if index.html is missing, index.html must be first, then main.html.

3. Final Answer:

   index index.html main.html; -> Option A

4. Quick Check:

   First existing file served = index.html then main.html [OK]

Hint: List index.html first to prefer it over main.html [OK]

Common Mistakes:

• Reversing file order
• Listing only one file
• Expecting nginx to skip files in order