Deploy Wagtail sites to Netlify
Deploy your Wagtail site on Netlify. Features include:
- automatic deployment when pages are published
- a new
- conversion of Wagtail redirects to Netlify's format
- Install and configure Wagtail Bakery, if you haven't already.
- Install Netlify CLI v2.x, if you haven't already.
- Install Wagtail-Netlify via pip (with
pip install wagtailnetlify).
- Run the migrations:
./manage.py migrate wagtailnetlify.
NETLIFY_BUILD_HOOKto your settings.
Check the Settings section below for more customisation options.
NETLIFY_AUTO_DEPLOY is set to
True, Wagtail will automatically deploy your site every time a page is published.
To deploy changes manually, use
To generate redirects without deploying, use the
./manage.py netlify --no-deploy.
To trigger a build on Netlify's servers, configure
settings.NETLIFY_BUILD_HOOK and use the
./manage.py netlify --trigger-build.
The path to the Netlify CLI. Hint: type
which netlify to check the location.
If set, deploy to that specific Netlify site.
If not set, the Netlify CLI might prompt you to select one.
If set, the Netlify CLI will not prompt you to click the authentication link in the console. It can be useful when deployed to a remote server where you don't see the console output.
Connect to your Netlify account to generate a token and then set the settings. Warning: You should never check credentials in your version control system. Use environment variables or local settings file instead.
Whether to automatically deploy your site to Netlify every time you publish a page. This make take between a few seconds and a few minutes, depending on the size of your site, and the number of pages which are affected by your change. If you have configured
settings.NETLIFY_BUILD_HOOK, publishing a page will trigger a build on Netlify's servers.
The function to be called when a deploy is triggered (excluding when triggered manually with the
./manage.py netlify command). It can be useful if you want to use your own task runner (like Celery) instead of the built-in threading model.
The function needs to be a valid Django signal receiver.
The URL of a Netlify build hook. If provided,
./manage.py netlify --trigger-build will call this hook, triggering a build
on Netlify's servers. This may be useful if you have a headless front-end on Netlify which handles its own static site generation,
e.g. Nuxt, Next or Gatsby. See https://docs.netlify.com/configure-builds/build-hooks/ for more details.
Optional admin view and endpoints
Netlify can send a webhook after a successful deployment. This app provides an endpoint for that webhook and an admin view of completed deployments. To enable this view:
- Update your project's
# in your imports from wagtailnetlify import urls as netlify_urls # in urlpatterns, before including wagtail_urls url(r"^netlify/", include(netlify_urls)),
- In Netlify's admin interface for your app, add http://yourdomain/netlify/success as a URL to notify for the outgoing webhook on Deploy succeeded events (in Settings / Build & deploy / Deploy notifications).
The view will be available under
Settings / Deployments in your site's admin.
wagtailnetlify URLs will also enable a view at /netlify/redirects, which outputs any Wagtail redirects in Netlify's plain text format. This may be useful if you are using Netlify to host a headless front-end for your Wagtail site.
- Ensure you have the latest versions of
twineinstalled in your virtual environment.
- Ensure your
masterbranch is up to date.
- Create a new branch (e.g.
release/v1.1.3) for the release of the new version.
- Update the version number in
wagtailnetlify/__init__.pyfollowing Semantic Versioning.
- (Optional) If you need to verify anything, use
make publish-testto upload to https://test.pypi.org and enter your PyPi test credentials as needed.
- On GitHub, create a pull request and squash merge it.
- Checkout and pull the
make publishand enter your PyPi credentials as needed.
- On GitHub, create a release and a tag for the new version.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.