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

Add --host flag to dbt docs serve, defaulting to '127.0.0.1' #10229

Closed
1 task done
MichelleArk opened this issue May 27, 2024 · 2 comments · Fixed by #10228
Closed
1 task done

Add --host flag to dbt docs serve, defaulting to '127.0.0.1' #10229

MichelleArk opened this issue May 27, 2024 · 2 comments · Fixed by #10228
Assignees

Comments

@MichelleArk
Copy link
Contributor

Housekeeping

  • I am a maintainer of dbt-core

Short description

As part of GHSA-pmrx-695r-4349, we explicitly set 127.0.0.1 as the default bind address for dbt docs serve. However, we did not provide the ability for users to be able to override / opt-out of the default, and the change in default caused reported breakages in user deployments (example: #10208 (comment)). Let's add that ability, and backport it :)

Acceptance criteria

dbt docs serve binds to '127.0.0.1' by default, but is possible to override via a new --host flag.

Suggested Tests

  1. Test that passing an empty string is still possible for --host to restore previous behaviour
  2. Test default

Impact to Other Teams

N/A

Will backports be required?

Backport 1.6.latest, Backport 1.7.latest, Backport 1.8.latest

Context

No response

@MichelleArk
Copy link
Contributor Author

User docs: https://docs.getdbt.com/reference/commands/cmd-docs#dbt-docs-serve this section should be updated to include the new --host flag, which will default to localhost

@FishtownBuildBot
Copy link
Collaborator

Opened a new issue in dbt-labs/docs.getdbt.com: dbt-labs/docs.getdbt.com#5573

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants