nginx-fancy-pages/README.md
2024-10-23 22:22:40 -04:00

39 lines
1.3 KiB
Markdown

# nginx-fancy-pages
A modern drop in replacement for default Apache index/error pages. This is
an nginx-compatible version of [apache-fancy-pages](https://github.com/kristuff/apache-fancy-pages),
with details kept largely the same.
```
___ ___
| __|_ _ _ _ __ _ _| _ \__ _ __ _ ___ ___
| _/ _` | ' \/ _| || | _/ _` / _` / -_|_-<
|_|\__,_|_||_\__|\_, |_| \__,_\__, \___/__/
|__/ |___/
```
![preview_auto-index-ondesktop](/screenshots/auto-index-desktop-light-dark.png)
![preview_auto-index-on-mobile](/screenshots/auto-index-mobile-dark-light.png)
![preview_error-401](/screenshots/401_dark.png)
## Features
- Responsive design
- Breadcrumb navigation
- Search/Filter results
- Light/Dark theme based on user prefered color scheme
- Replacement for default error pages: 401, 403, 404, 500
## Requirements
- The NGINX [Fancyindex](https://github.com/aperezdc/ngx-fancyindex) module is compiled with nginx.
## Limitations
- On mobile, column headers are hidden so sorting is implicitly disabled.
## Install
1. Include content in your location directive, i.e `location / { ... }`, in your nginx config.
2. Move the `fancy-pages` folder to the same folder level as your serving location. For example,
if your location directive is `/mydatabase`, the theme should be located `/fancy-pages`.
3. Restart or reload nginx.