From ff16cb5a3e0065a7da1824628eae64cd100ff312 Mon Sep 17 00:00:00 2001 From: Shreshth Srivastava <134348598+Shreshth-Srivastava@users.noreply.github.com> Date: Sun, 6 Aug 2023 15:27:00 +0530 Subject: [PATCH] Mention WAGTAILADMIN_BASE_URL in integrating_into_django.md (#10758) Fixes #10741 Mentioned WAGTAILADMIN_BASE_URL and the warnings related to it in the 'Settings' section. --- docs/getting_started/integrating_into_django.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting_started/integrating_into_django.md b/docs/getting_started/integrating_into_django.md index 3f8a4b6897..35888a60c1 100644 --- a/docs/getting_started/integrating_into_django.md +++ b/docs/getting_started/integrating_into_django.md @@ -56,6 +56,14 @@ Add a `WAGTAIL_SITE_NAME` - this will be displayed on the main dashboard of the WAGTAIL_SITE_NAME = 'My Example Site' ``` +Add a `WAGTAILADMIN_BASE_URL` - this is the base URL used by the Wagtail admin site. It is typically used for generating URLs to include in notification emails: + +```python +WAGTAILADMIN_BASE_URL = 'http://example.com' +``` + +If this setting is not present, Wagtail will fall back to `request.site.root_url` or to the hostname of the request. Although this setting is not strictly required, it is highly recommended because leaving it out may produce unusable URLs in notification emails. + Various other settings are available to configure Wagtail's behaviour - see [Settings](/reference/settings). ## URL configuration