Apaxy
About this project
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.
Table of contents
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
- add welcome messages, download instructions or copyright notices
- add custom media type icons (requires editing the
.htaccess
file) - use custom error pages
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.4+) http server. The configuration of the apache http server have to set an AllowOverride
statement for the Apaxy styled folder:
AllowOverride Options Indexes FileInfo
Quick start
If you would like, you can automate the installation of Apaxy with the included apaxy-configure.sh
script.
To get started, first open apaxy.config
in your favorite editor, then edit the apacheWebRootPath
and installWebPath
variables to correspond to your server's settings. Save the file and exit.
You can set some parameters of apaxy.config
on the command line instead of the config file. You can see the documentation of the cli with the following command: apaxy-configure.sh -h
.
Then run the configuration script as a user that can write to the installWebPath
directory. With apache under debian, this would be the www-data
user:
$ sudo -u www-data ./apaxy-configure.sh
The files will be copied to the web server directory, and modified automatically based on the settings specified.
Manual install
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...
AddIconByType (gif,{FOLDERNAME}/theme/icons/gif.png) image/gif
Should be changed to...
AddIconByType (gif,/share/theme/icons/gif.png) image/gif
- if you want to enable the gallery feature, overwrite the header and footer files:
mv footer-lightgallery.html footer.html
mv header-lightgallery.html header.html
- edit
footer.html
, along with all the otherhtml
documents (in the/share/theme
folder) and update al