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

[docs] Advanced config: HOST description misleading #7671

Closed
jsejcksn opened this issue Sep 11, 2019 · 4 comments · Fixed by #7823
Closed

[docs] Advanced config: HOST description misleading #7671

jsejcksn opened this issue Sep 11, 2019 · 4 comments · Fixed by #7823

Comments

@jsejcksn
Copy link
Contributor

In the advanced configuration page, the description for the HOST var is

By default, the development web server binds to localhost. You may use this variable to specify a different host.

However, that's not quite correct, as it seems to bind to 0.0.0.0 (all available hostnames on the network interface). This can be seen from the console message when running npm run start:

You can now view react-app in the browser.

  Local:            http://localhost:3000/
  On Your Network:  http://10.0.1.55:3000/

Note that the development build is not optimized.
To create a production build, use npm run build.

This is useful for accessing the development device from other devices on the network, but is undesirable when the developer expects to only be able to access the content via localhost.

I'm not objecting to the default behavior, but I think that the docs should be updated to reflect what's actually happening. For example, setting

HOST=localhost

in .env produces the actual behavior in the current description.

I suggest changing to the description to something like:

By default, the development web server binds to all hostnames on the device (localhost, LAN network address, etc.). You may use this variable to specify a different host.

@stale
Copy link

stale bot commented Oct 11, 2019

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs.

@stale stale bot added the stale label Oct 11, 2019
@jsejcksn
Copy link
Contributor Author

Can someone triage this?

@stale stale bot removed the stale label Oct 12, 2019
@ianschmitz
Copy link
Contributor

Sounds reasonable. Want to send a PR updating the docs?

@jsejcksn
Copy link
Contributor Author

Done.

@lock lock bot locked and limited conversation to collaborators Oct 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants