A simple, customisable theme for your Apache directory listing.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 5 commits ahead, 45 commits behind oupala:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
apaxy
.gitignore
License.md
README.md

README.md

#Apaxy

Demo: adamwhitcroft.com/apaxy

Apaxy is a customisable theme built to enhance the experience of browsing web directories. It uses the mod_autoindex Apache module—and some CSS—to override the default style of a directory listing.

This is a fork of the [https://github.com/AdamWhitcroft/Apaxy](original Apaxy) made for the CERN ALICE Release Validation.

##Features

Apaxy may be basic, but it gives you a great deal of creative freedom when styling your directory.

  • Style your directory listing with CSS.
  • Make it pop with Javascript or jQuery.
  • Add welcome messages, download instructions or copyright notices.
  • Add custom mime type icons (requires editing the .htaccess file)

Sadly, visual style is all you can work with. It's not possible to alter the generated table structure of the listing directory with Apaxy.

##Installation

Apaxy requires an Apache(2.0.23+) enabled HTTP server.

To install it:

cd /var/www
mkdir apaxy
cd apaxy
git clone https://github.com/dberzano/Apaxy.git .

In this case the theme directory will end up in /var/www/apaxy/apaxy/theme.

Now, copy the sample configuration file to your Apache configuration directory:

cp /var/www/apaxy/apaxy/apaxy.conf /etc/httpd/conf.d/apaxy.conf

The destination directory changes depending on your Linux distribution and Apache installation.

Edit the destination file; go to the end, and change all occurrences of /var/www/apaxy/apaxy/theme to the appropriate directory. If you have unpacked under /var/www/, there is no need to change anything.

You then have to enable indexing explicitly for the directories you want to list. Edit or create a configuration file in /etc/httpd/conf.d that contains:

<Directory /path/on/local/filesystem>
  Option +Indexes
</Directory>

##Apaxy themes

If you'd like to alter the default Apaxy theme, look in the /theme folder and you'll find the following files:

  • header.html
  • footer.html
  • style.css

Edit these as you would any other HTML or CSS file.

Adding your own icons is a little more involved. You'll need to edit the main Apaxy .htaccess file. Look for the following as an example:

AddIcon /apaxy/theme/icons/gif.png .gif

The above rule will assign an icon named gif.png from the directory /apaxy/theme/icons/ to any file with the .gif extension.

Remember that the directory /apaxy is a "virtual directory": Apache will map it to your local filesystem's directory according to the appropriate Alias directive.

##Mime Types

The default Apaxy theme /themes/apaxy has icons in place for the following mime types:

.aif .aif .asf .asx .avi .bin .c .css .csv .dmg .doc .docm .docx .dot .dotm .eps .flv .gif 
.htm .html .ico .iff .jar .jpeg .jpg .js .json .log .m3u .m4a .md .mid .mov .mp3 .mp4 .mpa 
.mpg .msg .mwa .odt .pages .pdf .pkg .png .ps .psd .ra .rar .rb .rm .rss .rtf .shtml 
.sql .srt .swf .tex .tiff .txt .vob .wav .wmv .wpd .wps .xhtml .xlam .xlr .xls .xlsm .xlsx 
.xltm .xltx .xml .zip

##Credits

This is a fork of the original Apaxy: all credits go to Adam Whitchcroft (GitHub, Twitter).

Apaxy owes it's existence to the amazing h5ai by Lars Jung. Had I not seen this, I would never have looked into making my own (probably way less useful) version.

Faenza Icons are used in the apaxy theme.