diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 45 insertions, 0 deletions
@@ -8,3 +8,48 @@ [](https://deps.rs/repo/github/svenstaro/miniserve) [](https://github.com/svenstaro/miniserve/blob/master/LICENSE) +## How to use + +### Serve a directory: + + miniserve linux-distro-collection/ + +### Serve a single file: + + miniserve linux-distro.iso + +### Require username/password: + + miniserve --auth joe:123 unreleased-linux-distros/ + +## Features + +- Easy to use +- Just works: Correct MIME types handling out of the box +- Single binary drop in with no extra dependencies required +- Authentication support with username and password +- Mega fast and highly parallel (thanks to [Rust](https://www.rust-lang.org/) and [Actix](https://actix.rs/)) + +## How to install + +**On Linux**: Download `miniserve-linux` from [the releases page](https://github.com/svenstaro/miniserve/releases) and run + + chmod +x miniserve-linux + ./miniserve-linux + +**On OSX**: Download `miniserve-osx` from [the releases page](https://github.com/svenstaro/miniserve/releases) and run + + chmod +x miniserve-osx + ./miniserve-osx + +**On Windows**: Download `miniserve-win.exe` from [the releases page](https://github.com/svenstaro/miniserve/releases) and double click it. + +**With Cargo**: If you have a somewhat recent version of Rust and Cargo installed, you can run + + cargo install miniserve + miniserve + +## Why to use this over alternatives? + +- darkhttpd: Not easily available on Windows and it's not as easy as download and go +- Python built-in webserver: Need to have Python installed and it's low performance and also doesn't do correct MIME type handling in some cases |