Wagtail is an open source content management system built on Django
 
 
 
 
 
Go to file
Vlad Podgurschi f54e7e1e41 Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
.circleci Build front-end assets on CircleCI 2021-06-21 14:34:40 +01:00
.github Change CodeQL analysis on cron only (#7229) 2021-06-01 10:53:47 +01:00
.tx Add translations for simple_translation app 2021-04-21 09:36:33 +01:00
client Prevent comments CSS from overriding custom colours 2021-07-02 12:06:07 +01:00
docs Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
etc Release note / additional fix for #6339 2020-10-05 14:25:33 +01:00
gulpfile.js Implement CSS variables for admin color theming (#6409) 2021-01-17 02:17:41 +00:00
scripts Drop travis entirely 2020-11-05 12:04:12 +00:00
wagtail Preserve `features` & `editor` kwargs on RichTextField.clone() (#7272) 2021-07-06 17:20:12 +01:00
.coveragerc Update Python and JS test coverage collection to exclude tests 2020-05-27 09:11:26 +01:00
.editorconfig Fix documentation indentation 2021-02-26 09:17:00 +00:00
.eslintignore Remove unused React component generator 2018-10-10 14:02:29 +01:00
.eslintrc Use TypeScript configuration for all JS linting (#6862) 2021-03-05 16:54:11 +00:00
.gitignore Installed storybook 2021-05-03 17:05:56 +01:00
.nvmrc Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +10:00
.pre-commit-config.yaml Add pre-commit support 2020-10-16 18:56:39 +01:00
.readthedocs.yml Drop support for Python 3.5 2020-04-24 14:58:55 +01:00
.squash.yml Optimise npm install in squash for speed & logs visibility (#6158) 2020-06-25 16:03:42 +01:00
.stylelintrc.yaml Ignore venv from stylelint 2021-03-31 20:50:26 +01:00
CHANGELOG.txt Add instructions on copying and aliasing pages to the editor's guide #7010 2021-07-06 20:44:10 +01:00
CODE_OF_CONDUCT.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
CONTRIBUTORS.rst Add missing block.super in extra_css/extra_js blocks (#7310) 2021-07-05 17:28:13 +01:00
LICENSE Makes LICENSE recognized by GitHub. 2019-06-05 15:18:50 +02:00
MANIFEST.in README rewrite (#4372) 2018-06-28 17:27:55 +01:00
Makefile Update Makefile (#7067) 2021-06-18 13:19:41 +01:00
README.md Remove redundant badges from readme 2021-05-14 16:18:22 +01:00
SECURITY.md Add SECURITY.md (#5536) 2019-09-03 10:11:05 +01:00
SPONSORS.md Update sponsors list with recent contributions (#7167) 2021-05-17 10:09:08 +01:00
appveyor.yml
codecov.yml Disable codecov coverage checks on PRs 2019-01-30 10:49:51 +00:00
conftest.py Use LocaleMiddleware's language as fallback language for user profiles w/o prefferred language 2018-11-22 11:11:56 +00:00
package-lock.json Bump hosted-git-info from 2.8.8 to 2.8.9 2021-05-17 14:40:33 +01:00
package.json Update ts-loader to 9.1.1 2021-05-04 14:48:56 +01:00
runtests.py Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
setup.cfg Ignore venv during in isort 2021-02-23 10:14:01 +00:00
setup.py Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02:00
tox.ini Drop support for Django 2.2 2021-04-30 10:33:41 +01:00
tsconfig.json Merge Wagtail Comment Frontend (#6953) 2021-04-20 18:25:30 +01:00

README.md

Wagtail

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.

Wagtail screenshot

Features

  • 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 de-coupled 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 at wagtail.io.

Getting started

Wagtail works with Python 3, on any platform.

To get started with Wagtail, run the following in a virtual environment:

pip install wagtail
wagtail start mysite
cd mysite
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

For detailed installation and setup docs, see docs.wagtail.io.

Whos using it?

Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to madewithwagtail.org.

Documentation

docs.wagtail.io is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.

Compatibility

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

Wagtail supports:

  • Django 3.0.x, 3.1.x and 3.2.x
  • Python 3.6, 3.7, 3.8 and 3.9
  • PostgreSQL, MySQL and SQLite as database backends

Previous versions of Wagtail additionally supported Python 2.7 and Django 1.x - 2.x.


Community Support

There is an active community of Wagtail users and developers responding to questions on Stack Overflow. When posting questions, please read Stack Overflow's advice on how 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 a Slack workspace and a Wagtail Support mailing list. Please respect the time and effort of volunteers by not asking the same question in multiple places.

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

Commercial Support

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

Security

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 at security@wagtail.io 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 for security@wagtail.io is 0x6ba1e1a86e0f8ce8, and this public key is available from most commonly-used keyservers.

Release schedule

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, see Release Schedule.

Nightly releases

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

Contributing

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

You might like to start by reviewing the contributing guidelines and checking issues with the good first issue label.

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

License

BSD

Thanks

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

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

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

Build Status License Version Total alerts Language grade: Python Language grade: JavaScript