miniserve(1) | General Commands Manual | miniserve(1) |
NAME
miniserve - For when you really just want to serve some files over HTTP right now!
SYNOPSIS
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]
DESCRIPTION
For when you really just want to serve some files over HTTP right now!
OPTIONS
- -v, --verbose
- Be verbose, includes emitting access logs
- --index=INDEX
- 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.
- --pretty-urls
- 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.
- -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)
- --auth-file=AUTH_FILE
- Read authentication values from a file
Example file content:
joe:123 bob:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3 bill:
- --route-prefix=ROUTE_PREFIX
- Use a specific route prefix
- --random-route
- Generate a random 6-hexdigit route
- -P, --no-symlinks
- Hide symlinks in listing and prevent them from being followed
- -H, --hidden
- Show hidden files
- -S, --default-sorting-method=DEFAULT_SORTING_METHOD [default: name]
- 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)
- -O, --default-sorting-order=DEFAULT_SORTING_ORDER [default: desc]
- Default sorting order for file list
Possible values:
- asc: Ascending order
- desc: Descending order
- -c, --color-scheme=COLOR_SCHEME [default: squirrel]
- Default color scheme
[possible values: squirrel, archlinux, zenburn, monokai]
- -d, --color-scheme-dark=COLOR_SCHEME_DARK [default: archlinux]
- Default color scheme
[possible values: squirrel, archlinux, zenburn, monokai]
- -q, --qrcode
- Enable QR code display
- -u, --upload-files=ALLOWED_UPLOAD_DIR
- 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.
- -U, --mkdir
- Enable creating directories
- -m, --media-type=MEDIA_TYPE
- Specify uploadable media types
[possible values: image, audio, video]
- -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
- -C, --compress-response
- 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.
- -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
- Visualize symlinks in directory listing
- -F, --hide-version-footer
- Hide version footer
- --hide-theme-selector
- Hide theme selector
- -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
[possible values: bash, elvish, fish, powershell, zsh]
- --print-manpage
- Generate man page
- --tls-cert=TLS_CERT
- TLS certificate to use
- --tls-key=TLS_KEY
- TLS private key to use
- --readme
- Enable README.md rendering in directories
- -I, --disable-indexing
- Disable indexing
This will prevent directory listings from being generated and return an error instead.
- -h, --help
- Print help (see a summary with '-h')
- -V, --version
- Print version
- [PATH]
- Which path to serve
VERSION
v0.27.1
AUTHORS
Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com>
miniserve 0.27.1 |