2022-03-09 12:48:19 +01:00
```{eval-rst}
2021-04-20 11:24:17 +02:00
:hidetoc: 1
```
2021-02-26 09:44:40 +01:00
# Getting started
2014-09-11 17:01:22 +02:00
2022-03-09 12:48:19 +01:00
```{note}
2021-02-26 10:00:08 +01:00
These instructions assume familiarity with virtual environments and the
2022-03-09 12:48:19 +01:00
[Django web framework ](https://www.djangoproject.com/ ).
For more detailed instructions, see [](tutorial).
To add Wagtail to an existing Django project, see [](integrating_into_django).
2021-02-26 10:00:08 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
## Dependencies needed for installation
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
- [Python 3 ](https://www.python.org/downloads/ )
2022-10-21 01:31:18 +02:00
- **libjpeg** and **zlib** , libraries required for Django's **Pillow** library.
See Pillow's [platform-specific installation instructions ](https://pillow.readthedocs.io/en/stable/installation.html#external-libraries ).
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
## Quick install
2018-10-27 10:20:55 +02:00
2022-10-11 01:30:15 +02:00
Run the following commands in a virtual environment of your choice:
2018-10-27 10:20:55 +02:00
2021-02-26 10:01:23 +01:00
```sh
2022-10-13 08:25:19 +02:00
pip install wagtail
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
2022-10-11 01:30:15 +02:00
(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)
2016-11-28 02:30:44 +01:00
2022-10-21 01:31:18 +02:00
Once installed, Wagtail provides a command similar to Django's `django-admin startproject` to generate a new site/project:
2015-05-28 11:12:48 +02:00
2021-02-26 10:01:23 +01:00
```sh
2022-10-13 08:25:19 +02:00
wagtail start mysite
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
This will create a new folder `mysite` , based on a template containing everything you need to get started.
2019-04-09 15:55:30 +02:00
More information on that template is available in
2021-02-26 10:06:11 +01:00
[the project template reference ](/reference/project_template ).
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
Inside your `mysite` folder, run the setup steps necessary for any Django project:
2016-11-28 02:30:44 +01:00
2021-02-26 10:01:23 +01:00
```sh
2022-10-13 08:25:19 +02:00
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
2021-02-26 09:44:40 +01:00
```
2015-05-28 11:12:48 +02:00
2021-02-26 09:44:40 +01:00
Your site is now accessible at `http://localhost:8000` , with the admin backend available at `http://localhost:8000/admin/` .
2015-05-28 11:12:48 +02:00
2019-04-09 15:55:30 +02:00
This will set you up with a new stand-alone Wagtail project.
2022-10-21 01:31:18 +02:00
If you'd like to add Wagtail to an existing Django project instead, see [Integrating Wagtail into a Django project ](/getting_started/integrating_into_django ).
2015-05-28 11:12:48 +02:00
There are a few optional packages which are not installed by default but are recommended to improve performance or add features to Wagtail, including:
2022-10-22 14:17:03 +02:00
- [Elasticsearch ](/advanced_topics/performance )
- [Feature Detection ](image_feature_detection )
2022-03-09 12:48:19 +01:00
```{toctree}
---
maxdepth: 1
---
tutorial
demo_site
integrating_into_django
the_zen_of_wagtail
2021-02-26 10:08:12 +01:00
```