🌟 For when you really just want to serve some files over HTTP right now!
For when you really just want to serve some files over HTTP right now!
miniserve is a small, self-contained cross-platform CLI tool that allows you to just grab the binary and serve some file(s) via HTTP. Sometimes this is just a more practical and quick way than doing things properly.
miniserve --auth joe:123 unreleased-linux-distros/
pw=$(echo -n "123" | sha256sum | cut -f 1 -d ' ') miniserve --auth joe:sha256:$pw unreleased-linux-distros/
miniserve -i 192.168.0.1 --random-route /tmp # Serving path /private/tmp at http://192.168.0.1/c789b6
miniserve -i 192.168.0.1 -i 10.13.37.10 -i ::1 /tmp/myshare
# in one terminal miniserve -u . # in another terminal curl -F "[email protected]$FILE" http://localhost:8080/upload\?path\=/
$FILEis the path to the file. This uses miniserve's default port of 8080)
miniserve 0.13.0 Sven-Hendrik Haase , Boastful Squirrel For when you really just want to serve some files over HTTP right now!
USAGE: miniserve [FLAGS] [OPTIONS] [--] [PATH]
FLAGS: -D, --dirs-first List directories first
-r, --enable-tar Enable tar archive generation -z, --enable-zip Enable zip archive generation WARNING: Zipping large directories can result in out-of-memory exception because zip generation is done in memory and cannot be sent on the fly -u, --upload-files Enable file uploading -h, --help Prints help information -P, --no-symlinks Do not follow symbolic links -o, --overwrite-files Enable overriding existing files during file upload -q, --qrcode Enable QR code display --random-route Generate a random 6-hexdigit route -V, --version Prints version information -v, --verbose Be verbose, includes emitting access logs
OPTIONS: -a, --auth ... Set authentication. Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123, joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3) -c, --color-scheme Default color scheme [default: squirrel] [possible values: squirrel, archlinux, zenburn, monokai] -d, --color-scheme-dark Default color scheme [default: archlinux] [possible values: squirrel, archlinux, zenburn, monokai] --header
On Linux: Download
miniserve-linuxfrom the releases page and run
chmod +x miniserve-linux ./miniserve-linux
Alternatively, if you are on Arch Linux, you can do
pacman -S miniserve
On OSX: Download
miniserve-osxfrom the releases page and run
chmod +x miniserve-osx ./miniserve-osx
Alternatively install with Homebrew.
brew install miniserve miniserve
On Windows: Download
miniserve-win.exefrom the releases page and run
With Cargo: Make sure you have a recent version of Rust. Then you can run
cargo install miniserve miniserve
With Docker: If you prefer using Docker for this, run
docker run -v /tmp:/tmp -p 8080:8080 --rm -it svenstaro/miniserve /tmp
If you'd like to make use of the built-in shell completion support, you need to run
miniserve --print-completionsand put the completions in the correct place for your shell. A few examples with common paths are provided below:
# For bash miniserve --print-completions bash > ~/.local/share/bash-completion/miniserve # For zsh miniserve --print-completions zsh > /usr/local/share/zsh/site-functions/_miniserve # For fish miniserve --print-completions fish > ~/.config/fish/completions/miniserve.fish
For convenience reasons, miniserve will try to bind on all interfaces by default (if no
-iis provided). It will also do that if explicitly provided with
-i ::. In all of the aforementioned cases, it will bind on both IPv4 and IPv6. If provided with an explicit non-default interface, it will ONLY bind to that interface. You can provide
-imultiple times to bind to multiple interfaces at the same time.
This is mostly a note for me on how to release this thing:
CHANGELOG.mdis up to date.
cargo release --dry-run