A Wagtail app to check the configuration of Wagtail Sites.
Project description
Wagtail Site Check
A Wagtail app to check the configuration of Wagtail Sites.
Common issues with misconfigured Wagtail Sites are:
- Failing Wagtail preview.
- Live button pointing to wrong site.
- On multi-language sites wrong active language and/or wrong content displayed.
When a Wagtail Site is misconfigured, developers like to be notified. This way, the issue can be addressed quickly. To scratch the itch, I created "Wagtail Site Check".
Wagtail Site Check provides:
- A management command to check for misconfigured sites.
- A management command to fix misconfigured sites.
- A notification panel to show a misconfigured site warning on the Wagtail admin dashboard.
Installation
Install the package with pip:
python -m pip install wagtail-site-check
Add the app to your INSTALLED_APPS
:
INSTALLED_APPS = [
'wagtailsitecheck',
]
Wagtail Site Check uses ALLOWED_HOSTS
and port 443
to create the list of allowed sites.
Optional: add ALLOWED_WAGTAIL_SITES
to your settings to be specific:
ALLOWED_WAGTAIL_SITES = [
"a.com:443",
"b.com:443",
"c.com:443",
]
When managing multiple environments (DTAP), only list approved Wagtail sites for each environment, typically through environment variables.
Usage
The app provides two management commands: checksites
and fixsites
.
It also provides a SiteCheckNotificationPanel
to add a warning to the Wagtail admin dashboard.
Check Sites
The checksites
management command fails hard if an existing Wagtail Site object is not defined in ALLOWED_WAGTAIL_SITES
.
python manage.py checksites
Run this command manually, or add it to your CI/CD pipeline. For example, just after migrate
.
Fix Sites
The fixsites
management command helps to re-configure the sites.
python manage.py fixsites
127.0.0.1:8000 is not in ALLOWED_WAGTAIL_SITES. Specify a number to update the site.
1: a.com:443
2: b.com:443
3: c.com:443
1
Updated 127.0.0.1:8000 -> a.com:443
SiteCheckNotificationPanel
To show a warning on the Wagtail admin dashboard add SiteCheckNotificationPanel
to wagtail_hooks.py
. The warning is only displayed if there are misconfigured sites.
from wagtail import hooks
from wagtailsitecheck.wagtail_hooks import SiteCheckNotificationPanel
@hooks.register('construct_homepage_panels')
def add_site_check_panel(request, panels):
panels.append(SiteCheckNotificationPanel())
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtail_site_check-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18ffe10d5f54533eb04dc2175980520ea7da8b1e485e5f689b00b2e9f147ecb0 |
|
MD5 | 5f4b8e6e3553ee987e45902c169a745b |
|
BLAKE2b-256 | 0c27c602a628e30a5c07dc96b6c51879a75c72cdee0bb2ce629c363a3bf7559b |