coderedcms/docs/reference/django_settings.rst

Wagtail CRX Django Settings
===========================

Default settings are loaded from ``coderedcms/settings.py``. Available settings
for Wagtail CRX:


CRX_BANNER
----------

If you define a value for this ``CRX_BANNER``, CodeRedCMS will show this text in
a banner on both the front end and in the CMS of your site. This is useful for
flagging non-production environments like staging. For example::

    CRX_BANNER = "Staging Environment. Production is over here: <a href='https://example.com'>Example link</a>."

You can include basic HTML code, such as a link, in the banner.

The banner defaults to yellow background and black text. If you want to
customize the color, you can specify any HTML color name or code. For example::

    CRX_BANNER_BACKGROUND = '#FFFFE0'	# light yellow background
    CRX_BANNER_TEXT_COLOR = '#000'		# black text color

For greater customization, you can fully override the banner's HTML template:
``coderedcms/includes/crx_banner.html``.


CRX_BANNER_BACKGROUND
---------------------

String of a valid CSS color code to change the background of the banner.


CRX_BANNER_TEXT_COLOR
---------------------

String of a valid CSS color code to change the text color of the banner.


CRX_DISABLE_ANALYTICS
---------------------

If set to ``True``, the ``AnalyticsSettings`` model ( "Tracking" in Wagtail Admin) will not be registered. All tracking and analytics features will be disabled. Note that all buttons and links throughout CRX have "Advanced Settings" to customize the tracking behavior --- if disabled these will do nothing. Defaults to ``False``.


CRX_DISABLE_LAYOUT
------------------

If set to ``True``, the ``LayoutSettings`` model ( "CRX Settings" in Wagtail Admin) will not be registered. Many features such as the ability to set a logo, favion, Google Maps keys, etc. will not be available.

If you're looking to customize the navbar and footer, it is NOT recommended to disable this, but instead use the ``CRX_DISABLE_NAVBAR`` and ``CRX_DISABLE_FOOTER`` settings. This way the logo and various other features remain customizable by the user. The Layout Settings, and the logo in particular, are used **extensively** throughout CRX and therefore may cause unexpected breakage if disabled. Defaults to ``False``.


CRX_DISABLE_NAVBAR
------------------

If set to ``True``, the built-in ``Navbar`` model and related settings will be hidden from the Wagtail Admin.

This is recommended for most sites that want to build their own more advanced navbar.


CRX_DISABLE_FOOTER
------------------

If set to ``True``, the built-in ``Footer`` model and related settings will be hidden from the Wagtail Admin.

This is recommended for most sites that want to build their own more advanced footer.


CRX_FRONTEND_*
--------------

Various frontend settings to specify defaults and choices used in the wagtail
admin related to rendering blocks, pages, and templates. By default, all
CRX_FRONTEND_* settings are designed to work with Bootstrap 5 CSS framework, but
these can be customized if using a different CSS framework or theme variant.

`Available settings are defined here <https://github.com/coderedcorp/coderedcms/blob/main/coderedcms/settings.py>`.


CRX_PROTECTED_MEDIA_ROOT
------------------------

The directory where files from File Upload fields on Form Pages are saved. These
files are served through Django using ``CRX_PROTECTED_MEDIA_URL`` and require
login to access. Defaults to ``protected/`` in your project directory.


CRX_PROTECTED_MEDIA_UPLOAD_WHITELIST
------------------------------------

The allowed filetypes for media upload in the form of a list of file type
extensions. Default is blank. For example, to only allow documents and images,
set to: ``['.pdf', '.doc', '.docx', '.txt', '.rtf', '.jpg', '.jpeg', '.png',
'.gif']``


CRX_PROTECTED_MEDIA_UPLOAD_BLACKLIST
------------------------------------

The disallowed filetypes for media upload in the form of a list of file type
extensions. Defaults to ``['.sh', '.exe', '.bat', '.ps1', '.app', '.jar', '.py',
'.php', '.pl', '.rb']``


CRX_PROTECTED_MEDIA_URL
-----------------------

The URL for protected media files from form file uploads. Defaults to
``'/protected/'``