Repository files navigation

Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience, and offers precise control for designers and developers.

• A fast, attractive interface for authors
• Complete control over front-end design and structure
• Scales to millions of pages and thousands of editors
• Fast out of the box, cache-friendly when you need it
• Content API for 'headless' sites with decoupled front-end
• Runs on a Raspberry Pi or a multi-datacenter cloud platform
• StreamField encourages flexible content without compromising structure
• Powerful, integrated search, using Elasticsearch or PostgreSQL
• Excellent support for images and embedded content
• Multi-site and multi-language ready
• Embraces and extends Django

Find out more atwagtail.org.

Wagtail works withPython 3, on any platform.

To get started with using Wagtail, run the following in avirtual environment:

pip install wagtailwagtail start mysitecd mysitepip install -r requirements.txtpython manage.py migratepython manage.py createsuperuserpython manage.py runserver

For detailed installation and setup docs, seethe getting started tutorial.

Wagtail is used byNASA,Google,Oxfam, theNHS,Mozilla,MIT, theRed Cross,Salesforce,NBC,BMW, and the US and UK governments. Add your own Wagtail site tomadewithwagtail.org.

docs.wagtail.org is the full reference for Wagtail, and includes guides for developers, designers and editors, alongsiderelease notes and ourroadmap.

For those who arenew to Wagtail, theZen of Wagtail will help you understand what Wagtail is, and what Wagtail isnot.

For developers who are ready to jump in to their first Wagtail website theGetting Started Tutorial will guide you through creating and editing your first page.

Do you have an existing Django project? TheWagtail Integration documentation is the best place to start.

(If you are reading this on GitHub, the details here may not be indicative of the current released version - please seeCompatible Django / Python versions in the Wagtail documentation.)

Wagtail supports:

• Django 4.2.x and 5.1.x
• Python 3.9, 3.10, 3.11, 3.12 and 3.13
• PostgreSQL, MySQL, MariaDB and SQLite (with JSON1) as database backends

Previous versions of Wagtail additionally supported Python 2.7, 3.8 and earlier Django versions.

There is an active community of Wagtail users and developers responding to questions onStack Overflow. When posting questions, please read Stack Overflow's advice onhow to ask questions and remember to tag your question "wagtail".

For topics and discussions that do not fit Stack Overflow's question and answer format we have aSlack workspace. Please respect the time and effort of volunteers by not asking the same question in multiple places.

OurGitHub discussion boards are open for sharing ideas and plans for the Wagtail project.

We maintain a curated list of third party packages, articles and other resources atAwesome Wagtail.

Wagtail is sponsored byTorchbox. If you need help implementing or hosting Wagtail, please contact us:hello@torchbox.com. See alsomadewithwagtail.org/developers/ for expert Wagtail developers around the world.

We take the security of Wagtail, and related packages we maintain, seriously. If you have found a security issue with any of our projects please email us atsecurity@wagtail.org so we can work together to find and patch the issue. We appreciate responsible disclosure with any security related issues, so please contact us first before creating a GitHub issue.

If you want to send an encrypted email (optional), the public key ID forsecurity@wagtail.org is 0xbed227b4daf93ff9, and this public key is available from most commonly-used keyservers.

Feature releases of Wagtail are released every three months. Selected releases are designated as Long Term Support (LTS) releases, and will receive maintenance updates for an extended period to address any security and data-loss related issues. For dates of past and upcoming releases and support periods, seeRelease Schedule.

To try out the latest features before a release, we also create builds frommain every night. You can find instructions on how to install the latest nightly release athttps://releases.wagtail.org/nightly/index.html

If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on theSlack workspace.

You might like to start by reviewing thecontributing guidelines and checking issues with thegood first issue label.

We also welcome translations for Wagtail's interface. Translation work should be submitted throughTransifex.

BSD - Free to use and modify for any purpose, including both open and closed-source code.

We thank the following organisations for their services used in Wagtail's development:

BrowserStack provides the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.

Squash provides the project with free test environments for reviewing pull requests.

Assistiv Labs provides the project with unlimited access to their remote testing with assistive technologies.