github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Better documentation of --host, closes #574

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -89,26 +89,31 @@ Now visiting http://localhost:8001/History/downloads will show you a web interfa
## datasette serve options ## datasette serve options
$ datasette serve --help
Usage: datasette serve [OPTIONS] [FILES]... Usage: datasette serve [OPTIONS] [FILES]...
Serve up specified SQLite database files with a web UI Serve up specified SQLite database files with a web UI
Options: Options:
-i, --immutable PATH Database files to open in immutable mode -i, --immutable PATH Database files to open in immutable mode
-h, --host TEXT host for server, defaults to 127.0.0.1 -h, --host TEXT Host for server. Defaults to 127.0.0.1 which means
-p, --port INTEGER port for server, defaults to 8001 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.
-p, --port INTEGER Port for server, defaults to 8001
--debug Enable debug mode - useful for development --debug Enable debug mode - useful for development
--reload Automatically reload if database or code change detected - --reload Automatically reload if database or code change
useful for development detected - useful for development
--cors Enable CORS by serving Access-Control-Allow-Origin: * --cors Enable CORS by serving Access-Control-Allow-
Origin: *
--load-extension PATH Path to a SQLite extension to load --load-extension PATH Path to a SQLite extension to load
--inspect-file TEXT Path to JSON file created using "datasette inspect" --inspect-file TEXT Path to JSON file created using "datasette
-m, --metadata FILENAME Path to JSON file containing license/source metadata inspect"
-m, --metadata FILENAME Path to JSON file containing license/source
metadata
--template-dir DIRECTORY Path to directory containing custom templates --template-dir DIRECTORY Path to directory containing custom templates
--plugins-dir DIRECTORY Path to directory containing custom plugins --plugins-dir DIRECTORY Path to directory containing custom plugins
--static STATIC MOUNT mountpoint:path-to-directory for serving static files --static STATIC MOUNT mountpoint:path-to-directory for serving static
files
--memory Make :memory: database available --memory Make :memory: database available
--config CONFIG Set config option using configname:value --config CONFIG Set config option using configname:value
datasette.readthedocs.io/en/latest/config.html datasette.readthedocs.io/en/latest/config.html

11
datasette/cli.py
View file

@ -230,9 +230,16 @@ def package(
multiple=True, multiple=True,
) )
@click.option( @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( @click.option(
"--debug", is_flag=True, help="Enable debug mode - useful for development" "--debug", is_flag=True, help="Enable debug mode - useful for development"
) )

7
docs/datasette-serve-help.txt
View file

@ -6,8 +6,11 @@ Usage: datasette serve [OPTIONS] [FILES]...
Options: Options:
-i, --immutable PATH Database files to open in immutable mode -i, --immutable PATH Database files to open in immutable mode
-h, --host TEXT host for server, defaults to 127.0.0.1 -h, --host TEXT Host for server. Defaults to 127.0.0.1 which means only
-p, --port INTEGER port for server, defaults to 8001 connections from the local machine will be allowed. Use
0.0.0.0 to listen to all IPs and allow access from other
machines.
-p, --port INTEGER Port for server, defaults to 8001
--debug Enable debug mode - useful for development --debug Enable debug mode - useful for development
--reload Automatically reload if database or code change detected - --reload Automatically reload if database or code change detected -
useful for development useful for development