Note
These instructions assume familiarity with virtual environments and the Django web framework. For more detailed instructions, see tutorial
. To add Wagtail to an existing Django project, see integrating_into_django
.
- Python 3
- libjpeg and zlib, libraries required for Django's Pillow library. See Pillow's platform-specific installation instructions.
Run the following in a virtual environment of your choice:
$ pip install wagtail
(Installing outside a virtual environment may require sudo
.)
Once installed, Wagtail provides a command similar to Django's django-admin startproject
to generate a new site/project:
$ wagtail start mysite
This will create a new folder mysite
, based on a template containing everything you need to get started. More information on that template is available in the project template reference </reference/project_template>
.
Inside your mysite
folder, run the setup steps necessary for any Django project:
$ pip install -r requirements.txt
$ ./manage.py migrate
$ ./manage.py createsuperuser
$ ./manage.py runserver
Your site is now accessible at http://localhost:8000
, with the admin backend available at http://localhost:8000/admin/
.
This will set you up with a new stand-alone Wagtail project. If you'd like to add Wagtail to an existing Django project instead, see integrating_into_django
.
There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including:
Elasticsearch </advanced_topics/performance>
.image_feature_detection
.
tutorial demo_site integrating_into_django the_zen_of_wagtail