Wagtail is an open source content management system built on Django
 
 
 
 
 
Go to file
Thibaud Colas 8d10c4688e Update squash user details to be more portable
- Changes the user's email from `@myproject.com` to `@example.com`. myproject.com points to a real website, it feels better to use a domain that's definitely meant as a placeholder.
- Changes the password to `changeme`, matching the credentials used for https://github.com/wagtail/bakerydemo.
2019-06-03 22:06:15 +01:00
.circleci Fix jinjalint error ignores incompatible with bash -o pipefail in CircleCI 2019-05-10 14:37:11 +01:00
.github Ask issue openers to confirm that bugs are reproducible 2018-08-16 16:03:46 +01:00
.tx Fetch new translations and update config for Chinese (#3668) 2019-04-08 22:27:18 +01:00
client Fix focus outline styles for image blocks 2019-05-28 11:53:26 +01:00
docs Release notes for #5317 2019-05-28 11:53:26 +01:00
etc Also fix /media/images/ path 2019-01-10 11:37:32 +00:00
gulpfile.js Rearrange SCSS structure according to ITCSS 2019-04-11 11:08:47 +02:00
scripts Fetch new translations and update config for Chinese (#3668) 2019-04-08 22:27:18 +01:00
wagtail Remove all existing outline overrides in admin UI 2019-05-28 11:53:26 +01:00
.coveragerc Fixed some formatting in 'Customising IndexView' doc. (#4877) 2018-10-30 12:29:11 +00: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 Replace references to Node versions 2017-08-11 15:40:43 +01:00
.readthedocs.yml Move readthedocs.yml to project root 2018-10-11 16:59:57 +01:00
.squash.yml Update squash user details to be more portable 2019-06-03 22:06:15 +01: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 Remove support for Python 3.4 2019-04-10 17:39:53 +01:00
CHANGELOG.txt Release notes for #5317 2019-05-28 11:53:26 +01:00
CODE_OF_CONDUCT.md Add Contributor Covenant 2016-02-03 15:47:50 +00:00
CONTRIBUTORS.rst Update changelog/contributors & release notes with recent contributions 2019-05-23 16:58:19 +10:00
LICENSE Make license perpetual 2017-10-27 09:55:03 +01: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 Add security key into readme (#5223) 2019-04-12 15:23:25 +01: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 Remove explicit stylelint-scss requirement & upgrade config pkg to v0.1.0 2019-05-20 16:42:35 +01:00
package.json Remove explicit stylelint-scss requirement & upgrade config pkg to v0.1.0 2019-05-20 16:42:35 +01:00
runtests.py Add rudimentary benchmarking code and a couple of benchmarks 2018-06-11 17:49:31 +01:00
setup.cfg Fix linting failures for flake8 3.6 2018-10-25 18:03:29 +01:00
setup.py Relax pillow version restriction 2019-05-01 12:46:28 +01:00
tox.ini Remove support for Python 3.4 2019-04-10 17:39:53 +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

Wagtail supports:

  • Django 2.0.x, 2.1.x and 2.2.x
  • Python 3.5, 3.6 and 3.7
  • PostgreSQL, MySQL and SQLite as database backends

Previous versions of Wagtail (1.13 and earlier) 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.

Contributing

If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).

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.

Thanks

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

Browserstack

Build Status License Version Coverage Slack