README.md
1<h1 align="center">
2 <img width="343" src="https://cdn.jsdelivr.net/gh/wagtail/wagtail@main/.github/wagtail.svg" alt="Wagtail">
3 <br>
4 <br>
5</h1>
6
7Wagtail 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.
8
9
10
11### Features
12
13* A fast, attractive interface for authors
14* Complete control over front-end design and structure
15* Scales to millions of pages and thousands of editors
16* Fast out of the box, cache-friendly when you need it
17* Content API for 'headless' sites with de-coupled front-end
18* Runs on a Raspberry Pi or a multi-datacenter cloud platform
19* StreamField encourages flexible content without compromising structure
20* Powerful, integrated search, using Elasticsearch or PostgreSQL
21* Excellent support for images and embedded content
22* Multi-site and multi-language ready
23* Embraces and extends Django
24
25Find out more at [wagtail.io](https://wagtail.io/).
26
27### Getting started
28
29Wagtail works with [Python 3](https://www.python.org/downloads/), on any platform.
30
31To get started with Wagtail, run the following in a virtual environment:
32
33``` bash
34pip install wagtail
35wagtail start mysite
36cd mysite
37pip install -r requirements.txt
38python manage.py migrate
39python manage.py createsuperuser
40python manage.py runserver
41```
42
43For detailed installation and setup docs, see [docs.wagtail.io](https://docs.wagtail.io/).
44
45### Who’s using it?
46
47Wagtail 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](https://madewithwagtail.org).
48
49### Documentation
50
51[docs.wagtail.io](https://docs.wagtail.io/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
52
53### Compatibility
54
55_(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](https://docs.wagtail.io/en/stable/releases/upgrading.html#compatible-django-python-versions) in the Wagtail documentation.)_
56
57Wagtail supports:
58
59* Django 3.0.x, 3.1.x and 3.2.x
60* Python 3.6, 3.7, 3.8 and 3.9
61* PostgreSQL, MySQL and SQLite as database backends
62
63[Previous versions of Wagtail](https://docs.wagtail.io/en/stable/releases/upgrading.html#compatible-django-python-versions) additionally supported Python 2.7 and Django 1.x - 2.x.
64
65---
66
67### Community Support
68
69There is an active community of Wagtail users and developers responding to questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail). When posting questions, please read Stack Overflow's advice on [how to ask questions](https://stackoverflow.com/help/how-to-ask) and remember to tag your question "wagtail".
70
71For topics and discussions that do not fit Stack Overflow's question and answer format, we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack) and a [Wagtail Support mailing list](https://groups.google.com/forum/#!forum/wagtail). Please respect the time and effort of volunteers by not asking the same question in multiple places.
72
73We maintain a curated list of third party packages, articles and other resources at [Awesome Wagtail](https://github.com/springload/awesome-wagtail).
74
75### Commercial Support
76
77Wagtail is sponsored by [Torchbox](https://torchbox.com/). If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also [madewithwagtail.org/developers/](https://madewithwagtail.org/developers/) for expert Wagtail developers around the world.
78
79### Security
80
81We 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](mailto: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.
82
83If 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.
84
85### Release schedule
86
87Feature 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](https://github.com/wagtail/wagtail/wiki/Release-schedule).
88
89#### Nightly releases
90
91To 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
92
93### Contributing
94
95If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on the [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack).
96
97You might like to start by reviewing the [contributing guidelines](https://docs.wagtail.io/en/latest/contributing/index.html) and checking issues with the [good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label.
98
99We also welcome translations for Wagtail's interface. Translation work should be submitted through [Transifex](https://www.transifex.com/projects/p/wagtail/).
100
101### License
102[BSD](https://github.com/wagtail/wagtail/blob/main/LICENSE)
103
104### Thanks
105
106We thank the following organisations for their services used in Wagtail's development:
107
108[](https://www.browserstack.com/)<br>
109[BrowserStack](https://www.browserstack.com/) provides the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
110
111[](https://www.squash.io/)<br>
112[Squash](https://www.squash.io/) provides the project with free test environments for reviewing pull requests.
113
114
115[](https://github.com/wagtail/wagtail/actions)
116[](https://opensource.org/licenses/BSD-3-Clause)
117[](https://pypi.python.org/pypi/wagtail/)
118[](https://lgtm.com/projects/g/wagtail/wagtail/alerts/)
119[](https://lgtm.com/projects/g/wagtail/wagtail/context:python)
120[](https://lgtm.com/projects/g/wagtail/wagtail/context:javascript)
121
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}