miniserve(1) General Commands Manual miniserve(1)

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

miniserve [-v|--verbose] [--index] [--spa] [--pretty-urls] [-p|--port] [-i|--interfaces] [-a|--auth] [--auth-file] [--route-prefix] [--random-route] [-P|--no-symlinks] [-H|--hidden] [-S|--default-sorting-method] [-O|--default-sorting-order] [-c|--color-scheme] [-d|--color-scheme-dark] [-q|--qrcode] [-u|--upload-files] [-U|--mkdir] [-m|--media-type] [-M|--raw-media-type] [-o|--overwrite-files] [-r|--enable-tar] [-g|--enable-tar-gz] [-z|--enable-zip] [-C|--compress-response] [-D|--dirs-first] [-t|--title] [--header] [-l|--show-symlink-info] [-F|--hide-version-footer] [--hide-theme-selector] [-W|--show-wget-footer] [--print-completions] [--print-manpage] [--tls-cert] [--tls-key] [--readme] [-I|--disable-indexing] [-h|--help] [-V|--version] [PATH]

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

Be verbose, includes emitting access logs
May also be specified with the MINISERVE_VERBOSE environment variable.
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.

May also be specified with the MINISERVE_INDEX environment variable.
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.

May also be specified with the MINISERVE_SPA environment variable.
Activate Pretty URLs mode

This will cause the server to serve the equivalent `.html` file indicated by the path.

`/about` will try to find `about.html` and serve it.

May also be specified with the MINISERVE_PRETTY_URLS environment variable.
Port to use
May also be specified with the MINISERVE_PORT environment variable.
Interface to listen on
May also be specified with the MINISERVE_INTERFACE environment variable.
Set authentication

Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123, joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)

May also be specified with the MINISERVE_AUTH environment variable.
Read authentication values from a file

Example file content:

joe:123 bob:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3 bill:

May also be specified with the MINISERVE_AUTH_FILE environment variable.
Use a specific route prefix
May also be specified with the MINISERVE_ROUTE_PREFIX environment variable.
Generate a random 6-hexdigit route
May also be specified with the MINISERVE_RANDOM_ROUTE environment variable.
Hide symlinks in listing and prevent them from being followed
May also be specified with the MINISERVE_NO_SYMLINKS environment variable.
Show hidden files
May also be specified with the MINISERVE_HIDDEN environment variable.
Default sorting method for file list

Possible values:

  • name: Sort by name
  • size: Sort by size
  • date: Sort by last modification date (natural sort: follows alphanumerical order)
May also be specified with the MINISERVE_DEFAULT_SORTING_METHOD environment variable.
Default sorting order for file list

Possible values:

  • asc: Ascending order
  • desc: Descending order
May also be specified with the MINISERVE_DEFAULT_SORTING_ORDER environment variable.
Default color scheme

[possible values: squirrel, archlinux, zenburn, monokai]

May also be specified with the MINISERVE_COLOR_SCHEME environment variable.
Default color scheme

[possible values: squirrel, archlinux, zenburn, monokai]

May also be specified with the MINISERVE_COLOR_SCHEME_DARK environment variable.
Enable QR code display
May also be specified with the MINISERVE_QRCODE environment variable.
Enable file uploading (and optionally specify for which directory)

The provided path is not a physical file system path. Instead, it's relative to the serve dir. For instance, if the serve dir is '/home/hello', set this to '/upload' to allow uploading to '/home/hello/upload'. When specified via environment variable, a path always neesd to the specified.

May also be specified with the MINISERVE_ALLOWED_UPLOAD_DIR environment variable.
Enable creating directories
May also be specified with the MINISERVE_MKDIR_ENABLED environment variable.
Specify uploadable media types

[possible values: image, audio, video]

May also be specified with the MINISERVE_MEDIA_TYPE environment variable.
Directly specify the uploadable media type expression
May also be specified with the MINISERVE_RAW_MEDIA_TYPE environment variable.
Enable overriding existing files during file upload
May also be specified with the OVERWRITE_FILES environment variable.
Enable uncompressed tar archive generation
May also be specified with the MINISERVE_ENABLE_TAR environment variable.
Enable gz-compressed tar archive generation
May also be specified with the MINISERVE_ENABLE_TAR_GZ environment variable.
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

May also be specified with the MINISERVE_ENABLE_ZIP environment variable.
Compress response

WARNING: Enabling this option may slow down transfers due to CPU overhead, so it is disabled by default.

Only enable this option if you know that your users have slow connections or if you want to minimize your server's bandwidth usage.

May also be specified with the MINISERVE_COMPRESS_RESPONSE environment variable.
List directories first
May also be specified with the MINISERVE_DIRS_FIRST environment variable.
Shown instead of host in page title and heading
May also be specified with the MINISERVE_TITLE environment variable.
Set custom header for responses
May also be specified with the MINISERVE_HEADER environment variable.
Visualize symlinks in directory listing
May also be specified with the MINISERVE_SHOW_SYMLINK_INFO environment variable.
Hide version footer
May also be specified with the MINISERVE_HIDE_VERSION_FOOTER environment variable.
Hide theme selector
May also be specified with the MINISERVE_HIDE_THEME_SELECTOR environment variable.
If enabled, display a wget command to recursively download the current directory
May also be specified with the MINISERVE_SHOW_WGET_FOOTER environment variable.
Generate completion file for a shell

[possible values: bash, elvish, fish, powershell, zsh]

Generate man page
TLS certificate to use
May also be specified with the MINISERVE_TLS_CERT environment variable.
TLS private key to use
May also be specified with the MINISERVE_TLS_KEY environment variable.
Enable README.md rendering in directories
May also be specified with the MINISERVE_README environment variable.
Disable indexing

This will prevent directory listings from being generated and return an error instead.

May also be specified with the MINISERVE_DISABLE_INDEXING environment variable.
Print help (see a summary with '-h')
Print version
[PATH]
Which path to serve
May also be specified with the MINISERVE_PATH environment variable.

v0.27.1

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

miniserve 0.27.1