File Name
README.md

Directory Lister

License Build Status StyleCI Join our Community Become a Sponsor One-time Donation


Directory Lister is the easiest way to expose the contents of any web-accessible folder for browsing and sharing. With a zero configuration, drag-and-drop installation you'll be up and running in less than a minute.

Features

  • Simple installation allows you to be up and running in less than a minute.
  • Light and dark themes to suit your professional needs or personal style.
  • Custom sort ordering gives you control of the ordering of your files/folders.
  • File search helps you locate the files you need quickly and efficiently.
  • File hashes instill confidence when downloading files through verification.
  • Readme rendering allows exposing the contents of READMEs directly on the page.
  • Zip downloads for fetching an entire directory of files in a single action.
  • Multi-lingual support brings Directory Lister to the language of your choice.

Requirements

  • Directory Lister requires PHP >= 7.2
    • The Zip extension is required for zip downloads
    • The DOM and Fileinfo extensions are required for README rendering

Installation

  1. Download Directory Lister
  2. Extract the zip/tar archive
  3. Copy extracted files/folders to your web server

Configuration

  1. Copy .env.example to .env
  2. Edit the configuration values in .env

See the Config Reference for more information about individual options.

Changelog

A list of changes can be found on the GitHub Releases page.

Troubleshooting

See the Common Issues page for a list of common issues and help in solving them.

For general help and support join our Spectrum Community or reach out on Twitter.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.