Getting started


These instructions assume familiarity with virtual environments and the Django web framework. For more detailed instructions, see Your first Wagtail site. To add Wagtail to an existing Django project, see Integrating Wagtail into a Django project.

Dependencies needed for installation

Quick install

Run the following commands in a virtual environment of your choice:

pip install wagtail

(Installing wagtail outside a virtual environment may require sudo. sudo is a program to run other programs with the security privileges of another user, by default the superuser)

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.

Inside your mysite folder, run the setup steps necessary for any Django project:

pip install -r requirements.txt
python migrate
python createsuperuser
python 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 Wagtail into a Django project.

There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including:

Common issues

Python is not available in path

> command not found: python

For detailed guidance, see this guide on how to add Python to your path.

python3 not available

python3 -m pip install --upgrade pip
> command not found: python3

If this error occurs, the python3 can be replaced with py.