Skip to content

Nginx File Directory
Nginx File Directory

The Nginx file directory listing page, as a single static HTML file you can drop anywhere.

Docker State GitHub Pages State Gitleaks State GitHub Version GitHub Issues GitHub Pull Requests

Key FeaturesInstallationUsageDocumentationSupportContributingCreditsAttributionLicense

screenshot

Key Features

  • The Nginx directory listing, as static HTML — 21 lines, start to finish.
  • Name and modified date, matching Nginx's minimal autoindex output.
  • Folder and file links.
  • No icons, no stylesheet, no scripts, no dependencies.
  • Works on any web server, or as a GitHub Pages site.
  • Also published as a container image.

Installation

git clone https://github.com/willtheorangeguy/Nginx-File-Directory.git
cd Nginx-File-Directory

Then open index.html in a browser. There is nothing to install — see docs/quickstart.md.

Usage

Edit index.html: set the title, then add a line per file or folder inside the <pre> block. docs/usage.md walks through it.

Documentation

Full documentation lives in docs/: Quickstart · Installation · Usage · Configuration · Architecture · Deployment · FAQ · Troubleshooting · Roadmap

Support

Open a GitHub Discussion or file an issue.

Contributing

Contributions welcome. See the org-wide Contributing Guide and Code of Conduct.

Credits

This software uses the following open source packages, projects, services or websites:

GitHub W3C W3Schools Nginx
GitHub W3C W3Schools Nginx
Web - Plans Web - Donate Web - Pro Web

Attribution

The page this reproduces is the work of the Nginx Development Team and the Nginx Authors. Nginx is released under a BSD-style licence; the upstream notice is preserved in LICENSE_nginx.md and in the header of index.html.

License

BSD 2-Clause — see LICENSE.md. Also see the Privacy Policy and Terms and Conditions.

About

The basic Nginx file directory page, as a simple HTML page.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages