mirror/apaxy
1
0
Fork 0
mirror of https://github.com/oupala/apaxy.git synced 2025-08-19 08:51:15 +02:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source 
Minor updates as per PR#60.
This commit is contained in:
Adam Whitcroft
2016-10-01 14:20:35 +01:00
committed by GitHub
parent bf921c0740
commit 4d4fd3a6ae
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,10 +1,10 @@
#Apaxy # Apaxy
Demo: [adamwhitcroft.com/apaxy](http://adamwhitcroft.com/apaxy/) Demo: [adamwhitcroft.com/apaxy](http://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. 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 ## Features
Apaxy may be basic, but it gives you a great deal of creative freedom when styling your directory. Apaxy may be basic, but it gives you a great deal of creative freedom when styling your directory.
@@ -15,7 +15,7 @@ Apaxy may be basic, but it gives you a great deal of creative freedom when styli
_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._ _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 ## Installation
Apaxy requires an Apache(2.2.11+) enabled HTTP server. Apaxy requires an Apache(2.2.11+) enabled HTTP server.
@@ -26,14 +26,14 @@ Let's assume you have a folder named `share` in your server root directory (the
* Rename `htaccess.txt` to `.htaccess` in both the `/share` and `/share/theme` folders. * Rename `htaccess.txt` to `.htaccess` in both the `/share` and `/share/theme` folders.
* [Treat yo'self](http://25.media.tumblr.com/tumblr_lw7q28y0Mz1qanm80o1_500.gif), you're done. * [Treat yo'self](http://25.media.tumblr.com/tumblr_lw7q28y0Mz1qanm80o1_500.gif), you're done.
##Docker images ## Docker images
A [local Demo](http://localhost:8080) can be started with docker. A [local Demo](http://localhost:8080) can be started with docker.
`docker-compose build` `docker-compose build`
`docker-compose up` `docker-compose up`
##Apaxy themes ## Apaxy themes
If you'd like to alter the default Apaxy theme, look in the `/theme` folder and you'll find the following files: If you'd like to alter the default Apaxy theme, look in the `/theme` folder and you'll find the following files:
@@ -51,7 +51,7 @@ The above rule will assign an icon named `gif.png` from the directory `theme/ico
This URL path is relative to your site's root. This URL path is relative to your site's root.
##Mime Types ## Mime Types
The default Apaxy theme `theme/apaxy` has icons in place for the following mime types: The default Apaxy theme `theme/apaxy` has icons in place for the following mime types:
@@ -63,12 +63,11 @@ The default Apaxy theme `theme/apaxy` has icons in place for the following mime
## Troubleshooting ## Troubleshooting
Make sure the options set in .htaccess files of Apaxy can actually be changed. This means that you need to allow to ovveride the used options in your apache configuration of the directory apaxy used with: Make sure the options set in .htaccess files of Apaxy can actually be changed. This means that you need to allow to ovveride the used options in your apache configuration of the directory apaxy used with: `AllowOverride Indexes`
```AllowOverride Indexes```
Find more information in the in the [apache documentation](https://httpd.apache.org/docs/2.2/de/mod/core.html). Find more information in the in the [apache documentation](https://httpd.apache.org/docs/2.2/de/mod/core.html).
##Credits ## Credits
Apaxy owes it's existence to the amazing [h5ai](http://larsjung.de/h5ai/) by [Lars Jung](https://twitter.com/lrsjng). Had I not seen this, I would never have looked into making my own (probably way less useful) version. Apaxy owes it's existence to the amazing [h5ai](http://larsjung.de/h5ai/) by [Lars Jung](https://twitter.com/lrsjng). Had I not seen this, I would never have looked into making my own (probably way less useful) version.