blob: 4011d7d756fccc497da71dac88350ce027fe439c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# miniserve - a CLI tool to serve files and dirs over HTTP
[](https://travis-ci.org/svenstaro/miniserve)
[](https://aur.archlinux.org/packages/miniserve/)
[](https://crates.io/crates/miniserve)
[](https://deps.rs/repo/github/svenstaro/miniserve)
[](https://github.com/svenstaro/miniserve/blob/master/LICENSE)
**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.
## 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/
### Generate random 6-hexdigit URL:
miniserve --random-route -i 192.168.0.1 /tmp
# Serving path /private/tmp at http://192.168.0.1/c789b6
### Bind to multiple interfaces:
miniserve -i 192.168.0.1 -i 10.13.37.10 -i ::1 -- /tmp/myshare
### Sort files for easier navigation
miniserve --sort=natural /tmp/myshare # (default behaviour)
# 1/
# 2/
# 3
# 11
miniserve --sort=alpha /tmp/myshare
# 1/
# 11
# 2/
# 3
miniserve --sort=dirsfirst /tmp/myshare
# 1/
# 2/
# 11
# 3
miniserve --reverse /tmp/myshare
# 11
# 3
# 2/
# 1/
## 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 run
miniserve-win.exe
**With Cargo**: If you have a somewhat recent version of Rust and Cargo installed, you can run
cargo install miniserve
miniserve
## Binding behavior
For convenience reasons, miniserve will try to bind on all interfaces by default (if no `-i` is provided).
It will also do that if explicitly provided with `-i 0.0.0.0` or `-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 `-i` multiple times to bind to multiple interfaces at the same time.
## Why 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, it's low performance, and also doesn't do correct MIME type handling in some cases.
- netcat: Not as convenient to use and sending directories is [somewhat involved](https://nakkaya.com/2009/04/15/using-netcat-for-file-transfers/).
## Releasing
This is mostly a note for me on how to release this thing:
- Update version in `Cargo.toml` and run `cargo update`.
- `git commit` and `git tag -s`, `git push`.
- `cargo publish`
- Releases will automatically be deployed by Travis.
- Update AUR package.
|
