Bird
Raised Fist0
Nginxdevops~5 mins

Directory listing (autoindex) in Nginx - Commands & Configuration

Choose your learning style10 modes available
LearnWhyDeepVisualTryChallengeProjectRecallTime

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Introduction
Sometimes you want to see all files inside a folder on your web server when no specific file is requested. Directory listing, also called autoindex, lets your web server show a list of files in a folder automatically.
When you want to share files in a folder over the web without creating a webpage for each file.
When you need to quickly check which files are inside a web directory from a browser.
When you want to enable browsing of logs or reports stored in a server folder.
When you are developing and want to see all static files available in a directory.
When you want to provide downloads of multiple files without a custom interface.
Config File - nginx.conf
nginx.conf
server {
    listen 8080;
    server_name localhost;

    location /files/ {
        root /var/www/html;
        autoindex on;
        autoindex_exact_size off;
        autoindex_localtime on;
    }
}

This configuration creates a server listening on port 8080.

The location /files/ block points to the folder /var/www/html/files/ on the server.

autoindex on; enables directory listing for this location.

autoindex_exact_size off; shows file sizes in a human-friendly format (KB, MB).

autoindex_localtime on; shows file times in local time instead of GMT.

Commands
Check the nginx configuration file for syntax errors before applying changes.
Terminal
sudo nginx -t
Expected OutputExpected
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful
Reload nginx to apply the new configuration without stopping the server.
Terminal
sudo systemctl reload nginx
Expected OutputExpected
No output (command runs silently)
Request the directory URL to see the autoindex directory listing in the terminal.
Terminal
curl http://localhost:8080/files/
Expected OutputExpected
<html> <head><title>Index of /files/</title></head> <body bgcolor="white"> <h1>Index of /files/</h1><hr><pre><a href="file1.txt">file1.txt</a> 01-Jan-2024 10:00 1.2K <a href="image.png">image.png</a> 02-Jan-2024 11:30 45K </pre><hr></body> </html>
Key Concept

If you remember nothing else from this pattern, remember: enabling autoindex in nginx lets users see a list of files in a folder when no index file is present.

Common Mistakes
Forgetting to reload nginx after changing the config file.
The new settings won't take effect until nginx reloads the configuration.
Always run 'sudo systemctl reload nginx' after editing nginx.conf.
Setting the wrong root path in the location block.
Nginx will look in the wrong folder and show a 404 error or empty listing.
Make sure the root path plus the location path matches the actual folder on disk.
Not enabling autoindex directive or setting it to off.
Nginx will not show directory listings and may return a 403 forbidden error.
Set 'autoindex on;' inside the location block to enable directory listing.
Summary
Edit nginx.conf to add a location block with 'autoindex on;' to enable directory listing.
Test the configuration syntax with 'nginx -t' before reloading.
Reload nginx to apply changes and then access the directory URL to see the file list.

Practice

(1/5)
1. What does the autoindex on; directive do in an nginx server block?
easy
A. It enables directory listing so users can see files in a folder via browser.
B. It disables access to all files in the directory.
C. It compresses files before sending to the client.
D. It redirects requests to another server.

Solution

  1. Step 1: Understand the purpose of autoindex

    The autoindex directive controls whether nginx shows a list of files in a directory when no index file is found.

  2. Step 2: Effect of autoindex on;

    Setting it to on enables directory listing, allowing users to browse files via a web browser.

  3. Final Answer:

    It enables directory listing so users can see files in a folder via browser. -> Option A

  4. Quick Check:

    autoindex on = directory listing enabled [OK]
Hint: autoindex on means show files in folder via browser [OK]
Common Mistakes:
  • Thinking autoindex disables access
  • Confusing autoindex with compression
  • Assuming autoindex redirects requests
2. Which of the following is the correct syntax to enable directory listing in nginx?
easy
A. autoindex enable;
B. autoindex on;
C. autoindex true;
D. autoindex yes;

