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

Adds docs on allowed_hosts for UI #1229

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Adds docs on allowed_hosts for UI #1229

merged 2 commits into from
Nov 14, 2024

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Nov 14, 2024

So that people know what to do.

Changes

  • docs

How I tested this

  • locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

So that people know what to do.
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 5459b52 in 4 seconds

More details
  • Looked at 14 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/hamilton-ui/ui.rst:52
  • Draft comment:
    Consider adding a warning about the security implications of setting HAMILTON_ALLOWED_HOSTS to *, as it allows requests from any host.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The note about setting HAMILTON_ALLOWED_HOSTS is useful, but it could be more explicit about the security implications of setting it to *.
2. docs/hamilton-ui/ui.rst:52
  • Draft comment:
    Consider adding this note about setting the HAMILTON_ALLOWED_HOSTS environment variable to the installation or troubleshooting section for better visibility.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The note about setting the environment variable HAMILTON_ALLOWED_HOSTS should be documented in the installation or troubleshooting section for better visibility.

Workflow ID: wflow_BXx4joMGGbA5EWU3


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on bc0c258 in 3 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/hamilton-ui/ui.rst:52
  • Draft comment:
    Consider rephrasing for clarity: HAMILTON_ALLOWED_HOSTS="*" (or a comma-separated list of desired domains) for the backend Docker container.
  • Reason this comment was not posted:
    Confidence changes required: 33%
    The documentation update is clear and provides necessary information about setting the environment variable for allowed hosts. However, it could be slightly improved for clarity.
2. docs/hamilton-ui/ui.rst:52
  • Draft comment:
    Consider adding this information about setting HAMILTON_ALLOWED_HOSTS to the Sphinx documentation under docs/ for better visibility and reference.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The documentation update is clear and concise. However, it would be beneficial to add this information to the Sphinx documentation for better visibility.

Workflow ID: wflow_xKnLoOw3l25Sg79k


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@skrawcz skrawcz merged commit 1b07790 into main Nov 14, 2024
22 of 24 checks passed
@skrawcz skrawcz deleted the add_allowed_hosts_doc branch November 14, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant