This is a simple file directory indexer / lister script written in PHP with some help from JavaScript.
This Indexer is designed to be a more image and video friendly Indexer while still having most of the basic functions of any other Indexer or Directory Lister. It is also designed to have a retro and simple feel to it which is why it doesn't use any fancy CSS or icon packs.
JavaScript is not required for the Indexer but it is needed for the extra functionality.
You can visit the demo to view the indexer in action.
Feel free to let me know if you have any ideas on what to change or add, or if you experience any bugs or errors.
A gallery mode where you can view images and videos of the current directory without needing to visit each URL separately. It has support for downloading files and reverse searching images.
Displays a preview of the image or video when hovering over the name.
The search filter can be used to search for filenames or filetypes in the current directory. Usage (Desktop): Shift + F.
This script can be set up as a single file script.
This script can be customized in a number of ways. (See: Configuration)
- File attributes (date modified and size).
- Dates will match the client's timezone.
- Persistent client-set sorting settings.
- Support for themes.
- Server-side filtering.
- Direct download links.
- Clickable path for easy navigation.
- Basic mobile support.
You can choose between having a default setup and a standalone setup.
The default setup will import assets (js, css etc) as separate files, like most sites. This is the most orderly setup.
The standalone setup will have all of these files bundled directly into the .php file. This may slightly increase the time it takes for the page to load but it usually won't be noticeable at all.
Place the files from the /public/ directory into your root web directory.
Place the file from the /standalone/ directory into your root web directory.
To use this script for all directories without a default index you need append /indexer.php to the end of your index line in your server configuration. This will tell Nginx to use the Indexer if none of the default indexes exist.
Example usage:
server {
index index.html index.htm index.php /indexer.php;
}
Alternatively, you can only make it work for certain directories:
server {
location ~ ^/(videos|images)/ {
index /indexer.php;
}
}
In order to automatically use this script you need to edit your Apache configuration. To do that you can place this line in your Apache configuration:
DirectoryIndex index.php index.html index.htm /indexer.php
This line can be placed in either your server's .conf file or your .htaccess file. This will tell Apache to use the Indexer if none of the default indexes exist.
The Indexer can be customized by editing the config available inside of the indexer.php.
You can read the CONFIG.md to see a more detailed overview of the available options.
The files inside /src/ are NOT needed in order to run this script.
This directory contains the uncompressed (and untranspiled) source files of the script (.css, .js etc.), so you can use these files if you want to customize, contribute or edit the script in any way.
You can contribute by submitting a pull request to the dev branch.
A simple, lightweight JavaScript API for handling cookies.
Modernizr is a JavaScript library that detects HTML5 and CSS3 features in the user’s browser.
A simple jQuery plugin that adds hoverable image and video previews to links and other elements.
Lightweight, cross-browser and highly customizable animated scrolling with jQuery.
Gives easy access to left/right/up/down swipe events for iOS and other touch devices.
Use this script at your own risk. There may exist bugs that i do not know of.