What is the right plugin patches environment to alter studio.yml?

knoise · June 15, 2021, 8:08pm

I know that lms.yml can be altered with “lms-env”. What’s the correct thing to alter studio.yml? (I searched these forums and didn’t see anyone editing studio-env.)

misilot · June 16, 2021, 2:44pm

@knoise it is cms-env

github.com

overhangio/tutor/blob/master/tutor/templates/apps/openedx/config/cms.env.json#L39

    
      
          "ENABLE_COMPREHENSIVE_THEMING": true,
          "COMPREHENSIVE_THEME_DIRS": ["/openedx/themes"],
          "STATIC_ROOT_BASE": "/openedx/staticfiles",
          "EMAIL_BACKEND": "django.core.mail.backends.smtp.EmailBackend",
          "EMAIL_HOST": "{{ SMTP_HOST }}",
          "EMAIL_PORT": {{ SMTP_PORT }},
          "EMAIL_USE_TLS": {{ "true" if SMTP_USE_TLS else "false" }},
          "HTTPS": "{{ "on" if ENABLE_HTTPS else "off" }}",
          "LANGUAGE_CODE": "{{ LANGUAGE_CODE }}",
          "SESSION_COOKIE_DOMAIN": ".{{ LMS_HOST|common_domain(CMS_HOST) }}",
          {{ patch("cms-env", separator=",\n", suffix=",")|indent(2) }}
          "CACHES": {
            "default": {
              "KEY_PREFIX": "default",
              "VERSION": "1",
              "BACKEND": "django_redis.cache.RedisCache",
              "LOCATION": "redis://{% if REDIS_USERNAME and REDIS_PASSWORD %}{{ REDIS_USERNAME }}:{{ REDIS_PASSWORD }}{% endif %}@{{ REDIS_HOST }}:{{ REDIS_PORT }}/{{ OPENEDX_CACHE_REDIS_DB }}"
            },
            "general": {
              "KEY_PREFIX":  "general",
              "BACKEND": "django_redis.cache.RedisCache",

knoise · June 16, 2021, 6:19pm

Thanks! That was my guess, but I was doing the steps here, which said to edit the studio.yml

https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/youtube_api.html

and I made a plugin like this:

name: YTAPI_Plugin
version: 0.1.0
patches:
lms-env: |
“YOUTUBE_API_KEY”: “Redacted”
cms-env: |
  "YOUTUBE_API_KEY": "*Redacted*"

But I still couldn’t import video transcripts from YouTube, so I didn’t know if it was working or not.

Is there a place I can find the studio.yml to see that it got inserted properly?

misilot · June 16, 2021, 6:42pm

The lms.env.json and cms.env.json files are located in $(tutor config printroot)/env/apps/openedx/config/

You may also need to patch openedx-cms-production-settings and add the following as well

YOUTUBE_API_KEY = 'PUT_YOUR_API_KEY_HERE'

I am not seeing it anywhere except in the openedx common.py and production.py

@regis, is this correct?

knoise · June 16, 2021, 6:48pm

Yeah I found that through grepping (my change from the plugin went into there), but I’m specifically looking for the studio.yml mentioned on that Open edX page

misilot · June 16, 2021, 6:52pm

@knoise studio.yml was replaced with cms.yml I believe in Juniper

knoise · June 18, 2021, 4:40pm

Ah, I see. I guess the ReadTheDocs docs are just out of date then.

regis · June 22, 2021, 3:21pm

Exactly. You should open a PR to fix these docs

misilot · June 23, 2021, 12:03am

~~Submitted a PR for that page~~

Scratch that, closed it. studio.yml is correct in the Native Install. Tutor is using cms.yml, sorry for the confusion.

system · September 21, 2021, 12:04am

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.