Skip to content

Dev: Support https in development environments #10385

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

Closed
wants to merge 3 commits into from

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jun 5, 2023

Why

Depends on: readthedocs/common#176
Supersedes: #10265 (split up)

This setup enables a developer to:

  • Run development environments behind HTTPS
  • Use a custom production domain and subdomains
  • Test developer's own GitHub OAuth applications

What

Changes to docker-compose setup:

  • Storage HTTPS compatibility: Docker container for storage needs additional configuration
  • Custom domain w/ https possible: Additional settings to traverse from inv to settings.docker_compose
  • New socialauth options in settings.docker_compose to enable https
  • New setting to disable a suspicious host check in new unresolver

Changes

This PR was originally intended to add https compatibility to the storage container, but turned out a few more things beyond the inv docker.up --ngrok=custom.dev.example have been necessary


📚 Documentation previews 📚

@benjaoming benjaoming requested review from a team as code owners June 5, 2023 14:23
@benjaoming benjaoming requested a review from ericholscher June 5, 2023 14:23
@benjaoming benjaoming requested review from humitos and removed request for ericholscher June 5, 2023 14:35
Base automatically changed from dev/invoke-generic-http-option-name-disable-django-debug to main June 6, 2023 13:07
@humitos
Copy link
Member

humitos commented Jul 31, 2023

I'm closing this PR for now since we don't require HTTPS when working on development environment locally. We can come back if we decide we want to maintain this implementation.

@humitos humitos closed this Jul 31, 2023
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