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

Change dev domain: local.edly.io -> local.openedx.org #18

Closed
5 tasks
Tracked by #152
kdmccormick opened this issue May 16, 2023 · 6 comments
Closed
5 tasks
Tracked by #152

Change dev domain: local.edly.io -> local.openedx.org #18

kdmccormick opened this issue May 16, 2023 · 6 comments

Comments

@kdmccormick
Copy link
Member

kdmccormick commented May 16, 2023

Background

Tutor requires a dev domain (other than localhost) which points to 127.0.0.1. I'm fuzzy on the reasons but I'm pretty sure it has to do with how authn plays with Docker's network addresses.

Historically this has been local.overhang.io, as of Quince it's local.edly.io.

Some options:

  • related to Open edX (would mean we need to get 2U's approval):
    • local.openedx.org
    • dev.openedx.org
    • my.openedx.org
  • related to Tutor (would mean that this domain wouldn't be used for non-Tutor dev envs):
    • tutorlocal.site
  • related to e-learning:
    • localdev.academy
    • localdev.school
  • related to nothing in particular:
    • bananasystems.com

Note that .dev isn't an option (I think) because it is an https-only domain.

@regisb indicated he'd be on board with this.

Tasks

  • choose a domain
  • set up the domain (Axim)
  • point Tutor at the new domain
    • optional: backport this to the previous release's Tutor version so that the old release's dev continues to work even after local.overhang.io is shut down.
  • make sure this is added to the release notes

Target

Quince

@regisb
Copy link
Contributor

regisb commented May 16, 2023

Tutor requires a dev domain (other than localhost) which points to 127.0.0.1. I'm fuzzy on the reasons but I'm pretty sure it has to do with how authn plays with Docker's network addresses.

Kind of :) There are actually a couple of reasons for having our own domain names, but only one which really matters. Services often need to talk to each other, and for that they use the same hostnames whether they make calls on the internal network or on the internet. For instance, the CMS makes HTTP requests to the LMS via http://local.overhang.io both in the Python process and the browser client. We could replace "local.overhang.io" by "openedx.localhost", which would also resolve to 127.0.0.1, but then we would have to tell the cms container that "openedx.localhost" is actually the "lms" container. And I don't really know how to do that.

@kdmccormick
Copy link
Member Author

Makes sense!

@kdmccormick
Copy link
Member Author

Some things that Axim just discussed:

  • 2U owns the Open edX trademark, so I'll need to check with them on this.
  • We don't want operators to put openedx in their real prod instance's domain. Hopefully this wouldn't encourage that.
  • An alternative that @brian-smith-tcril suggested: use something tutor-specific, like http://tutor.dev (turns out that's taken, but you get the idea).
  • Another alternative, @feanil suggested doing something nonsense like http://bananasystems.com because it doesn't really matter what the domain is as long as the user can remember it.
    • I disagree with this, I think the most memorable domain is one that relates to the project, and I think that having something openedx-related or tutor-related lends an air of professionalism.

@kdmccormick
Copy link
Member Author

kdmccormick commented May 17, 2023

One point in favor of something openedx-specfic rather than tutor-specific is that the same domain could be used in settings files for any Open edX distribution. Theoretically, Tutor and Devstack could both point to local.openedx.org.

@kdmccormick kdmccormick changed the title Change dev domain: local.overhang.io -> local.openedx.org Change dev domain: local.edly.io -> local.openedx.org Mar 28, 2024
@kdmccormick
Copy link
Member Author

Trying to make this happen has been so much bureaucracy. I'm not sure I care enough to make it happen any more. local.edly.io is short and sweet, and nobody in the Open edX community is complaining about it right now.

@regisb , if you would like to move to another domain, let me know. Otherwise, I'm fine closing this and sticking with local.edly.io 😄

@kdmccormick kdmccormick closed this as not planned Won't fix, can't repro, duplicate, stale Mar 28, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in DevOps Working Group Mar 28, 2024
@regisb
Copy link
Contributor

regisb commented Oct 10, 2024

Update: we'll eventually migrate to local.openedx.io as per overhangio/tutor#1120

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

No branches or pull requests

2 participants