48 lines
1.2 KiB
Markdown
48 lines
1.2 KiB
Markdown
# s3-genindex
|
|
|
|
Generate HTML directory indexes with file type icons and responsive design for local directories and S3-compatible storage.
|
|
This is particularly useful for S3 buckets that are publicly readable.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- **Local directory indexing** with recursive traversal
|
|
- **S3-compatible storage support** (MinIO, AWS S3, etc.)
|
|
- **Hierarchical directory structure** for S3 buckets
|
|
- **Responsive HTML design** with file type icons
|
|
- **Dry run mode** for testing
|
|
- **Flexible filtering** with glob patterns and regex exclusion
|
|
- **Hidden file control** and index.html visibility options
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go install git.ipng.ch/ipng/s3-genindex/cmd/s3-genindex@latest
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Local directory
|
|
s3-genindex -d /path/to/dir
|
|
|
|
# S3 bucket (requires AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY)
|
|
s3-genindex -s3 http://minio.example.com:9000/bucket
|
|
|
|
# Dry run to see what would be generated
|
|
s3-genindex -d /path/to/dir -n
|
|
|
|
# Show index.html files in listings
|
|
s3-genindex -d /path/to/dir -i
|
|
```
|
|
|
|
## Build
|
|
|
|
```bash
|
|
make build
|
|
make test
|
|
```
|
|
|
|
See [docs/DETAILS.md](docs/DETAILS.md) for complete documentation and examples.
|