Skip to content

Commit 1343995

Browse files
docs(release): document REACT_LOGIN + API_URL_PREFIX in the README config block (v1 polish)
The two settings that landed this release window aren't visible in the README's optional-configuration snippet — add them with one-line inline docs so consumers landing on the PyPI page see the full v1 surface at a glance: - `REACT_LOGIN` — True by default (post-#561); set False to opt back into the legacy admin HTML login. - `API_URL_PREFIX` — None by default; point the SPA at a separately- mounted django-admin-rest-api when the consumer doesn't want the inline include (#559).
1 parent 1372d22 commit 1343995

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,16 @@ DJANGO_ADMIN_REACT = {
141141
# active states. Hex only (validated);
142142
# injected as the --dar-primary CSS var, so
143143
# rebranding needs no React rebuild.
144+
145+
# Auth + API mount
146+
"REACT_LOGIN": True, # bool — React-rendered login is the default;
147+
# the SPA shell is served to anonymous users
148+
# and posts to /api/v1/login/. Set False to
149+
# opt back into the legacy admin HTML login.
150+
"API_URL_PREFIX": None, # str | None — point the SPA at a separately-
151+
# mounted django-admin-rest-api (e.g.
152+
# "/api/api/v1/"). Default None keeps the
153+
# inline include the package ships today.
144154
}
145155
```
146156

0 commit comments

Comments
 (0)