How can I create a simple index.html file which lists all files/directories?

Server-side solutions for dynamic directory listings

PHP: Your dynamic friend

If you're comfortable with PHP, consider using the opendir() and readdir() functions to create a dynamic file directory list:

<?php
$handle = opendir('.'); //Let PHP take a stroll in your directory
echo "<ul>";
while (false !== ($entry = readdir($handle))) {
  // PHP bouncer ensures uninvited '.' and '..' are not allowed in!
    if ($entry != "." && $entry != "..") {
        echo "<li><a href=\"./$entry\">$entry</a></li>"; //Make a list, check it twice
    }
}
echo "</ul>";
closedir($handle); //Don't forget to close the door behind!
?>


Place this PHP script in the directory where you want to list the files and make sure your server is configured to process PHP. Every time the page is accessed, the list gets regenerated.

Apache: The bouncer of your webpage

In an Apache server scenario, leverage the mod_autoindex module. First, ensure the module is active in your httpd.conf file. Then, you can use an .htaccess directive to tell Apache to generate automatic file listings:

Options +Indexes

This line instructs Apache to create directory listings for parent directories without an index.html or index.php file. The listings can be heavily customized further using mod_autoindex parameters.

Excluding the uninvited guests

Let's ignore specific files, such as .htaccess or index.php, when generating the index. Just use the IndexIgnore directive in your .htaccess file:

IndexIgnore .htaccess index.php

Directories look cleaner without the uninvited guests!

The powerful 'tree' command

Tree is a robust, command-line utility for creating directory trees in several different formats. Use it to generate an HTML file indexing your directory:

tree -H '.' -L 2 --noreport --charset utf-8 > index.html


This command generates an index.html file consisting of a directory tree with a depth of two levels. Change -L to a different number for greater or lesser depth.

Being picky with file types

You might want to include or exclude certain file types while indexing. Using -P lets you include only files matching specific patterns, while -I helps you exclude certain types:

tree -H '.' -P '*.html' --noreport --charset utf-8 > index.html


Better yet, generate your index in the JSON or XML format for client-side processing, allowing you to create custom user interfaces:

tree --matchdirs -J > files.json


Customizing your solution with Scripts

Python: Tailoring your listing

Python can be used to create highly customizeable solutions. Use the os.listdir function to list files, then utilize HTML templates with string formatting or template engines like Jinja2:

import os

directory_listing = os.listdir('.') //Allow Python to peep into your directory
html_content = "<ul>"
for item in directory_listing:
    if os.path.isfile(item):
        icon = '📄' //Files dressed as documents
    elif os.path.isdir(item):
        icon = '📁' //Directories wearing the folder costume
    html_content += f"<li><a href='{item}'>{icon} {item}</a></li>" //Look, Ma! Fancy list!
html_content += "</ul>"

with open('index.html', 'w') as f:
    f.write(html_content) //HTML content spilled onto the file


Recursion: Inception but for files

Combine the find and tree commands to recursively generate indices, improving performance over vast directories:

find . -type d -exec tree -H "{}" -L 1 --noreport --charset utf-8 > "{}/index.html" \;


Smoothing out your workflow

Utilizing a third-party solution: Celeron Dude Indexer

Celeron Dude Indexer simplifies index.html file generation in any directory. Just download the script from the official repository and run it to produce a clean index list. It's an effortless drag-and-drop solution!

Auto-setup process: Deployment

For automating server setups, employ configuration management tools such as Ansible or Puppet to enable directory listings and apply customizations to your infrastructure.