Solution

  1. Step 1: Recall nginx directive syntax

    nginx directives use specific keywords; for enabling autoindex, the keyword is on.

  2. Step 2: Identify correct keyword

    Only autoindex on; is valid syntax. Others like enable, true, or yes are invalid.

  3. Final Answer:

    autoindex on; -> Option B

  4. Quick Check:

    Correct syntax = autoindex on; [OK]
Hint: Use 'on' to enable autoindex, not 'enable' or 'yes' [OK]
Common Mistakes:
  • Using 'enable' instead of 'on'
  • Using 'yes' or 'true' which are invalid
  • Missing semicolon at end
3. Given this nginx config snippet inside a server block:
location /files/ {
    autoindex on;
    autoindex_exact_size off;
    autoindex_localtime on;
}

What will the directory listing show regarding file sizes and timestamps?
medium
A. File sizes in human-readable format and timestamps in local time.
B. File sizes in bytes and timestamps in UTC time.
C. File sizes hidden and timestamps not shown.
D. File sizes in human-readable format and timestamps in UTC time.

Solution

  1. Step 1: Understand autoindex_exact_size off;

    This setting shows file sizes in human-readable format (e.g., KB, MB) instead of bytes.

  2. Step 2: Understand autoindex_localtime on;

    This setting shows file timestamps in the server's local time zone, not UTC.

  3. Final Answer:

    File sizes in human-readable format and timestamps in local time. -> Option A

  4. Quick Check:

    autoindex_exact_size off + autoindex_localtime on = human sizes + local time [OK]
Hint: Exact size off = human sizes; localtime on = local timestamps [OK]
Common Mistakes:
  • Assuming sizes always show in bytes
  • Thinking timestamps are always UTC
  • Confusing off/on meaning for these directives
4. You enabled autoindex on; but directory listing still does not show. Which is the most likely cause?
medium
A. The server block is missing the listen directive.
B. The autoindex directive is misspelled as autoindx.
C. The directory has an index.html file present.
D. The autoindex directive must be inside http block only.

Solution

  1. Step 1: Check nginx directory listing behavior

    nginx shows directory listing only if no index file (like index.html) exists in the directory.

  2. Step 2: Identify why listing is not shown

    If an index file is present, nginx serves it instead of showing directory listing, even if autoindex on; is set.

  3. Final Answer:

    The directory has an index.html file present. -> Option C

  4. Quick Check:

    Index file present blocks directory listing [OK]
Hint: Index files override autoindex directory listing [OK]
Common Mistakes:
  • Assuming misspelling causes no effect (it causes error)
  • Thinking autoindex must be in http block only
  • Ignoring presence of index files
5. You want to allow users to browse files in /var/www/public via nginx with directory listing enabled, showing file sizes in human-readable format and timestamps in local time. Which configuration snippet inside the server block is correct?
hard
A. location /public/ { root /var/www/public; autoindex on; autoindex_exact_size on; autoindex_localtime off; }
B. location /public/ { root /var/www; autoindex off; autoindex_exact_size off; autoindex_localtime on; }
C. location /public/ { alias /var/www/public; autoindex off; autoindex_exact_size off; autoindex_localtime on; }
D. location /public/ { root /var/www; autoindex on; autoindex_exact_size off; autoindex_localtime on; }

Solution

  1. Step 1: Choose correct root and enable autoindex

    Using root /var/www; with location /public/ serves files from /var/www/public. autoindex on; enables directory listing.

  2. Step 2: Set human-readable sizes and local timestamps

    autoindex_exact_size off; shows sizes in human-readable format, and autoindex_localtime on; shows timestamps in local time.

  3. Final Answer:

    location /public/ { root /var/www; autoindex on; autoindex_exact_size off; autoindex_localtime on; } -> Option D

  4. Quick Check:

    Correct root + autoindex on + human sizes + local time = location /public/ { root /var/www; autoindex on; autoindex_exact_size off; autoindex_localtime on; } [OK]
Hint: Use root with path prefix; autoindex on + exact_size off + localtime on [OK]
Common Mistakes:
  • Using alias incorrectly with root paths
  • Turning autoindex off disables listing
  • Setting exact_size on shows bytes, not human sizes