`REFLEX_DJANGO_*` settings¶

Every knob the library exposes, organized by what it controls. Defaults are sensible — most projects don't change any of these.

For how to use them in context, see Configuration with reflex_mount().

Routing¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_URL_ROUTING`	`str`	`"auto"` → `"django_outer"`	Routing mode. Almost never change. Other values: `"reflex_led"` (legacy two-port), `"django_led"`.
`REFLEX_DJANGO_RESERVED_REFLEX_PREFIXES`	`tuple[str, ...]`	`()`	Extra path prefixes always routed to Reflex (added to the built-in list: `/_event`, `/_upload`, `/_health`, `/ping`, `/_all_routes`, `/auth-codespace`).

Serving¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_SERVE_FROM_BUILD`	`bool`	`True`	`run_reflex` auto-builds the SPA and serves it from disk. Set `False` for `--with-vite` HMR.
`REFLEX_DJANGO_RENDER_SPA_VIA_TEMPLATE_ENGINE`	`bool`	`True`	Pipe `STATIC_ROOT/_reflex/index.html` through Django's template engine so `{{ request.user }}`, `{% csrf_token %}` work in the SPA shell.
`REFLEX_DJANGO_SHOW_BUILT_WITH_REFLEX`	`bool`	`False`	Show or hide the "Built with Reflex" footer.
`REFLEX_DJANGO_DEV_PROXY`	`bool`	`False`	Auto-managed by `run_reflex --with-vite`. Don't set manually.

Frontend toolchain¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_VITE_VERSION`	`str \\| None`	`None`	Override the `vite` devDependency Reflex writes into `.web/package.json`. When unset (the default), the version that ships with the installed `reflex_base` package is used as-is. Also readable from the env var of the same name; the Django setting wins if both are present. See When to use it below.

When to pin Vite¶

You usually don't need this — the version reflex_base ships with is the version Reflex tested against. Reach for it when a Reflex release pins a Vite version that has a known frontend regression. The typical symptom is the SPA loading but throwing an exception inside the Reflex Socket.IO dispatcher or inside a third-party chart library:

[Reflex Frontend Exception] TypeError: t is not a function
    at .../assets/es6-<hash>.js
[Reflex Frontend Exception] TypeError: d is not a function
    at Socket.<anonymous> (.../assets/theme-<hash>.js)

That pattern (single-letter local variable that should be a function, called inside a memoized factory wrapper) is the Rolldown CJS-interop bug shipped with Vite 8.0.x. Pin to the latest Rollup-based release (Vite 7.3.3) until upstream ships a fix:

# settings.py
REFLEX_DJANGO_VITE_VERSION = "7.3.3"

Or, equivalently, from the shell:

export REFLEX_DJANGO_VITE_VERSION=7.3.3
python manage.py run_reflex

Then wipe and rebuild:

rm -rf .web staticfiles/_reflex
python manage.py run_reflex

The override is applied during install_reflex_django_integration() — i.e. before Reflex regenerates .web/package.json — so the new version sticks across every reflex export / reflex_mount call in that process.

Stay within @react-router/dev's supported peer range (currently ^5.1.0 || ^6.0.0 || ^7.0.0 || ^8.0.0). Vite 6 and 7 still use Rollup; Vite 5 is too old to honour the unstable_optimizeDeps flag @react-router/dev emits and breaks transitive-package resolution at build time.

Event middleware chain¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_RUN_MIDDLEWARE_CHAIN`	`bool`	`True`	Run the full `settings.MIDDLEWARE` chain on every Reflex event.
`REFLEX_DJANGO_EVENT_MIDDLEWARE_SKIP`	`tuple[str, ...]`	`("django.middleware.csrf.CsrfViewMiddleware", "reflex_django.streaming_middleware.AsyncStreamingMiddleware")`	Middleware classes (by import path) to skip on WebSocket events.
`REFLEX_DJANGO_AUTO_REDIRECT_FROM_MIDDLEWARE`	`bool`	`True`	Convert 3xx responses from middleware into `rx.redirect(...)` automatically.
`REFLEX_DJANGO_EVENT_POST_FROM_PAYLOAD`	`bool`	`False`	Feed event handler kwargs into the synthetic `request.POST`.
`REFLEX_DJANGO_ACTIVATE_LANGUAGE_ON_EVENT`	`bool`	`True`	Run `translation.activate(...)` on each event using the bridge's language selection.

