Wagtail demo project

This is a demonstration project for Wagtail CMS.

We do not recommend using this project to start your own site. This project is only to provide some examples of implementing common features, it is not an exemplar of Django or Wagtail best practice.

If you're reasonably new to Python/Django, we suggest you run this project on a Virtual Machine using Vagrant, which helps resolve common software dependency issues. However for more experienced developers, instructions to start this project without Vagrant follow below.

Once you're familiar with the examples in this project and you want to start a real site, we strongly recommend running the wagtail start command in a fresh virtual environment, explained in the Wagtail CMS Documentation.

Setup with Vagrant

Dependencies

• VirtualBox
• Vagrant 1.5+

Installation

Run the following commands:

git clone git@github.com:wagtail/bakerydemo.git
cd bakerydemo
vagrant up
vagrant ssh
# then, within the SSH session:
./manage.py runserver 0.0.0.0:8000

The demo site will now be accessible at http://localhost:8000/ and the Wagtail admin interface at http://localhost:8000/admin/.

Log into the admin with the credentials admin / changeme.

Setup with Docker

Dependencies

• Docker

Installation

Run the following commands:

git clone git@github.com:wagtail/bakerydemo.git
cd bakerydemo
docker-compose up --build -d
docker-compose run app /venv/bin/python manage.py load_initial_data

The demo site will now be accessible at http://localhost:8000/ and the Wagtail admin interface at http://localhost:8000/admin/.

Log into the admin with the credentials admin / changeme.

Important: This docker-compose.yml is configured for local testing only, and is not intended for production use.

Debugging

To tail the logs from the Docker containers in realtime, run:

docker-compose logs -f

Local Setup

Don't want to set up a whole VM nor use Docker to try out Wagtail? No problem.

Dependencies

• PIP

Installation

With PIP installed run the following commands:

git clone git@github.com:wagtail/bakerydemo.git
cd wagtaildemo
pip install -r requirements.txt

Next, we'll set up our local environment variables. We use django-dotenv to help with this. It reads environment variables located in a file name .env in the top level directory of the project. The only variable we need to start is DJANGO_SETTINGS_MODULE:

$ cp bakerydemo/settings/local.py.example bakerydemo/settings/local.py
$ echo "DJANGO_SETTINGS_MODULE=bakerydemo.settings.local" > .env

Execute the following commands:

./manage.py migrate
./manage.py load_initial_data
./manage.py runserver

Log into the admin with the credentials admin / changeme.

Note on demo search:

Because we can't (easily) use ElasticSearch for this demo, we use wagtail's native DB search. However, native DB search can't search specific fields in our models on a generalized Page query. So for demo purposes ONLY, we hard-code the model names we want to search into search.views, which is not ideal. In production, use ElasticSearch and a simplified search query, per http://docs.wagtail.io/en/v1.8.1/topics/search/searching.html.

Heroku deployment:

If you need to deploy your demo site to a publicly accessible server Heroku provides a one-click deployment solution:

If you do not have a Heroku account, clicking the above button will walk you through the steps to generate one. After which, you will be presented with a screen to configure your app. For our purposes, we will accept all of the defaults and click Deploy. The status of the deployment will dynamically update in the browser. Once finished, click View to see the public site.

Log into the admin with the credentials admin / changeme.

To prevent the demo site from regenerating a new Django SECRET_KEY each time Heroku restarts your site, you should set a DJANGO_SECRET_KEY environment variable in Heroku using the web interace or the CLI. If using the CLI, you can set a SECRET_KEY like so:

heroku config:set DJANGO_SECRET_KEY=changeme

To learn more about Heroku, read Deploying Python and Django Apps on Heroku.

Storing Wagtail Media Files on AWS S3

If you have deployed the demo site to Heroku or via Docker, you may want to perform some additional setup. Heroku uses an ephemeral filesystem, and Docker-based hosting environments typically work in the same manner. In laymen's terms, this means that uploaded images will disappear at a minimum of once per day, and on each application deployment. To mitigate this, you can host your media on S3.

This documentation assumes that you have an AWS account, an IAM user, and a properly configured S3 bucket. These topics are outside of the scope of this documentation; the following blog post will walk you through those steps.

This demo site comes preconfigured with a production settings file that will enable S3 for uploaded media storage if AWS_STORAGE_BUCKET_NAME is defined in the shell environment. All you need to do is set the following environment variables. If using Heroku, you will first need to install and configure the Heroku CLI. Then, execute the following commands to set the aforementioned environment variables:

heroku config:set AWS_STORAGE_BUCKET_NAME=changeme
heroku config:set AWS_ACCESS_KEY_ID=changeme
heroku config:set AWS_SECRET_ACCESS_KEY=changeme

Do not forget to replace the changeme with the actual values for your AWS account. If you're using a different hosting environment, set the same environment variables there using the method appropriate for your environment.

Once Heroku restarts your application or your Docker container is refreshed, you should have persistent media storage!

Sending email from the contact form

The following setting in base.py and production.py ensures that live email is not sent by the demo contact form.

EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

In production on your own site, you'll need to change this to:

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

and configure SMTP settings appropriate for your email provider.