Deploy your Wagtail site on Netlify. Features include:
netlify
management commandpip install wagtailnetlify
).wagtailnetlify
to your INSTALLED_APPS
../manage.py migrate wagtailnetlify
.NETLIFY_PATH
or NETLIFY_BUILD_HOOK
to your settings.Check the Settings section below for more customisation options.
If NETLIFY_AUTO_DEPLOY
is set to True
, Wagtail will automatically deploy your site every time a page is published.
or
To deploy changes manually, use ./manage.py netlify
.
To generate redirects without deploying, use the -n
or --no-deploy
flag: ./manage.py netlify --no-deploy
.
To trigger a build on Netlify's servers, configure settings.NETLIFY_BUILD_HOOK
and use the -t
or --trigger-build
flag: ./manage.py netlify --trigger-build
.
NETLIFY_PATH
The path to the Netlify CLI. Hint: type which netlify
to check the location.
NETLIFY_SITE_ID
Default: None
If set, deploy to that specific Netlify site.
If not set, the Netlify CLI might prompt you to select one.
NETLIFY_API_TOKEN
Default: None
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.
NETLIFY_AUTO_DEPLOY
Default: False
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.
NETLIFY_DEPLOY_FUNCTION
Default: wagtailnetlify.models.deploy
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.
NETLIFY_BUILD_HOOK
Default: None
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.
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:
wagtail.contrib.modeladmin
to your INSTALLED_APPS
urls.py
:# in your imports
from wagtailnetlify import urls as netlify_urls
# in urlpatterns, before including wagtail_urls
url(r"^netlify/", include(netlify_urls)),
The view will be available under Settings / Deployments
in your site's admin.
Including the 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.
pip
, setuptools
and twine
installed in your virtual environment.master
branch is up to date.release/v1.1.3
) for the release of the new version.wagtailnetlify/__init__.py
following Semantic Versioning.CHANGELOG.md
.make publish-test
to upload to https://test.pypi.org and enter your PyPi test credentials as needed.master
branch locally.make publish
and enter your PyPi credentials as needed.