Tutor-contrib-branding on Tutor 20.0.5 + Indigo: BRANDING_* never applied

Hi all,

I’m using Tutor with Indigo and the tutor-contrib-branding plugin to do basic color/logo changes, but branding settings never make it into the generated env files.

Environment

  • Tutor: 20.0.5

  • Open edX: Ulmo

  • Plugins (relevant):

    • indigo 21.1.0 :white_check_mark: enabled

    • mfe 21.0.0 :white_check_mark: enabled

    • branding 20.0.1 :white_check_mark: enabled

What I did

  1. Added a loud test color in Tutor config:

text

# /home/edx/.local/share/tutor/config.yml

BRANDING_BG_PRIMARY: “#ff0000

PLUGINS:

- aspects

- branding

- deck

- forum

- indigo

- mfe

  1. Regenerated config:

bash

tutor config save

  1. Checked both config and rendered env:

bash

grep BRANDING_ /home/edx/.local/share/tutor/config.yml

# → BRANDING_BG_PRIMARY: '#ff0000*'*

grep BRANDING_ /home/edx/.local/share/tutor/env/apps/openedx/config/lms.env.yml \

|| echo “no BRANDING_ keys in lms.env.yml”

# → no BRANDING_ keys in lms.env.yml

grep -R “BRANDING_” /home/edx/.local/share/tutor/env \

|| echo “no BRANDING_ anywhere under env”

# → no BRANDING_ anywhere under env

  1. Logged tutor config save output:

bash

tutor config save > /tmp/tutor-config-save.log 2>&1

grep -iE “branding|patch|template|error|traceback|exception” /tmp/tutor-config-save.log \

|| echo “no obvious config-save errors”

# → no obvious config-save errors

So:

  • branding is enabled.

  • BRANDING_BG_PRIMARY is present at the top level of config.yml.

  • tutor config save completes without visible errors.

  • But no BRANDING_* strings appear anywhere under /home/edx/.local/share/tutor/env, including lms.env.yml, so the LMS never sees any branding settings.

I’ve rolled back any custom Indigo overrides; the system is otherwise on stock Indigo and working fine.

Questions

  • Is the combination Tutor 20.0.5 + Indigo 21.1.0 + tutor-contrib-branding 20.0.1 expected to work?

  • If yes, which env/template patch should branding be using in Ulmo, and is there a known fix when BRANDING_* never appears in env despite the plugin being enabled?

  • If not, is there a recommended version combo or alternative approach for simple color/logo branding on Ulmo with Indigo (without heavy template overrides)?

Thanks in advance for any pointers.

Hi- quick question, if you’re using Tutor 20 you should be using Teak. Ulmo is Tutor 21. Could you doublecheck that you’re using the right software versions?

Thanks, that’s my mistake on naming.
tutor --version is 20.0.5, so I’m on Teak, not Ulmo.
The issue I’m seeing (no BRANDING_* anywhere under /home/edx/.local/share/tutor/env after tutor config save, even though BRANDING_BG_PRIMARY is present in /home/edx/.local/share/tutor/config.yml and branding is enabled) is happening on:

Tutor 20.0.5 (Teak)

tutor-indigo 21.1.0

tutor-contrib-branding 20.0.1

So the plugin and theme versions should be in the right Teak band; that’s why I’m puzzled that no BRANDING_* settings are getting injected into lms.env.yml.

Indigo does some really crazy stuff. Do you think you could disable indigo and test, to determine if it’s an Indigo specific issue?

Probably, I sit somewhere between old techie and hobbyist running a home lab with assistance from Perplexity AI which works pretty well if correctly prompted. I’m not sure what the default theme is with this install, I will see what the AI thinks. It has been working through this issue with me and has some context. What’s the optimal setup for the Branding extension? Basically I want to adjust theme elements, fonts, color, brand images. Thanks

@Richard_Civille I don’t know much about branding, but I will know who to tag into this thread depending on if it’s an Indigo issue or a Branding issue. The only way to figure that out is to disable Indigo entirely, then try out the branding stuff. Unfortunately Indigo causes a lot of problems as it’s a layer atop Open edX that many developers have off during development, for an example + disable steps see [SOLVED] Frontend build failure during tutor v19 to v20 upgrade. Indigo plugin issue

PS> We only support the latest release, which is Ulmo, and it will go out of support in June in favor of Verawood. If you’re a hobbyist and playing around I definitely encourage you to use the latest release, it also makes debugging/help easier as developers are working on the latest bits of code.

Hi Richard

Indigo already provides built-in support for changing the primary color. It uses its own INDIGO_* settings, so BRANDING_* variables won’t affect it.

You can update the Indigo theme’s primary color directly using:

tutor config save --set 'INDIGO_PRIMARY_COLOR="#ff0000"'

This will change the main theme color across Indigo-based LMS pages (e.g., header, buttons, links, etc.).

For further details, you can refer to the official configuration docs:
https://github.com/overhangio/tutor-indigo/#configuration

Thanks so much for the recent feedback, I’m getting ready for some more tests. It looks like there may have been a recent update to the branding plug-in and will check that out and see what happens. Will keep an eye out for the next edx upgrade coming in June.

Hi @Richard_Civille,
You either chose Indigo or tutor-contrib-branding. Both will not work well together.
To know that BRANDING_BG_PRIMARY was applied, do grep background $(tutor config printroot)/env/* -r.

If you move to Ulmo, you will be able to customize your site with tutor-contrib-branding and connecting it to https://branding.aulasneo.com. Let me know if you need any help with that.

Andrés.