indir/README.md

33 lines
929 B
Markdown
Raw Normal View History

2025-06-08 02:27:00 +01:00
# 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/`
```
## customization
### readme
drop a `README.md` into any directory and indir will render
it below the file listing with full markdown support!
---
2025-06-08 02:27:00 +01:00
## to-do:
2025-06-08 21:15:39 +01:00
- [x] use templates instead of hard-coded HTML (i was lazy)
- [x] directory header from readme file
2026-03-17 20:16:28 +01:00
- [x] directory stylesheet overrides
- [x] index.html serving support
2026-03-17 20:16:28 +01:00
- [x] fix mime-types for browser file view