hai

· a beautified Apache index ·

0.17

h5ai makes browsing directories on Apache servers more pleasant. Directories get styled in a modern way and browsing through the folders is enhanced by different views, a breadcrumb and a tree overview.

See the demo directory.

The sources are available on GitHub where you'll also find a changelog.

Installation

Installing h5ai is as easy as copying two things to the right places!

Copy folder _h5ai to the web-root directory of your Apache server or alternativly set an alias /_h5ai/ to this folder and make sure http://YOUR-DOMAIN.TLD/_h5ai/ is reachable.
Add the content of file h5ai.htaccess to the .htaccess file inside the directory you want to get styled (you might have to create this file). This directory including all its subdirectories will get styled by h5ai.

At this point h5ai should be working but you should have a look at the configuration section right below.

Configuration

h5ai is configured to run in the pure JavaScript version by default. If you prefer to use the PHP version have a look at your .htaccess file (the part you copied from h5ai.htaccess). You have to comment/uncomment some lines

just change this ...

# pure JavaScript version
HeaderName    /_h5ai/header.html
ReadmeName    /_h5ai/footer.html

# PHP version
# HeaderName    /_h5ai/header.php
# ReadmeName    /_h5ai/footer.php

into that ...

# pure JavaScript version
# HeaderName    /_h5ai/header.html
# ReadmeName    /_h5ai/footer.html

# PHP version
HeaderName    /_h5ai/header.php
ReadmeName    /_h5ai/footer.php

config.js

The main configuration file is /_h5ai/config.js. You might want to adjust some of the documented settings. The settings in this file affect both, the pure JavaScript and the PHP version of h5ai.

config.php

If you are running the PHP implementation you must check /_h5ai/php/config.php too. Also consider to make folder /_h5ai/cache writable for your Apache server to enable some caching.

Custom headers and footers

Optionally add _h5ai.header.html and/or _h5ai.footer.html files to any of the styled folders to display custom top or bottom sections. The content of those files will be wrapped by <header> and <footer> tags.

note: files or folders of name _h5ai* are hidden from the index by default.

Contact

Lars Jung
lrsjng [at] gmail [dot] com
@lrsjng

License

h5ai is provided under the terms of the MIT License.

It profits from these great projects: AmplifyJS (MIT/GPL), Datejs (MIT), Faenza icon set (GPL), HTML5 ★ Boilerplate, jQuery (MIT/GPL), jQuery.mousewheel (MIT), modernizr (MIT/BSD)