ruicky / h5ai

HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee.

h5ai

A modern HTTP web server index for Apache httpd, lighttpd, nginx and Cherokee. For bug reports and feature requests please use issues.

Install

Do not install any files from the src folder, they need to be preprocessed to work correctly! Find a preprocessed package and detailed install instructions on the project page.

In short you have to take the following two steps:

• place folder _h5ai in the document root folder of the web server
• append /_h5ai/public/index.php to the end of the default index-file list

Build

There are installation ready packages for the latest releases and dev builds. But to clone and build h5ai yourself run the following commands to find a fresh zipball in folder build (tested on linux only, requires git and node 0.12+ to be installed).

First install the global command line trigger for the mkr build tool:

> npm install -g mkr-global

Then run:

> git clone git://github.com/lrsjng/h5ai.git
> cd h5ai
> npm install
> mkr release

To build the frontend test suite run mkr build-test. This will output a file://-URL you can look up in your browser to run the tests.

License

The MIT License (MIT)

Copyright (c) 2015 Lars Jung (http://larsjung.de)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

References

h5ai profits from other projects, all of them licensed under the MIT license too. Exceptions are the Material Design icons (CC BY 4.0).