.. _requirements:

Requirements
============

.. contents:: On this page
   :local:
   :depth: 2

Open edX Version
-----------------

Branding by Aulasneo requires **Open edX Ulmo or later**. Paragon design token support,
on which the real-time styling mechanism depends, was introduced in the Ulmo release.

If you are unsure which Open edX version your site is running, you can check it at
`https://openedxcheck.aulasneo.com/ <https://openedxcheck.aulasneo.com/>`_.

If your site requires an upgrade, contact the Aulasneo team at
`https://aulasneo.com <https://aulasneo.com>`_.

Open edX Compatibility
-----------------------

Branding by Aulasneo is compatible with any standard Open edX installation, including:

* Self-hosted installations.
* Provider-hosted installations, regardless of the hosting provider.
* Tutor-based deployments (recommended for full automation support).
* Non-Tutor deployments (with manual configuration steps).

Recommended: Tutor Branding Plugin
------------------------------------

To automate the application of compiled themes to your Open edX site, it is strongly
recommended to install and enable the **Tutor Branding Plugin**:

.. code-block:: bash

   pip install tutor-contrib-branding

This plugin adds support for the ``BRANDING_*`` Tutor configuration variables that the
platform uses to inject your custom CSS, logos, and fonts into the MFE layer.

The plugin version must be **21 or higher** to support the full set of features, including
the automatic copy of the Tutor command from the build list.

Optional: Disable Tutor Indigo
-------------------------------

If your site uses the **Tutor Indigo** plugin for theming, it is recommended to disable it
when using Branding by Aulasneo, as the two theming systems may conflict.

Non-Tutor Installations
------------------------

Branding by Aulasneo can be connected to non-Tutor Open edX installations with some
additional manual configuration. In such cases, the asset URLs produced by each build must be
manually added to the appropriate MFE environment configuration. Contact the Aulasneo support
team for guidance specific to your deployment.

Subscription Plan
------------------

Access to Branding by Aulasneo features is governed by your subscription plan. Different
plans set limits on the number of themes, variants, logo sets, font sets, builds, and team
members you can create. For details, visit the billing section in your account settings.

`Back to Home <index.html>`_