Include directive for modular config in Nginx - Mini Project: Build & Apply

Using the Include Directive for Modular Nginx Configuration

📖 Scenario: You are managing a web server using Nginx. To keep your configuration clean and easy to maintain, you want to split your main configuration into smaller files. This helps when you add or change settings later.

🎯 Goal: Learn how to use the include directive in Nginx to modularize your configuration files. You will create a main config file and include a separate file with server settings.

📋 What You'll Learn

Create a main Nginx configuration file named nginx.conf with basic settings.

Create a separate file named server.conf with server block configuration.

Use the include directive in nginx.conf to load server.conf.

Verify the configuration is correctly included by printing the combined config.

💡 Why This Matters

🌍 Real World

Web servers often have many sites and settings. Splitting config files helps teams work together and update settings safely.

💼 Career

Knowing how to modularize Nginx configs is a key skill for DevOps engineers managing web infrastructure.

1

Create the main Nginx configuration file

Create a file named nginx.conf with the following content exactly: a worker_processes 1; directive and an empty http { } block.

Nginx

# Create nginx.conf with worker_processes and empty http block
# Your code here

Hint

Start with worker_processes 1; on top, then add http { } below it.

2

Create the server configuration file

Create a file named server.conf with a server block that listens on port 80 and has a server_name example.com; directive.

Nginx

worker_processes 1;

http {

}

# Create server.conf with server block listening on port 80 and server_name example.com
# Your code here

Hint

Write a server { } block with listen 80; and server_name example.com; inside.

3

Include the server configuration in the main config

Modify nginx.conf to include the server.conf file inside the http block using the include server.conf; directive.

Nginx

worker_processes 1;

http {

    # Add include directive here
    # Your code here
}

server {
    listen 80;
    server_name example.com;
}

Hint

Inside the http { } block, add include server.conf; on its own line.

4

Print the combined Nginx configuration

Print the contents of nginx.conf to show the full configuration including the included server block.

Nginx

# Print the nginx.conf content
# Your code here

Hint

Use a print statement to output the exact content of nginx.conf including the include directive.

Practice

1. What is the main purpose of the include directive in nginx configuration?

easy

A. To define a new server block

B. To start the nginx server

C. To insert the contents of another configuration file into the current file

D. To reload the nginx configuration without downtime

Solution

1. Step 1: Understand the role of include directive

   The include directive is used to insert the contents of one file into another configuration file.

2. Step 2: Compare with other options

   Starting the server, defining server blocks, or reloading configs are done by other commands or directives, not include.

3. Final Answer:

   To insert the contents of another configuration file into the current file -> Option C

4. Quick Check:

   Include directive = insert config file [OK]

Hint: Include means 'add file content here' in config [OK]

Common Mistakes:

• Confusing include with server start commands
• Thinking include defines servers or reloads configs
• Assuming include runs commands instead of inserting files

2. Which of the following is the correct syntax to include all configuration files ending with .conf from the /etc/nginx/conf.d/ directory?

easy

A. include /etc/nginx/conf.d/*.conf;

B. include /etc/nginx/conf.d/*.conf

C. include /etc/nginx/conf.d/*.conf();

D. include /etc/nginx/conf.d/*.conf{};

Solution

1. Step 1: Recall nginx include syntax

   The correct syntax requires the path with wildcard and ends with a semicolon: include path/*.conf;.

2. Step 2: Compare options to correct syntax

   The valid syntax is include /etc/nginx/conf.d/*.conf;. Syntax with parentheses, missing semicolon, or extra braces causes parsing errors.

3. Final Answer:

   include /etc/nginx/conf.d/*.conf; -> Option A

4. Quick Check:

   Include syntax ends with semicolon [OK]

Hint: Include paths always end with a semicolon in nginx [OK]

Common Mistakes:

• Omitting the semicolon at the end
• Adding parentheses or braces incorrectly
• Using wrong wildcard syntax

3. Given this nginx config snippet:

http {
    include /etc/nginx/mime.types;
    include /etc/nginx/conf.d/*.conf;
}

What happens when nginx loads this configuration?

medium

A. It inserts the contents of mime.types and all .conf files from conf.d into the http block

B. It ignores the include directives because they are inside http

C. It only loads mime.types but not the files in conf.d

D. It throws a syntax error because multiple includes are not allowed

Solution

1. Step 1: Understand include behavior inside blocks

   Include inserts file contents exactly where placed, even inside blocks like http.

2. Step 2: Analyze the given includes

   Both mime.types and all .conf files in conf.d are included inside http, so their contents become part of http.

3. Final Answer:

   It inserts the contents of mime.types and all .conf files from conf.d into the http block -> Option A

4. Quick Check:

   Include inserts files where placed [OK]

Hint: Include works anywhere in config blocks [OK]

Common Mistakes:

• Thinking include only works at top level
• Assuming include causes syntax errors with multiple files
• Believing include ignores wildcards inside blocks

4. You wrote this in your nginx config:

include /etc/nginx/conf.d/*.conf

But nginx fails to start with a syntax error. What is the most likely cause?

medium

A. The wildcard *.conf is not supported in include

B. Missing semicolon at the end of the include directive

C. The path must be relative, not absolute

D. Include directive cannot be used inside http block

Solution

1. Step 1: Check syntax rules for include

   Every nginx directive must end with a semicolon; missing it causes syntax errors.

2. Step 2: Validate other options

   Wildcards are supported, absolute paths are allowed, and include works inside http.

3. Final Answer:

   Missing semicolon at the end of the include directive -> Option B

4. Quick Check:

   Every directive ends with semicolon [OK]

Hint: Always end include lines with semicolon [OK]

Common Mistakes:

• Forgetting the semicolon at line end
• Thinking wildcards are invalid
• Assuming include only works outside blocks

5. You want to organize your nginx config by splitting server blocks into separate files inside /etc/nginx/sites-enabled/. Which is the best way to include all these files in your main nginx.conf?

hard

A. Add include /etc/nginx/sites-enabled/*.conf; inside the server block

B. Add include /etc/nginx/sites-enabled/*.conf; outside any block at the top of nginx.conf

C. Add include /etc/nginx/sites-enabled/*.conf; inside the events block

D. Add include /etc/nginx/sites-enabled/*.conf; inside the http block

Solution

1. Step 1: Understand where server blocks belong

   Server blocks must be inside the http block in nginx configuration.

2. Step 2: Determine correct include placement

   Including all server config files inside http ensures they are loaded properly. Including outside blocks or inside events or server blocks is invalid.

3. Final Answer:

   Add include /etc/nginx/sites-enabled/*.conf; inside the http block -> Option D

4. Quick Check:

   Server blocks go inside http block [OK]

Hint: Include server configs inside http block [OK]

Common Mistakes:

• Placing include outside http block
• Including inside events block
• Trying to include inside a server block