diff --git a/README.rst b/README.rst index 4a4fc95..5b4449c 100644 --- a/README.rst +++ b/README.rst @@ -11,13 +11,14 @@ Installation Configuration ------------- +- ``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_CATALOG_API_URL`` (default: ``"{{ LMS_HOST }}"``) - ``CREDENTIALS_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}lpm0073/openedx-credentials:{{ CREDENTIALS_VERSION }}"``) -- ``CREDENTIALS_SECRET_KEY`` (default: ``"CHANGE-ME"``) - ``CREDENTIALS_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``) +- ``CREDENTIALS_FAVICON_URL`` (default: ``"https://edx-cdn.org/v3/default/favicon.ico"``) - ``CREDENTIALS_HOST`` (default: ``"credentials.{{ LMS_HOST }}"``) -- ``CREDENTIALS_MYSQL_DATABASE`` (default: ``"credentials"``) -- ``CREDENTIALS_MYSQL_USERNAME`` (default: ``"credentials"``) -- ``CREDENTIALS_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``) - ``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"``) @@ -27,18 +28,21 @@ Configuration - ``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_MYSQL_DATABASE`` (default: ``"credentials"``) +- ``CREDENTIALS_MYSQL_USERNAME`` (default: ``"credentials"``) +- ``CREDENTIALS_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``) - ``CREDENTIALS_OAUTH2_KEY`` (default: ``credentials-backend-service-key"``) -- ``CREDENTIALS_OAUTH2_SECRET`` (default: ``CHANGE-ME"``) +- ``CREDENTIALS_OAUTH2_SECRET`` (default: ``"CHANGE-ME"``) +- ``CREDENTIALS_PRIVACY_POLICY_URL`` (default: ``"LMS_HOST/pricacy-policy"``) +- ``CREDENTIALS_SECRET_KEY`` (default: ``"CHANGE-ME"``) +- ``CREDENTIALS_SITE_NAME`` (default: ``"LMS_HOST"``) - ``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"``) -- ``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_TOS_URL`` (default: ``"{{ LMS_HOST }}/tos"``) diff --git a/tutorcredentials/plugin.py b/tutorcredentials/plugin.py index 9d432b2..76c2014 100644 --- a/tutorcredentials/plugin.py +++ b/tutorcredentials/plugin.py @@ -9,14 +9,14 @@ from .__about__ import __version__ ################# Configuration config = { - # Add here your new settings "defaults": { - "VERSION": __version__, + "BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL": "http://lms:8000/oauth2", + "BACKEND_SERVICE_EDX_OAUTH2_KEY": "{{ CREDENTIALS_OAUTH2_KEY }}", + "CATALOG_API_URL": "{{ LMS_HOST }}", "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}lpm0073/openedx-credentials:{{ CREDENTIALS_VERSION }}", "EXTRA_PIP_REQUIREMENTS": [], + "FAVICON_URL": "https://edx-cdn.org/v3/default/favicon.ico", "HOST": "credentials.{{ LMS_HOST }}", - "MYSQL_DATABASE": "credentials", - "MYSQL_USERNAME": "credentials", "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", @@ -26,15 +26,18 @@ config = { "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", + "MYSQL_DATABASE": "credentials", + "MYSQL_USERNAME": "credentials", "OAUTH2_KEY": "credentials-backend-service-key", + "PRIVACY_POLICY_URL": "{{ LMS_HOST }}/privacy-policy", + "SITE_NAME": "{{ LMS_HOST }}", "SOCIAL_AUTH_REDIRECT_IS_HTTPS": False, "SOCIAL_AUTH_EDX_OAUTH2_ISSUER": "https://{{ 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", - "BACKEND_SERVICE_EDX_OAUTH2_KEY": "{{ CREDENTIALS_OAUTH2_KEY }}", - "BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL": "http://lms:8000/oauth2" + "VERSION": __version__, + "TOS_URL": "{{ LMS_HOST }}/tos", }, # Add here settings that don't have a reasonable default for all users. For # instance: passwords, secret keys, etc. diff --git a/tutorcredentials/templates/credentials/tasks/credentials/init b/tutorcredentials/templates/credentials/tasks/credentials/init index a7fff0e..f6d20b2 100644 --- a/tutorcredentials/templates/credentials/tasks/credentials/init +++ b/tutorcredentials/templates/credentials/tasks/credentials/init @@ -1,11 +1,11 @@ ./manage.py migrate --noinput ./manage.py create_or_update_site --site-domain {{ CREDENTIALS_HOST }} \ - --site-name {{ SITE_NAME }} \ + --site-name {{ CREDENTIALS_SITE_NAME }} \ --platform-name {{ PLATFORM_NAME }} \ --lms-url-root {{ LMS_URL_ROOT }} \ - --catalog-api-url {{ CATALOG_API_URL }} \ - --tos-url {{ TOS_URL }} \ - --privacy-policy-url {{ PRIVACY_POLICY_URL }} \ + --catalog-api-url {{ CREDENTIALS_CATALOG_API_URL }} \ + --tos-url {{ CREDENTIALS_TOS_URL }} \ + --privacy-policy-url {{ CREDENTIALS_PRIVACY_POLICY_URL }} \ --homepage-url {{ LMS_URL }} \ --company-name {{ PLATFORM_NAME }} \ --certificate-help-url {{ LMS_URL }}