Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve usage description of --host option #574

Closed
terrycojones opened this issue Sep 17, 2019 · 2 comments

Comments

@terrycojones
Copy link

@terrycojones terrycojones commented Sep 17, 2019

It would be nice if the --host option had a clearer description. I tried to get datasette running on an AWS instance and it took a while to realize it was only listening on localhost. So I wanted to make it listen on an non-localhost interface and tried giving a couple of values to --host (a host name, then an interface name), but none of them did. In the end I read the source to see that the option is passed to uvicorn and looked at the uvicorn docs, which also didn't help. Then I searched the web for "example running datasette on a host" which led me to #514 where I saw someone using -h 0.0.0.0. I tried that and it works. That usage could be mentioned somewhere, and might save someone else some time.

@simonw

This comment has been minimized.

Copy link
Owner

@simonw simonw commented Nov 1, 2019

That's a great idea, thanks for the feedback.

@simonw simonw closed this in ffae2f0 Nov 1, 2019
@simonw

This comment has been minimized.

Copy link
Owner

@simonw simonw commented Nov 1, 2019

New description:

  -h, --host TEXT           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.
simonw added a commit that referenced this issue Nov 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.