diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 109 |
1 files changed, 60 insertions, 49 deletions
@@ -30,11 +30,11 @@ Sometimes this is just a more practical and quick way than doing things properly ### Serve a single file: miniserve linux-distro.iso - + ### Set a custom index file to serve instead of a file listing: miniserve --index test.html - + ### Serve an SPA (Single Page Application) so that non-existent paths are forwarded to the SPA's router instead miniserve --spa --index index.html @@ -94,13 +94,29 @@ Sometimes this is just a more practical and quick way than doing things properly For when you really just want to serve some files over HTTP right now! USAGE: - miniserve [FLAGS] [OPTIONS] [--] [PATH] + miniserve [OPTIONS] [--] [PATH] ARGS: <PATH> Which path to serve - FLAGS: + OPTIONS: + -a, --auth <AUTH> + Set authentication. Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123, + joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3) + + -c, --color-scheme <COLOR_SCHEME> + Default color scheme + + [default: squirrel] + [possible values: squirrel, archlinux, zenburn, monokai] + + -d, --color-scheme-dark <COLOR_SCHEME_DARK> + Default color scheme + + [default: archlinux] + [possible values: squirrel, archlinux, zenburn, monokai] + -D, --dirs-first List directories first @@ -116,12 +132,36 @@ Sometimes this is just a more practical and quick way than doing things properly -H, --hidden Show hidden files + --header <HEADER> + Set custom header for responses + + -i, --interfaces <INTERFACES> + Interface to listen on + + --index <index_file> + The name of a directory index file to serve, like "index.html" + + Normally, when miniserve serves a directory, it creates a listing for that directory. However, if a directory contains this file, miniserve will serve that file instead. + + -l, --show-symlink-info + Show symlink info + -o, --overwrite-files Enable overriding existing files during file upload + -p, --port <PORT> + Port to use + + [default: 8080] + -P, --no-symlinks Do not follow symbolic links + --print-completions <shell> + Generate completion file for a shell + + [possible values: bash, elvish, fish, powershell, zsh] + -q, --qrcode Enable QR code display @@ -131,6 +171,21 @@ Sometimes this is just a more practical and quick way than doing things properly --random-route Generate a random 6-hexdigit route + --spa + Activate SPA (Single Page Application) mode + + This will cause the file given by --index to be served for all non-existing file paths. In effect, this will serve the index file whenever a 404 would otherwise occur in order to allow the SPA + router to handle the request instead. + + -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 + -u, --upload-files Enable file uploading @@ -146,51 +201,7 @@ Sometimes this is just a more practical and quick way than doing things properly -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 - - OPTIONS: - -a, --auth <AUTH>... - Set authentication. Currently supported formats: username:password, - username:sha256:hash, username:sha512:hash (e.g. joe:123, - joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3) - - -c, --color-scheme <COLOR_SCHEME> - Default color scheme [default: squirrel] [possible values: squirrel, archlinux, - zenburn, monokai] - - -d, --color-scheme-dark <COLOR_SCHEME_DARK> - Default color scheme [default: archlinux] [possible values: squirrel, archlinux, - zenburn, monokai] - - --header <HEADER>... - Set custom header for responses - - -i, --interfaces <INTERFACES>... - Interface to listen on - - --index <index_file> - The name of a directory index file to serve, like "index.html" - - Normally, when miniserve serves a directory, it creates a listing for that - directory. However, if a directory contains this file, miniserve will serve that - file instead. - - -p, --port <PORT> - Port to use [default: 8080] - - --print-completions <shell> - Generate completion file for a shell [possible values: bash, elvish, fish, - powershell, zsh] - - -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 + 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 ## How to install |