40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# indir
|
|
|
|
a nifty static file indexer
|
|
|
|
indir provides a nice, simple frontend for browsing your web directories!
|
|
heavily inspired by traditional file indexers provided by the likes of nginx
|
|
and apache, with some modern amenities on top :)
|
|
|
|
## usage
|
|
```sh
|
|
indir [--host address] [--port port] [--root http_root] directory
|
|
|
|
--help shows this help message
|
|
--host address hosts on the specified address
|
|
--port port hosts on the specified port
|
|
--root http_root hosts on the specified subdirectory, i.e. `/files/`
|
|
```
|
|
|
|
## features
|
|
|
|
### file serving
|
|
indir has the possibility of automatically serving an `index.html` instead of displaying the directory view!
|
|
|
|
### customization
|
|
|
|
#### readme
|
|
drop a `README.md` into any directory and indir will render
|
|
it below the file listing with full markdown support!
|
|
|
|
#### custom css
|
|
using a 'index.css' file, you can customize the directory view!
|
|
|
|
---
|
|
|
|
## to-do:
|
|
- [x] use templates instead of hard-coded HTML (i was lazy)
|
|
- [x] directory header from readme file
|
|
- [x] directory stylesheet overrides
|
|
- [x] index.html serving support
|
|
- [x] fix mime-types for browser file view
|