aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2018-08-10 05:05:11 +0000
committerSven-Hendrik Haase <svenstaro@gmail.com>2018-08-10 05:05:21 +0000
commitb58624818372c63a74028c1e0830b8186a3abcbf (patch)
tree7ff4d653731a472ac8b4d0654a2803b6dcae59fe /README.md
parentMerge pull request #14 from colindean/colindean/better-make (diff)
downloadminiserve-6475ff25d7d9ffb94656527cfa1bb2b1245c2adc.tar.gz
miniserve-6475ff25d7d9ffb94656527cfa1bb2b1245c2adc.zip
Allow for multiple interfaces to be specified at the same timev0.2.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 77b105e..7588d59 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,10 @@ Sometimes this is just a more practical and quick way than doing things properly
miniserve --auth joe:123 unreleased-linux-distros/
+### Bind to multiple interfaces:
+
+ miniserve -i 192.168.0.1 -i 10.13.37.10 -i ::1 -- /tmp/myshare
+
## Features
- Easy to use
@@ -54,6 +58,14 @@ Sometimes this is just a more practical and quick way than doing things properly
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.