diff --git a/README.rst b/README.rst index d9c6dc6..8a17de1 100644 --- a/README.rst +++ b/README.rst @@ -56,23 +56,12 @@ Application configuration - ``CREDENTIALS_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``) - ``CREDENTIALS_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}"``) - ``CREDENTIALS_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``) -- ``CREDENTIALS_SITE_NAME`` (default: ``"LMS_HOST"``) - ``CREDENTIALS_REPOSITORY`` (default: ``"https://github.com/openedx/credentials.git"``) - ``CREDENTIALS_REPOSITORY_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``) Marketing & Theming ~~~~~~~~~~~~~~~~~~~ -- ``CREDENTIALS_LOGO_TRADEMARK_URL`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.svg"``) -- ``CREDENTIALS_LOGO_TRADEMARK_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.png"``) -- ``CREDENTIALS_LOGO_TRADEMARK_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.svg"``) -- ``CREDENTIALS_LOGO_URL`` (default: ``"https://edx-cdn.org/v3/default/logo.svg"``) -- ``CREDENTIALS_LOGO_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo.png"``) -- ``CREDENTIALS_LOGO_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo.svg"``) -- ``CREDENTIALS_LOGO_WHITE_URL`` (default: ``"https://edx-cdn.org/v3/default/logo-white.svg"``) -- ``CREDENTIALS_LOGO_WHITE_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo-white.png"``) -- ``CREDENTIALS_LOGO_WHITE_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo-white.svg"``) -- ``CREDENTIALS_FAVICON_URL`` (default: ``"https://edx-cdn.org/v3/default/favicon.ico"``) - ``CREDENTIALS_THEME_NAME`` (default: ``"edx-theme"``) Backend authentication @@ -80,19 +69,14 @@ Backend authentication - ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_KEY`` (default: ``"credentials-backend-service-key"``) - ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_SECRET`` (default: ``"{{ CREDENTIALS_OAUTH2_SECRET }}"``) -- ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL`` (default: ``"http://lms:8000/oauth2"``) - ``CREDENTIALS_OAUTH2_KEY`` (default: ``credentials-backend-service-key"``) - ``CREDENTIALS_OAUTH2_SECRET`` (default: ``"CHANGE-ME"``) Application Third party authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- ``CREDENTIALS_SOCIAL_AUTH_REDIRECT_IS_HTTPS`` (default: ``{% if ENABLE_HTTPS %}True{% else %}False{% endif %}``) -- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_ISSUER`` (default: ``"{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}"``) -- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT`` (default: ``"http://lms:8000"``) - ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_KEY`` (default: ``"credentials-sso-key"``) - ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_SECRET`` (default: ``"credentials-sso-secret"``) -- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL`` (default: ``"{{ SOCIAL_AUTH_EDX_OAUTH2_ISSUER }}/logout"``) Funding ------- diff --git a/changelog.d/20231130_110806_regis_simplify.md b/changelog.d/20231130_110806_regis_simplify.md new file mode 100644 index 0000000..0bdf2f4 --- /dev/null +++ b/changelog.d/20231130_110806_regis_simplify.md @@ -0,0 +1 @@ +- 💥[Improvement] Simplify plugin settings. As a consequence, many marketing settings are deprecated. If they were useful to you, you can override them using the "credentials-settings-common" patch. (by @regisb) diff --git a/tutorcredentials/plugin.py b/tutorcredentials/plugin.py index de74323..4dbddab 100644 --- a/tutorcredentials/plugin.py +++ b/tutorcredentials/plugin.py @@ -22,36 +22,18 @@ if __version_suffix__: config: t.Dict[str, t.Dict[str, t.Any]] = { "defaults": { "VERSION": __version__, - "BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL": "http://lms:8000/oauth2", "BACKEND_SERVICE_EDX_OAUTH2_KEY": "{{ CREDENTIALS_OAUTH2_KEY }}", "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}", "EXTRA_PIP_REQUIREMENTS": [], - "FAVICON_URL": "https://edx-cdn.org/v3/default/favicon.ico", "HOST": "credentials.{{ LMS_HOST }}", - "LOGO_TRADEMARK_URL": "https://edx-cdn.org/v3/default/logo-trademark.svg", - "LOGO_TRADEMARK_URL_PNG": "https://edx-cdn.org/v3/default/logo-trademark.png", - "LOGO_TRADEMARK_URL_SVG": "https://edx-cdn.org/v3/default/logo-trademark.svg", - "LOGO_URL": "", - "LOGO_URL_PNG": "{{ CREDENTIALS_LOGO_URL }}", - "LOGO_URL_SVG": "", - "LOGO_WHITE_URL": "{{ CREDENTIALS_LOGO_URL }}", - "LOGO_WHITE_URL_PNG": "{{ CREDENTIALS_LOGO_URL }}", - "LOGO_WHITE_URL_SVG": "", "MYSQL_DATABASE": "credentials", "MYSQL_USERNAME": "credentials", "OAUTH2_KEY": "credentials-key", "OAUTH2_KEY_DEV": "credentials-key-dev", "OAUTH2_KEY_SSO": "credentials-key-sso", "OAUTH2_KEY_SSO_DEV": "credentials-key-sso-dev", - "PLATFORM_NAME": "{{ PLATFORM_NAME }}", - "SITE_NAME": "{{ LMS_HOST }}", - "SOCIAL_AUTH_REDIRECT_IS_HTTPS": False, - "SOCIAL_AUTH_EDX_OAUTH2_ISSUER": "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}", - "SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT": "http://lms:8000", "SOCIAL_AUTH_EDX_OAUTH2_KEY": "credentials-sso-key", - "SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL": "{{ LMS_HOST }}/logout", "THEME_NAME": "edx-theme", - "TOS_URL": "{{ LMS_HOST }}/tos", "REPOSITORY": "https://github.com/openedx/credentials.git", "REPOSITORY_VERSION": "{{ OPENEDX_COMMON_VERSION }}", }, diff --git a/tutorcredentials/templates/credentials/apps/credentials/settings/development.py b/tutorcredentials/templates/credentials/apps/credentials/settings/development.py index 89b97eb..a6f4c34 100644 --- a/tutorcredentials/templates/credentials/apps/credentials/settings/development.py +++ b/tutorcredentials/templates/credentials/apps/credentials/settings/development.py @@ -2,7 +2,8 @@ from credentials.settings.devstack import * # pylint: disable=wildcard-import, u {% include "credentials/apps/credentials/settings/partials/common.py" %} -SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}:8000" +SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = "http://{{ LMS_HOST }}:8000" +FAVICON_URL = "http://{{ LMS_HOST }}:8000/favicon.ico" BACKEND_SERVICE_EDX_OAUTH2_KEY = "{{ CREDENTIALS_OAUTH2_KEY }}" diff --git a/tutorcredentials/templates/credentials/apps/credentials/settings/partials/common.py b/tutorcredentials/templates/credentials/apps/credentials/settings/partials/common.py index 9a9a82b..66342b2 100644 --- a/tutorcredentials/templates/credentials/apps/credentials/settings/partials/common.py +++ b/tutorcredentials/templates/credentials/apps/credentials/settings/partials/common.py @@ -36,16 +36,16 @@ JWT_AUTH["JWT_ISSUERS"] = [ } ] -LOGO_TRADEMARK_URL = "https://edx-cdn.org/v3/default/logo-trademark.svg" -LOGO_TRADEMARK_URL_PNG = "https://edx-cdn.org/v3/default/logo-trademark.png" -LOGO_TRADEMARK_URL_SVG = "https://edx-cdn.org/v3/default/logo-trademark.svg" -LOGO_URL = "https://edx-cdn.org/v3/default/logo.svg" -LOGO_URL_PNG = "https://edx-cdn.org/v3/default/logo.png" -LOGO_URL_SVG = "https://edx-cdn.org/v3/default/logo.svg" -LOGO_WHITE_URL = "https://edx-cdn.org/v3/default/logo-white.svg" -LOGO_WHITE_URL_PNG = "https://edx-cdn.org/v3/default/logo-white.png" -LOGO_WHITE_URL_SVG = "https://edx-cdn.org/v3/default/logo-white.svg" -FAVICON_URL = "https://edx-cdn.org/v3/default/favicon.ico" +LOGO_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/theming/asset/images/logo.png" +LOGO_TRADEMARK_URL = LOGO_URL +LOGO_TRADEMARK_URL_PNG = LOGO_URL +LOGO_TRADEMARK_URL_SVG = LOGO_URL +LOGO_URL_PNG = LOGO_URL +LOGO_URL_SVG = LOGO_URL +LOGO_WHITE_URL = LOGO_URL +LOGO_WHITE_URL_PNG = LOGO_URL +LOGO_WHITE_URL_SVG = LOGO_URL +FAVICON_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/favicon.ico" SOCIAL_AUTH_REDIRECT_IS_HTTPS = {% if ENABLE_HTTPS %}True{% else %}False{% endif %} SOCIAL_AUTH_EDX_OAUTH2_ISSUER = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}" diff --git a/tutorcredentials/templates/credentials/tasks/credentials/init b/tutorcredentials/templates/credentials/tasks/credentials/init index 098ea70..1b28127 100644 --- a/tutorcredentials/templates/credentials/tasks/credentials/init +++ b/tutorcredentials/templates/credentials/tasks/credentials/init @@ -5,7 +5,7 @@ echo "credentials service - ./manage.py migrate create_or_update_site" # for production ./manage.py create_or_update_site \ --site-domain "{{ CREDENTIALS_HOST }}" \ - --site-name "{{ CREDENTIALS_SITE_NAME }}" \ + --site-name "{{ LMS_HOST }}" \ --platform-name "{{ PLATFORM_NAME }}" \ --lms-url-root "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}" \ --catalog-api-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ DISCOVERY_HOST }}/api/v1/" \ @@ -19,7 +19,7 @@ echo "credentials service - ./manage.py migrate create_or_update_site" # for development ./manage.py create_or_update_site \ --site-domain "{{ CREDENTIALS_HOST }}" \ - --site-name "{{ CREDENTIALS_SITE_NAME }}" \ + --site-name "{{ LMS_HOST }}" \ --platform-name "{{ PLATFORM_NAME }}" \ --lms-url-root "http://{{ LMS_HOST }}:8000" \ --catalog-api-url "http://{{ DISCOVERY_HOST }}:8381/api/v1/" \