diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 24 insertions, 2 deletions
@@ -49,6 +49,10 @@ Sometimes this is just a more practical and quick way than doing things properly miniserve -i 192.168.0.1 -i 10.13.37.10 -i ::1 /tmp/myshare +### Start with TLS: + + miniserve --tls-cert my.cert --tls-key my.key /tmp/myshare + ### Upload a file using `curl`: # in one terminal @@ -71,10 +75,11 @@ Sometimes this is just a more practical and quick way than doing things properly - Scan QR code for quick access - Shell completions - Sane and secure defaults +- TLS (for supported architectures) ## Usage - miniserve 0.14.0 + miniserve 0.15.0 Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com> For when you really just want to serve some files over HTTP right now! @@ -102,6 +107,12 @@ Sometimes this is just a more practical and quick way than doing things properly -h, --help Prints help information + -H, --hidden + Show hidden files + + -F, --hide-version-footer + Hide version footer + -P, --no-symlinks Do not follow symbolic links @@ -134,6 +145,7 @@ Sometimes this is just a more practical and quick way than doing things properly zenburn, monokai] --header <header>... Set custom header for responses + --index <index_file> The name of a directory index file to serve, like "index.html" @@ -151,6 +163,12 @@ Sometimes this is just a more practical and quick way than doing things properly -t, --title <title> Shown instead of host in page title and heading + --tls-cert <tls-cert> + TLS certificate to use + + --tls-key <tls-key> + TLS private key to use + ARGS: <PATH> @@ -169,6 +187,10 @@ Alternatively, if you are on **Arch Linux**, you can do pacman -S miniserve +On [Termux](https://termux.com/) + + pkg install miniserve + **On OSX**: Download `miniserve-osx` from [the releases page](https://github.com/svenstaro/miniserve/releases) and run chmod +x miniserve-osx @@ -199,7 +221,7 @@ If you'd like to make use of the built-in shell completion support, you need to few examples with common paths are provided below: # For bash - miniserve --print-completions bash > ~/.local/share/bash-completion/miniserve + miniserve --print-completions bash > ~/.local/share/bash-completion/completions/miniserve # For zsh miniserve --print-completions zsh > /usr/local/share/zsh/site-functions/_miniserve # For fish |