Azalea
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
# MeowIndex
|
|
|
|
A cute, feature-rich file listing module to replace nginx's autoindex / fancyindex.
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
* HyDEV ArchLinux Repo: https://arch.hydev.org/
|
|
* HyDEV Backup CDN: https://cdn.hydev.org/backup/
|
|
|
|
## Features
|
|
|
|
* [x] List files
|
|
* [x] Show file icons
|
|
* [x] Clickable, length-safe breadcrumb path
|
|
* [x] Fix mobile view
|
|
* [x] Infinite-scroll
|
|
* [x] Search
|
|
* [x] Show 404 page
|
|
|
|
**Features requiring a backend**
|
|
|
|
* [x] Show image/video previews
|
|
* [x] Use file binary to determine mime type
|
|
|
|
**TODO**
|
|
|
|
* [ ] Play videos
|
|
|
|
## How to use
|
|
|
|
### 1. Installation
|
|
|
|
You can install from source by cloning the repository:
|
|
|
|
```sh
|
|
cd /etc/nginx
|
|
git clone https://github.com/hykilpikonna/MeowIndex
|
|
cd MeowIndex
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
To update, simply do `git pull` and `yarn build` in the same directory.
|
|
|
|
### 2. Setup File Listing in Nginx
|
|
|
|
This module uses the json file listing api in nginx. If you already have an autoindex file server set up, you can make the following changes. If you're new to nginx, you can check out our [example configs](docs/examples).
|
|
|
|
The following example serves `/data/file-server` on http path `/`
|
|
|
|
```nginx
|
|
# ...
|
|
server_name your.domain.com;
|
|
|
|
set $title "Meow Index";
|
|
set $dir_path /data/file-server;
|
|
include "/etc/nginx/MeowIndex/docs/nginx.conf";
|
|
|
|
location / {
|
|
try_files $uri $uri/index.html /__meowindex__/index.html;
|
|
}
|
|
```
|
|
|
|
## Advanced Usage
|
|
|
|
TODO
|