A fancy file directory listing plugin.
DirLister is a lightweight program that lists files and folders in a given web directory. The plugin is designed as a drop-in replacement for the default, often none-fancy directory listing that may be auto generated by the web server. This plugin allows you to easily display files and folders in an attractive and user friendly way, and is perfect for displaying files in a server on the client side for users to view or download.
The source code for this program was originally derived in 2020 from the public domain DirectoryLister version 1.11 written by Hal Gatewood in 2015, but now is almost entirely rewritten.
The plugin is kept as simple as possible, with minimal dependencies in each programing language used in order to be supported on a wide variety of web servers. Currently, the main script for this plugin is written in PHP, but may be implemented for other server languages in the future.
Installing DirLister is an easy task. Just follow these simple steps:
-
Download the latest version from the DirLister GitHub repository.
You should have already completed this step, but be sure you have the very latest version.
-
Unzip all the DirLister files on your computer.
-
Drop the
index.phpfile in the web directory which you want the directory listing to be displayed, and then you are ready to go!
To test your installation, just call the following link at your site using a web browser:
`http://your-site-address/dir-lister-directory-path/`
To see the listing of a folder, the directory to be scanned for file listing
must be readable by the web server, and the directory must not contain a file
matching those listed in the $exclude configuration option.
After testing your installation, you may need to customized the script to suit
your preferences. At the top of the index.php file, there are a few options
you can change to customize the look and feel of the directory listing.
DirLister cannot really be "upgraded" - simply delete the old files, and follow the installation instructions above.
DirLister is a free software licensed under the terms of the MIT License.