Include directive for modular config in Nginx - Step-by-Step Execution

Process Flow - Include directive for modular config

Start nginx config

↓

Read main config file

↓

Find include directive?

No→Continue parsing

Yes↓

Load included file(s)

↓

Parse included file(s)

↓

Merge settings

↓

Complete config parsing

↓

Start nginx with full config

Nginx reads the main config file, finds include directives, loads and parses included files, then merges all settings before starting.

Execution Sample

Nginx

http {
    include mime.types;
    server {
        listen 80;
    }
}

This config includes the mime.types file inside the http block, then defines a server listening on port 80.

Process Table

Step	Action	File Processed	Directive Found	Result
1	Start parsing main config	nginx.conf	No	Continue
2	Encounter include directive	nginx.conf	include mime.types;	Load mime.types file
3	Parse included file	mime.types	No	Add mime types to config
4	Return to main config	nginx.conf	No	Continue parsing
5	Parse server block	nginx.conf	No	Add server config
6	Finish parsing	nginx.conf + mime.types	No	Complete config
7	Start nginx with full config	N/A	N/A	Nginx running with merged config

💡 All config files parsed and merged; nginx starts with complete configuration.

Status Tracker

Variable	Start	After Step 2	After Step 3	After Step 5	Final
Config Content	Empty	Includes mime.types directive	mime.types content added	Server block added	Full merged config

Key Moments - 3 Insights

Why does nginx load another file when it sees the include directive?

Because the include directive tells nginx to read and merge the contents of the specified file into the current config, as shown in execution_table step 2 and 3.

What happens if the included file has errors?

Nginx will fail to start or reload because it parses included files as part of the main config, so errors in included files stop the whole config parsing (related to step 3).

Can include directives be nested?

Yes, included files can themselves contain include directives, and nginx will recursively load them until all are processed, similar to steps 2 and 3 repeated.

Visual Quiz - 3 Questions

Look at the execution table, at which step does nginx parse the included file?

A Step 2

B Step 3

C Step 5

D Step 7

💡 Hint

Check the 'File Processed' and 'Directive Found' columns in step 3.

According to the variable tracker, what is added to the config after step 3?

A Server block

B Empty config

C mime.types content

D Include directive

💡 Hint

Look at the 'Config Content' row after step 3 in variable_tracker.

If the include directive was missing, what would happen in the execution table?

A Step 2 would not find include directive and skip loading files

B Nginx would fail to start

C Step 3 would parse mime.types anyway

D Server block would not be parsed

💡 Hint

Refer to step 1 and 2 where include directive presence controls loading.

Concept Snapshot

Include directive in nginx config:
- Syntax: include filename;
- Used to modularize config by loading external files
- Nginx reads included files as part of main config
- Errors in included files affect whole config
- Supports nested includes for complex setups

Full Transcript

The include directive in nginx configuration allows splitting the main config into smaller files. When nginx parses the main config, it looks for include directives. Upon finding one, it loads and parses the specified file, merging its content into the main configuration. This process continues until all includes are resolved. This modular approach helps organize configuration and reuse common settings. Errors in any included file will cause nginx to fail to start or reload. The execution table shows step-by-step how nginx processes the main config and included files, while the variable tracker shows how the configuration content grows as files are included. Understanding this flow helps beginners grasp how nginx builds its full configuration from multiple files.

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