Skip to content

Commit

Permalink
feat: migrate from *.local.edly.io to *.local.openedx.io
Browse files Browse the repository at this point in the history
This makes it more clear for everyone that Tutor is an Open edX
distribution.

Close #1120
  • Loading branch information
regisb committed Oct 17, 2024
1 parent f7e223c commit a49c5a5
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 8 deletions.
1 change: 1 addition & 0 deletions changelog.d/20241010_131903_regis_local_openedx_io.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- 💥[Feature] Migrate from local.edly.io to local.openedx.io. (by @regisb)
6 changes: 3 additions & 3 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This will perform several tasks. It will:
* build the "openedx-dev" Docker image, which is based on the "openedx" production image but is `specialized for developer usage`_ (eventually with your fork),
* stop any existing locally-running Tutor containers,
* disable HTTPS,
* set ``LMS_HOST`` to `local.edly.io <http://local.edly.io>`_ (a convenience domain that simply `points at 127.0.0.1 <https://dnschecker.org/#A/local.edly.io>`_),
* set ``LMS_HOST`` to `local.openedx.io <http://local.openedx.io>`_ (a convenience domain that simply `points at 127.0.0.1 <https://dnschecker.org/#A/local.openedx.io>`_),
* prompt for a platform details (with suitable defaults),
* start LMS, CMS, supporting services, and any plugged-in services,
* ensure databases are created and migrated, and
Expand All @@ -42,8 +42,8 @@ Additionally, when a local clone of edx-platform is bind-mounted, it will:

Once setup is complete, the platform will be running in the background:

* LMS will be accessible at `http://local.edly.io:8000 <http://local.edly.io:8000>`_.
* CMS will be accessible at `http://studio.local.edly.io:8001 <http://studio.local.edly.io:8001>`_.
* LMS will be accessible at `http://local.openedx.io:8000 <http://local.openedx.io:8000>`_.
* CMS will be accessible at `http://studio.local.openedx.io:8001 <http://studio.local.openedx.io:8001>`_.
* Plugged-in services should be accessible at their documented URLs.

Now, use the ``tutor dev ...`` command-line interface to manage the development environment. Some common commands are described below.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/theming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ Then, run a local webserver::

tutor dev start lms

The LMS can then be accessed at http://local.edly.io:8000. You will then have to :ref:`enable that theme <settheme>`::
The LMS can then be accessed at http://local.openedx.io:8000. You will then have to :ref:`enable that theme <settheme>`::

tutor dev do settheme mythemename

Watch the themes folders for changes (in a different terminal)::

tutor dev run watchthemes

Make changes to some of the files inside the theme directory: the theme assets should be automatically recompiled and visible at http://local.edly.io:8000.
Make changes to some of the files inside the theme directory: the theme assets should be automatically recompiled and visible at http://local.openedx.io:8000.
5 changes: 3 additions & 2 deletions tutor/interactive.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ def ask_questions(
defaults = tutor_config.get_defaults()
if run_for_prod is None:
run_for_prod = not config.get("LMS_HOST") in [
"local.openedx.io",
"local.edly.io",
"local.overhang.io",
]
Expand All @@ -41,8 +42,8 @@ def ask_questions(
)
if not run_for_prod:
dev_values: Config = {
"LMS_HOST": "local.edly.io",
"CMS_HOST": "studio.local.edly.io",
"LMS_HOST": "local.openedx.io",
"CMS_HOST": "studio.local.openedx.io",
"ENABLE_HTTPS": False,
}
fmt.echo_info(
Expand Down
2 changes: 1 addition & 1 deletion tutor/templates/local/docker-compose.prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ services:
networks:
default:
# These aliases are for internal communication between containers when running locally
# with *.local.edly.io hostnames.
# with *.local.openedx.io hostnames.
aliases:
- "{{ LMS_HOST }}"
{{ patch("local-docker-compose-caddy-aliases")|indent(10) }}
Expand Down

0 comments on commit a49c5a5

Please sign in to comment.