miniserve(1)

NAME
miniserve - For when you really just want to serve some files over HTTP right now!

SYNOPSIS
miniserve [-h|--help] [-V|--version] [-v|--verbose] [--index] [--spa] [-p|--port] [-i|--interfaces] [-a|--auth] [--route-prefix] [--random-route] [-P|--no-symlinks] [-H|--hidden] [-c|--color-scheme] [-d|--color-scheme-dark] [-q|--qrcode] [-u|--upload-files] [-m|--media-type] [-M|--raw-media-type] [-o|--overwrite-files] [-r|--enable-tar] [-g|--enable-tar-gz] [-z|--enable-zip] [-D|--dirs-first] [-t|--title] [--header] [-l|--show-symlink-info] [-F|--hide-version-footer] [-W|--show-wget-footer] [--print-completions] [--print-manpage] [--tls-cert] [--tls-key] [PATH]

DESCRIPTION
For when you really just want to serve some files over HTTP right now!

OPTIONS

-h, --help
    Print help information

-V, --version
    Print version information

-v, --verbose
    Be verbose, includes emitting access logs

--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.

--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.

-p, --port=PORT [default: 8080]
    Port to use

-i, --interfaces=INTERFACES
    Interface to listen on

-a, --auth=AUTH
    Set authentication. Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123, joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)

--route-prefix=ROUTE_PREFIX
    Use a specific route prefix

--random-route
    Generate a random 6-hexdigit route

-P, --no-symlinks
    Do not follow symbolic links

-H, --hidden
    Show hidden files

-c, --color-scheme=COLOR_SCHEME [default: squirrel]
    Default color scheme

-d, --color-scheme-dark=COLOR_SCHEME_DARK [default: archlinux]
    Default color scheme

-q, --qrcode
    Enable QR code display

-u, --upload-files
    Enable file uploading

-m, --media-type=MEDIA_TYPE
    Specify uploadable media types

-M, --raw-media-type=MEDIA_TYPE_RAW
    Directly specify the uploadable media type expression

-o, --overwrite-files
    Enable overriding existing files during file upload

-r, --enable-tar
    Enable uncompressed tar archive generation

-g, --enable-tar-gz
    Enable gz-compressed 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

-D, --dirs-first
    List directories first

-t, --title=TITLE
    Shown instead of host in page title and heading

--header=HEADER
    Set custom header for responses

-l, --show-symlink-info
    Show symlink info

-F, --hide-version-footer
    Hide version footer

-W, --show-wget-footer
    If enabled, display a wget command to recursively download the current directory

--print-completions=shell
    Generate completion file for a shell

--print-manpage
    Generate man page

--tls-cert=TLS_CERT
    TLS certificate to use

--tls-key=TLS_KEY
    TLS private key to use

Which path to serve

VERSION
v0.19.4

AUTHORS
Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com>