mirrors/nginx-fancyindex-flat-theme
1
0
Fork 0
mirror of https://github.com/alehaa/nginx-fancyindex-flat-theme.git synced 2025-04-26 00:49:53 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add a README file

Browse source
This commit is contained in:
Alexander Haase 2018-02-20 02:58:18 +01:00
parent 4e87b0a8b2
commit 936a049a3a
1 changed files with 57 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

57
README.md Normal file
View file

@ -0,0 +1,57 @@
# Flat theme for nginx's fancyindex module
[![](https://img.shields.io/github/issues-raw/alehaa/nginx-fancyindex-flat-theme.svg?style=flat-square)](https://github.com/alehaa/nginx-fancyindex-flat-theme/issues)
[![](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat-square)](LICENSE)
## About
The [fancyindex module](https://github.com/aperezdc/ngx-fancyindex) of
[nginx](http://nginx.org/) has the powerful capability to be customizable.
Instead of using an external application, this gives us the ability to use use
just the webservers capabilities to generate beautiful directory listings.
This theme provides a simple, flat interface based on
[Bootstrap 4](https://getbootstrap.com), [Font Awesome](https://fontawesome.com)
and (for easy navigation in galleries)
[lightbox2](http://lokeshdhakar.com/projects/lightbox2/). In combination with
the browser's preview capability, accessing the majority of files should be
possible, giving the user easy access without a single line of server-side
dynamic code.
## Usage
1. Get the latest ressources from [GitHub releases](https://github.com/alehaa/nginx-fancyindex-flat-theme/releases)
or build them on your own by running `make` inside this repository and copy
these files into any location accessible by *nginx*.
2. Configure your vhost to use the theme's ressources for fancyindex:
```
# Fancyindex
fancyindex on;
fancyindex_header "/theme/header.html";
fancyindex_footer "/theme/footer.html";
fancyindex_show_path off;
fancyindex_name_length 255;
fancyindex_exact_size off;
fancyindex_localtime on;
location /theme {
alias /srv/www/fileserver/theme;
}
```
## License
The nginx-fancyindex-flat-theme is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.
This software is distributed in the hope that it will be useful, but **WITHOUT
ANY WARRANTY**; without even the implied warranty of **MERCHANTABILITY** or
**FITNESS FOR A PARTICULAR PURPOSE**. A Copy of the GNU General Public License
can be found in the [LICENSE](LICENSE) file.
© 2018 Alexander Haase