1. Create a new Wagtail Django project¶
In this section we will create and deploy a new project in the Control Panel using Wagtail, a very popular Django-based content management system framework. The principles covered by the tutorial will apply to any other development stack.
You could equally well create a plain Django project, and install Wagtail in that. However, the Wagtail project type saves some time by setting up a ready-to-go project, with Wagtail automatically installed and configured.
This tutorial assumes some basic familiarity with Wagtail. It is intended to introduce the basics of working with the Aldryn Django framework on Divio, using Wagtail as an example. It is not a tutorial for learning Wagtail (or Django).
We also provide tutorials to get started with Django
Set up a project in the Cloud¶
If you have not already done so, you will need to set up the local development environment.
Create the project¶
In the Divio Control Panel, create a new project.
Any web application in any language can run on Divio, as long as there is nothing that prevents its being Dockerised. For convenience we some ready-to-go project types for applications built in Java, PHP, Node and other languages. Use of these is optional. You can also start with a Build your own project, in which you build your application from a blank sheet.
For this tutorial, select the following options for your project (other options should be left on their default settings):
- Project type:
At the time of writing, the latest default version Aldryn Wagtail addon uses Wagtail 2.9.2 - others are also available.
Divio projects use Git for code management. We provide a Git server that your projects will use by default; you can also choose to use another Git service if you prefer. For this tutorial, use our Git server.
Hit Continue, then select the free Developer plan for this project (the Developer plan is fully-featured and provides all you need to work on an application up to the point of putting it into production).
It takes a few moments to create the project. During this process, the Control Panel defines the basic project files for your application by adding commits to its repository. This could include assembling its Dockerfile and other files, depending on the project type.
Your project has two independent server environments, Test and Live . The Test and Live environments have their own services, and unique environment variables to configure access to them. They can be deployed independently, and can also be configured to track different Git branches.
Deploy the project¶
Once the project has been fully created, use the Deploy button to deploy the Test server.
The deployment process first builds the Docker image from the
Dockerfile, and then launches a Docker container from
the image. The container environment will include automatically-configured environment variables for connections to
services such as the database, media storage and so on.
Typically, this takes a minute or so.
Open the Test environment website¶
Once you have successfully deployed the Test environment, the Control Panel will indicate this in the interface with a
Last deployment successful at … message and the project URL in the Test environment pane will display as a link,
https://tutorial-project-stage.us.aldryn.io. Select the link to access the project.
Since this is your own project, you can use our single-sign-on to log in by selecting Log in with Divio. You’ll see the “Welcome to Wagtail” page.
More interesting are the admin pages:
- the Wagtail admin, at
/admin, shown below
- the Django admin, at
Any time new changes to the project code are committed to its repository, the Control Panel will indicate this with a message showing the number of undeployed commits for each of its server environments.
New code and configuration changes applied via the Control Panel (to subscriptions, cron jobs, environment variable, domains or other settings) will not take effect on either server environment until it is deployed once again.
If for whatever reason a deployment fails, there will be no down-time - the containers that are currently running will continue running, and the failing changes will not be deployed.
Explore the Dashboard¶
The Divio project Dashboard provides you with access to useful controls and information for the project. They are fairly self-explanatory and at this stage you don’t need to interact with any of them, but it’s worth familiarising yourself with what’s available.