Reactive mirrors¶

These control which Django values appear as reactive variables on DjangoUserState (so you can bind them in components).

Setting	Type	Default	Purpose
`REFLEX_DJANGO_MIRROR_MESSAGES`	`bool`	`True`	Mirror `django.contrib.messages` to `DjangoUserState.messages`.
`REFLEX_DJANGO_MIRROR_CSRF`	`bool`	`True`	Mirror the CSRF token to `DjangoUserState.csrf_token`.
`REFLEX_DJANGO_MIRROR_LANGUAGE`	`bool`	`True`	Mirror language to `DjangoUserState.language` and `language_bidi`.
`REFLEX_DJANGO_AUTH_AUTO_SYNC`	`bool`	`True`	Refresh `AppState` user snapshot fields (`is_authenticated`, `username`, …) on every event.

Page discovery¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_AUTO_DISCOVER_PAGES`	`bool`	`True`	Walk `INSTALLED_APPS` and import `{app}.views` for `@template`/`@page` decorators.
`REFLEX_DJANGO_PAGE_PACKAGES`	`list[str]`	`[]`	Explicit list of page modules. When non-empty, disables auto-discovery.
`REFLEX_DJANGO_PAGE_APPS`	`list[str] \\| None`	`None`	Allowlist of app labels for auto-discovery. `None` = scan all.
`REFLEX_DJANGO_PAGE_MODULE`	`str`	`"views"`	Which submodule to import per app.

Context processors¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_AUTO_LOAD_CONTEXT`	`bool`	`True`	Run context processors on every Reflex event.
`REFLEX_DJANGO_CONTEXT_PROCESSORS`	`tuple[str, ...]`	`()`	Dotted paths of `f(request) -> dict` callables.
`REFLEX_DJANGO_USE_TEMPLATE_CONTEXT_PROCESSORS`	`bool`	`True`	If `REFLEX_DJANGO_CONTEXT_PROCESSORS` is empty, fall back to Django's template context processors.

Plugin and rxconfig¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_USE_RXCONFIG_FILE`	`bool`	`False`	Merge an existing on-disk `rxconfig.py` into the runtime config.
`REFLEX_DJANGO_MATERIALIZE_RXCONFIG`	`bool`	`False`	Write a stub `rxconfig.py` to disk for tooling compatibility.
`REFLEX_DJANGO_PLUGIN`	`dict`	`{}`	Extra kwargs for the built-in `ReflexDjangoPlugin`.
`REFLEX_DJANGO_AUTO_PLUGIN`	`bool`	`True`	Always-on. Kept for backwards compatibility.

Auth¶

Setting	Type	Default	Purpose
`REFLEX_DJANGO_LOGIN_URL`	`str`	`"/login"`	Where `@login_required` / `@permission_required` redirect to.
`REFLEX_DJANGO_AUTH`	`dict`	see Login & sessions	Configuration for the built-in auth pages (URLs, titles, password rules, …).

Default skip list, in full¶

The built-in default value of REFLEX_DJANGO_EVENT_MIDDLEWARE_SKIP:

(
    "django.middleware.csrf.CsrfViewMiddleware",
    "reflex_django.streaming_middleware.AsyncStreamingMiddleware",
)

When you set the setting yourself, your value replaces the default. To extend rather than replace:

from reflex_django.config import DEFAULT_EVENT_MIDDLEWARE_SKIP

REFLEX_DJANGO_EVENT_MIDDLEWARE_SKIP = (
    *DEFAULT_EVENT_MIDDLEWARE_SKIP,
    "myapp.middleware.SomethingYouDontWantOnEvents",
)

Reading order for new projects¶

If you're scanning for the first time:

Most projects need zero of these. The defaults are good.
The first ones you'll touch are usually REFLEX_DJANGO_AUTH (built-in login pages) and REFLEX_DJANGO_CONTEXT_PROCESSORS (feature flags / site info).
Performance tuning: REFLEX_DJANGO_EVENT_MIDDLEWARE_SKIP, then REFLEX_DJANGO_RUN_MIDDLEWARE_CHAIN.
Page layout: REFLEX_DJANGO_PAGE_PACKAGES if you want pages outside INSTALLED_APPS.

Next: Public API at a glance →

REFLEX_DJANGO_* settings¶