Skip to content

Correct Docker localhost URLs in Docs#281

Merged
benjie merged 2 commits intographile:developfrom
24601:docker-doc-fix
Jul 23, 2021
Merged

Correct Docker localhost URLs in Docs#281
benjie merged 2 commits intographile:developfrom
24601:docker-doc-fix

Conversation

@24601
Copy link
Copy Markdown
Contributor

@24601 24601 commented Jul 22, 2021

Description

As documented (and by default) local docker-compose endpoints are not HTTPS, they are HTTP. While certainly possible to run with HTTPS, as configured, they are HTTP listeners, and anyone visiting the exact URL will experience an error despite the HTTP URL working just fine.

Performance impact

None - but it should help user experience for those who are following the docs and aren't too familiar with local hosting, docker, and HTTP/networking in general from being frustrated, is that performance?

Security impact

None

Checklist

  • My code matches the project's code style and yarn lint:fix passes.
  • N/A I've added tests for the new feature, and yarn test passes.
  • N/A I have detailed the new feature in the relevant documentation.
  • (N/A - not a feature) I have added this feature to 'Pending' in the RELEASE_NOTES.md file (if one exists).
  • (N/A - not a breaking change) If this is a breaking change I've explained why.

24601 added 2 commits July 22, 2021 15:09
As documented (and by default) local docker-compose endpoints are not HTTPS, they are HTTP. While certainly possible to run with HTTPS, as configured, they are HTTP listeners, and anyone visiting the exact URL will experience an error despite the HTTP URL working just fine.
Copy link
Copy Markdown
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Thanks! 🙌

@benjie benjie merged commit c304b14 into graphile:develop Jul 23, 2021
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.

2 participants