Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.58 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.58 KB
Raw

Directory Lister - The simple PHP directory lister

Maintained by Tampa

Contributions from veso266 & others

Original idea by, Chris Kankiewicz

Original fork from mijorepusic

Introduction

Directory Lister is a simple PHP script that lists the contents of any web-accessible directory and allows navigating there within. Simply upload Directory Lister to any directory and get immediate access to all files and sub-directories under that directory. Directory Lister is written in PHP and JavaScript.

Distributed under the MIT License.

Features

  • Extremely simple installation, no database, additional servers, just drop the files and configure
  • Creates on-the-fly listing of any web-accessible directory
  • Customizable sort order of files/folders
  • Easily define hidden files to be excluded from the listing
  • Download of entire directories as zip
  • Various sorting options
  • Directory size information
  • File hashing
  • Custom directory descriptions(place .desc file in directory)
  • Download counter, traffic estimator
  • Dark and light mode

Requirements

It is recommended to use latest PHP 7.2+ if possible. For more information on PHP, please visit http://www.php.net. PHP 7.3 should work as well, PHP 7.4 has not been tested.

A linux/unix host is needed to support some features, please report issues with other platforms.

For directory zip functionality zip library needs to be present in /usr/bin/zip

Uses some javascript so may not work with browsers from last century.

Installation

  1. Make sure all requirements are met
  2. Clone or download the repo
  3. Place all files in the parent-most directory you wish DirectoryLister to use as home
  4. Rename default.config.php to config.php and configure DirectoryLister as needed within, (remove .desc in main directory to remove welcome message)
  5. Files and folders to be shown can now be placed alongside
  6. Make sure log file in resources folder is write-able

Troubleshooting

Ensure you have the latest version of Directory Lister installed.

Verify that you have PHP 5.3 or later installed. You can verify your PHP version by running:

php --version

Open up an issue if you need anything.

License

Directory Lister is distributed under the terms of the MIT License.

Copyright 2017 Chris Kankiewicz

Copyright 2020 Tampa