serve

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2023 License: MIT Imports: 13 Imported by: 0

README

serve

Serve files via HTTP.

Usage: serve <dir>

Arguments:
  <dir>    Serve files from this directory.

Flags:
  -h, --help              Show context-sensitive help.
      --port=4000         Listen on this port.
      --[no-]cors         Include CORS support (on by default).
      --dot               Serve dot files (files prefixed with a '.').
      --explicit-index    Only serve index.html files if URL path includes it.

The serve <dir> command can be used to browse files in a directory via HTTP. For example, serve . starts a server for browsing the files in the current working directory.

--port

By default, files are served on port 4000 (e.g. http://localhost:4000). To have the server listen on a different port, pass a different value to the --port argument (e.g. serve --port 9000 .).

--no-cors

By default, files are served with CORS headers. To turn off this behavior, use the --no-cors argument (e.g. serve --no-cors .).

--dot

By default, files and directories starting with a . will not be listed or served. To allow browsing .-prefixed files, use the --dot argument (e.g. serve --dot .).

--explicit-index

By default, if a directory does not include an index.html file, a listing of files in the directory will be served. If a directory does include an index.html file, that file will be served instead of the directory listing.

You can use the --explicit-index argument to make it so an existing index.html file is only served if the request URL ends with /index.html. When this argument is used, requests that end in / will be served with a directory listing, and requests that end in /index.html will be served with the contents of the index.html file (or a 404 if that file doesn't exist).

URL path serve . (with defaults) serve --expcit-index .
/path/to/dir/ existing index.html is served directory listing is served
/path/to/dir/index.html redirect to /path/to/dir/ existing index.html is served

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL