fix: fix site configuration issue for dev mode

README.rst

@@ -30,6 +30,11 @@ Usage
     tutor plugins enable discovery mfe credentials
     tutor local launch
 
+For Copying programs that user make in `Discovery plugin <https://github.com/overhangio/tutor-discovery>`__ into Credentials. Run the below command:
+::
+
+    tutor local run credentials ./manage.py copy_catalog
+
 Using Django Admin
 ~~~~~~~~~~~~~~~~~~
 
@@ -45,12 +50,14 @@ Application configuration
 - ``CREDENTIALS_MYSQL_DATABASE`` (default: ``"credentials"``)
 - ``CREDENTIALS_MYSQL_USERNAME`` (default: ``"credentials"``)
 - ``CREDENTIALS_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``)
-- ``CREDENTIALS_CATALOG_API_URL`` (default: ``"{{ LMS_HOST }}"``)
+- ``CREDENTIALS_CATALOG_API_URL`` (default: ``"http://discovery.local.overhang.io/api/v1/"``)
 - ``CREDENTIALS_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}"``)
 - ``CREDENTIALS_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``)
 - ``CREDENTIALS_PRIVACY_POLICY_URL``  (default: ``"LMS_HOST/pricacy-policy"``)
 - ``CREDENTIALS_SITE_NAME`` (default: ``"LMS_HOST"``)
 - ``CREDENTIALS_TOS_URL`` (default: ``"{{ LMS_HOST }}/tos"``)
+- ``CREDENTIALS_REPOSITORY`` (default: ``"https://github.com/edx/credentials.git"``)
+- ``CREDENTIALS_REPOSITORY_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``)
 
 Marketing & Theming
 ~~~~~~~~~~~~~~~~~~~

changelog.d/20231114_144930_faraz.maqsood_fix_site_configuration_issue.md

@@ -0,0 +1,2 @@
+- [Bugfix] Fix the issue of site was not being created during tutor dev launch. (by @Faraz32123)
+- [Enhancement] Add support for using custom credentials repository using CREDENTIALS_REPOSITORY and CREDENTIALS_REPOSITORY_VERSION. (by @Faraz32123)

tutorcredentials/plugin.py

@@ -27,7 +27,7 @@ tutor_hooks.Filters.CONFIG_DEFAULTS.add_items(
         ("CREDENTIALS_VERSION", __version__),
         ("CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL", "http://lms:8000/oauth2"),
         ("CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_KEY", "{{ CREDENTIALS_OAUTH2_KEY }}"),
-        ("CREDENTIALS_CATALOG_API_URL", "{{ LMS_HOST }}"),
+        ("CREDENTIALS_CATALOG_API_URL", "http://discovery.local.overhang.io/api/v1/"),
         ("CREDENTIALS_DOCKER_IMAGE", "{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}"),
         ("CREDENTIALS_EXTRA_PIP_REQUIREMENTS", []),
         ("CREDENTIALS_FAVICON_URL", "https://edx-cdn.org/v3/default/favicon.ico"),
@@ -59,6 +59,8 @@ tutor_hooks.Filters.CONFIG_DEFAULTS.add_items(
         ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL", "{{ LMS_HOST }}/logout"),
         ("CREDENTIALS_THEME_NAME", "edx-theme"),
         ("CREDENTIALS_TOS_URL", "{{ LMS_HOST }}/tos"),
+        ("CREDENTIALS_REPOSITORY", "https://github.com/edx/credentials.git"),
+        ("CREDENTIALS_REPOSITORY_VERSION", "{{ OPENEDX_COMMON_VERSION }}"),
     ]
 )
 

tutorcredentials/templates/credentials/build/credentials/Dockerfile

@@ -37,8 +37,8 @@ RUN $PYENV_ROOT/versions/$PYTHON_VERSION/bin/python -m venv /openedx/venv
 
 ###### Checkout credentials
 FROM minimal as code
-ARG CREDENTIALS_REPOSITORY=https://github.com/edx/credentials.git
+ARG CREDENTIALS_REPOSITORY="{{ CREDENTIALS_REPOSITORY }}"
-ARG CREDENTIALS_VERSION="{{ OPENEDX_COMMON_VERSION }}"
+ARG CREDENTIALS_VERSION="{{ CREDENTIALS_REPOSITORY_VERSION }}"
 RUN mkdir -p /openedx/credentials && \
     git clone $CREDENTIALS_REPOSITORY --branch $CREDENTIALS_VERSION --depth 1 /openedx/credentials
 WORKDIR /openedx/credentials

tutorcredentials/templates/credentials/tasks/credentials/init

@@ -1,14 +1,31 @@
 echo "credentials service - ./manage.py migrate"
-./manage.py migrate --noinput
+./manage.py migrate
+
 echo "credentials service - ./manage.py migrate create_or_update_site"
-./manage.py create_or_update_site --site-domain "{{ CREDENTIALS_HOST }}" \
+# for production
-                                  --site-name "{{ CREDENTIALS_SITE_NAME }}" \
+./manage.py create_or_update_site \
-                                  --platform-name "{{ PLATFORM_NAME }}" \
+  --site-domain "{{ CREDENTIALS_HOST }}" \
-                                  --lms-url-root "{{ CREDENTIALS_LMS_URL_ROOT }}" \
+  --site-name "{{ CREDENTIALS_SITE_NAME }}" \
-                                  --catalog-api-url "{{ CREDENTIALS_CATALOG_API_URL }}" \
+  --platform-name "{{ PLATFORM_NAME }}" \
-                                  --tos-url "{{ CREDENTIALS_TOS_URL }}" \
+  --lms-url-root "{{ CREDENTIALS_LMS_URL_ROOT }}" \
-                                  --privacy-policy-url "{{ CREDENTIALS_PRIVACY_POLICY_URL }}" \
+  --catalog-api-url "{{ CREDENTIALS_CATALOG_API_URL }}" \
-                                  --homepage-url "{{ CREDENTIALS_LMS_URL }}" \
+  --tos-url "{{ CREDENTIALS_TOS_URL }}" \
-                                  --company-name "{{ PLATFORM_NAME }}" \
+  --privacy-policy-url "{{ CREDENTIALS_PRIVACY_POLICY_URL }}" \
-                                  --certificate-help-url "{{ CREDENTIALS_LMS_URL }}" \
+  --homepage-url "{{ CREDENTIALS_LMS_URL }}" \
-                                  --theme-name "{{ CREDENTIALS_THEME_NAME }}"
+  --company-name "{{ PLATFORM_NAME }}" \
+  --certificate-help-url "{{ CREDENTIALS_LMS_URL }}" \
+  --theme-name "{{ CREDENTIALS_THEME_NAME }}"
+
+# for development
+./manage.py create_or_update_site \
+  --site-domain "{{ CREDENTIALS_HOST }}" \
+  --site-name "{{ CREDENTIALS_SITE_NAME }}" \
+  --platform-name "{{ PLATFORM_NAME }}" \
+  --lms-url-root "{{ CREDENTIALS_LMS_URL_ROOT }}:8000" \
+  --catalog-api-url "http://discovery.local.overhang.io:8381/api/v1/" \
+  --tos-url "{{ LMS_HOST }}:8000/tos" \
+  --privacy-policy-url "{{ LMS_HOST }}:8000/privacy-policy" \
+  --homepage-url "{{ CREDENTIALS_LMS_URL }}:8000" \
+  --company-name "{{ PLATFORM_NAME }}" \
+  --certificate-help-url "{{ CREDENTIALS_LMS_URL }}:8000" \
+  --theme-name "{{ CREDENTIALS_THEME_NAME }}"