A simple, customisable theme for your Apache directory listing.
Switch branches/tags
Nothing to show
Pull request Compare This branch is 2 commits ahead, 58 commits behind AdamWhitcroft: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.

##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.

Let's assume you have a folder named share in your server root directory (the path thus being http://mywebsite.com/share) that you'd like to use as your listing directory:

  • Download and unzip Apaxy
  • Copy and paste the contents of the /apaxy folder to your /share folder.
  • Edit htaccess.txt (now in the /share folder) and update all instances of paths marked with {FOLDERNAME} to point to your site root.

So...

AddIcon /{FOLDERNAME}/theme/icons/gif.png .gif

Should be changed to...

AddIcon /share/theme/icons/gif.png .gif
  • Once done, rename htaccess.txt to .htaccess in both the /share and /share/theme folders.
  • Treat yo'self, you're done.

##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 /{FOLDERNAME}/theme/icons/gif.png .gif

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

This URL path is relative to your site's root.

##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

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.