Better documentation of --host, closes #574

This commit is contained in:
Simon Willison 2019-11-01 14:57:49 -07:00
commit ffae2f0ecd
3 changed files with 29 additions and 14 deletions

View file

@ -230,9 +230,16 @@ def package(
multiple=True,
)
@click.option(
"-h", "--host", default="127.0.0.1", help="host for server, defaults to 127.0.0.1"
"-h",
"--host",
default="127.0.0.1",
help=(
"Host for server. Defaults to 127.0.0.1 which means only connections "
"from the local machine will be allowed. Use 0.0.0.0 to listen to "
"all IPs and allow access from other machines."
),
)
@click.option("-p", "--port", default=8001, help="port for server, defaults to 8001")
@click.option("-p", "--port", default=8001, help="Port for server, defaults to 8001")
@click.option(
"--debug", is_flag=True, help="Enable debug mode - useful for development"
)