Wagtail is an open source content management system built on Django
 
 
 
 
 
Go to file
Coen van der Kamp 8052c93795 Add svg icon mixin 2020-06-15 14:34:29 +01:00
.circleci Replace gulp-sass with gulp-dart-sass 2020-05-17 21:00:20 +10:00
.github Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
.tx Fetch new translations and update config for Chinese (#3668) 2019-04-08 22:27:18 +01:00
client Add svg icon mixin 2020-06-15 14:34:29 +01:00
docs Fix minor typo in 2.10 changelog (#6140) 2020-06-12 09:30:39 +01:00
etc Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
gulpfile.js Update npm dependencies with `npm audit fix` 2020-06-04 07:02:43 +10:00
scripts Update translator credits 2020-04-21 14:58:33 +01:00
wagtail WebP images quality/lossless compression parameters (#6040) 2020-06-09 09:29:48 +01:00
.coveragerc Update Python and JS test coverage collection to exclude tests 2020-05-27 09:11:26 +01:00
.editorconfig Fix whitespace errors in docs 2016-11-28 13:41:35 +00:00
.eslintignore Remove unused React component generator 2018-10-10 14:02:29 +01:00
.eslintrc Fix Redux DevTools deprecation warning (#5231). Fix #5214 2019-04-23 15:02:53 +01:00
.gitignore Add panel configuration checks (#5093) 2019-02-21 13:36:31 +01:00
.nvmrc Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +10:00
.readthedocs.yml Drop support for Python 3.5 2020-04-24 14:58:55 +01:00
.squash.yml Upgrade to Gulp v4 & Node 10 2020-05-01 12:01:03 +10:00
.stylelintrc.yaml Remove explicit stylelint-scss requirement & upgrade config pkg to v0.1.0 2019-05-20 16:42:35 +01:00
.travis.yml Drop support for Python 3.5 2020-04-24 14:58:55 +01:00
CHANGELOG.txt Fix minor typo in 2.10 changelog (#6140) 2020-06-12 09:30:39 +01:00
CODE_OF_CONDUCT.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
CONTRIBUTORS.rst Change contributor name for mozgsml to Nikolay Lukyanov 2020-06-09 11:04: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 Configure jinjalint to enforce errors, while filtering-out false positives 2019-05-10 14:37:11 +01:00
README.md Drop support for Python 3.5 2020-04-24 14:58:55 +01:00
SECURITY.md Add SECURITY.md (#5536) 2019-09-03 10:11:05 +01:00
SPONSORS.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
appveyor.yml Remove unsupported environments from appveyor config 2017-10-13 12:27:09 +01:00
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 Update npm dependencies with `npm audit fix` 2020-06-04 07:02:43 +10:00
package.json Update npm dependencies with `npm audit fix` 2020-06-04 07:02:43 +10:00
runtests.py Implements ES7 support (#5611) 2019-10-10 11:00:14 +01:00
setup.cfg Unbundle the l18n library 2019-10-30 08:03:41 +10:00
setup.py WebP images quality/lossless compression parameters (#6040) 2020-06-09 09:29:48 +01:00
tox.ini Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00: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 2.2.x and 3.0.x
  • Python 3.6, 3.7 and 3.8
  • PostgreSQL, MySQL and SQLite as database backends

Previous versions of Wagtail additionally supported Python 2.7 and Django 1.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 master 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 Coverage Total alerts Language grade: Python Language grade: JavaScript Slack