Divio ❤️ Wagtail

Getting started with Wagtail

Wagtail is an open-source content management system (CMS) that's built on Django, a popular Python web framework. It has gained popularity among developers and content editors for its powerful features and intuitive interface, providing a streamlined editing experience. You can read more about Wagtail from the official website.

This quickstart guide is designed to be straightforward and easy to follow. It will guide you through the process of setting up a Wagtail application on the Divio Cloud Platform. We'll provide the necessary tools, walk you through the application setup, and explain how to deploy it. While we won't delve into in-depth Wagtail development concepts, our focus is to get your Wagtail app up and running on our platform.

To work with Wagtail and deploy it to the Divio Cloud Platform, you need the following tools:

Git

Install the git version control system to manage your code.
Download Git

Docker

Install Docker, a platform to develop, ship, and run applications.
Download Docker

Divio CLI

Install the command-line tool to interact with the Divio Cloud Platform.
Install Divio CLI

Setting up the app

Setting up a Wagtail app

Setting up a Wagtail app on the Divio Cloud Platform is a breeze. Regardless of the language, any web application can run on our platform, provided it can be Dockerised. We've made it even easier with our ready-to-go quickstart templates for most languages & frameworks. If you prefer, you can also migrate an existing application or start from scratch and integrate the Divio Cloud Platform later.

Start by creating a free account on the Divio Cloud Platform and choose from any of the following options depending on your requirements:

Using our Wagtail template

We will guide you through setting up a new application using our ready-to-go Wagtail template. The template pre-configures the necessary services and settings so you can get started quickly on the Divio Cloud Platform without fuss.

1

Head over to the Divio Control Panel and choose to create a new application from the left toolbar. Next, select I want to start from scratch and click on the Wagtail box from the list of available templates. Hit Next to continue.

2

Choose where to store your code: Divio's Git server (default) or an external Git provider. Migrating to an external Git server later is also possible. Refer to our guide on importing a repository from Git for details.

• Divio: we provide a Git server to you through git@git.divio.com:myapp.git.
• External: use your own Git server or a third-party provider like Github, Gitlab, or Bitbucket.

The default branch that we and most Git providers use is main. You may change the branch name if you have a different setup.

Once you've made your choice, click Next to proceed.

3

Proceed by giving your application a unique Name and Slug. We will start with a Free Trial plan for this guide, but you can always upgrade to a paid plan later. Before moving on, there are some options you need to consider:

• Cloudspace: The region you choose depends on your subscription plan. You can always change this later. Updating the cloud space will require a migration that causes downtime.
• Resources: The free trial does not allow you to modify resources. Paid subscriptions allow you to modify memory, instances, storage, backups, the number of domains, and more.
• Features: Not all features are available to all plans. Compare our plans to see what is available depending on your choice.

Add a Payment method and your Billing information to proceed. Rest assured, we need this information to verify your identity and prevent fraud. You will not be charged during the trial period, ensuring your peace of mind.

Click Create application to finish the setup process.

4

Our platform will now take a few moments to provision the application. This means our system is making a copy of the files for your application by adding commits to the repository. It's a simple and quick process.

Migrate an existing Wagtail app

You already have a Wagtail app and would like to prepare it for deployment on the Divio Cloud Platform. To get your Wagtail app ready for deployment, you need to create a Dockerfile. This file will contain instructions on how to build your app.

1

Create a Dockerfile in the root of your application. Here is an example of a Dockerfile for a Wagtail app:

Dockerfile

FROM python:3.8.1-slim-buster

RUN useradd wagtail

EXPOSE 80

ENV PYTHONUNBUFFERED=1   PORT=80

RUN apt-get update --yes --quiet && apt-get install --yes --quiet --no-install-recommends   build-essential   libpq-dev   libmariadbclient-dev   libjpeg62-turbo-dev   zlib1g-dev   libwebp-dev && rm -rf /var/lib/apt/lists/*

RUN pip install "gunicorn==20.0.4"

COPY requirements.txt /
RUN pip install -r /requirements.txt

WORKDIR /app

RUN chown wagtail:wagtail /app

COPY --chown=wagtail:wagtail . .

USER wagtail

RUN python manage.py collectstatic --noinput --clear

CMD set -xe; python manage.py migrate --noinput; gunicorn mysite.wsgi:application

For a comprehensive understanding of how the Dockerfile works and its role in preparing your Wagtail app for deployment, we recommend referring to our detailed documentation.

2

The Divio CLI uses Docker Compose to run the application locally. Creating a docker-compose.yml file with instructions on how to run your application locally is highly recommended. Here is an example of a docker-compose.yml file for a Wagtail app:

docker-compose.yml

services:
web:
  build: .
  ports:
    - "8000:80"
  volumes:
    - ".:/app:rw"
    - "./data:/data:rw"
  environment:
    DATABASE_URL: postgres://postgres@database_default:5432/db
  links:
    - "database_default"
  command: python manage.py runserver 0.0.0.0:80

database_default:
  image: postgres:15.7-alpine
  environment:
    POSTGRES_DB: "db"
    POSTGRES_HOST_AUTH_METHOD: "trust"
  volumes:
    - ".:/app:rw"

For a comprehensive understanding of how the Docker Compose works and its role in preparing your Wagtail app for deployment, we recommend referring to our detailed documentation.

3

Next, head over to the Divio Control Panel and choose to create a new application from the left toolbar.

4

The application creation wizard will provide you with some options to choose from, and you need to decide between:

• I already have a repository: Connect an existing repository from Github, Gitlab, or Bitbucket to Divio Cloud.
• I have some files uploaded: Provide a link to a ZIP file containing your application files.

Choose the option that fits your needs and follow the instructions. If you have a repository, you will be asked to provide the Git URL to the repository. If you have a ZIP file, you will be asked to provide a link to the ZIP file. Please mind that:

5

If you choose to use the Divio Git server, you need to connect to the Divio Cloud Platform through the following Git commands from within your local setup once the application creation step has been completed:

git remote add origin git@git.divio.com:myapp.git
git push origin --force

You can skip this step if you choose to connect to an existing repository from Github, Gitlab, or Bitbucket.

6

Proceed by giving your application a unique Name and Slug. We will start with a Free Trial plan for this guide, but you can always upgrade to a paid plan later. Before moving on, there are some options you need to consider:

• Cloudspace: The region you choose depends on your subscription plan. You can always change this later. Updating the cloud space will require a migration that causes downtime.
• Resources: The free trial does not allow you to modify resources. Paid subscriptions allow you to modify memory, instances, storage, backups, the number of domains, and more.
• Features: Not all features are available to all plans. Compare our plans to see what is available depending on your choice.

Add a Payment method and your Billing information to proceed. Rest assured, we need this information to verify your identity and prevent fraud. You will not be charged during the trial period, ensuring your peace of mind.

Click Create application to finish the setup process.

7

Our quickstart templates automatically configure all the necessary services for you. This process typically includes Object Storage or a Database:

• If your application requires Object Storage, read How to configure Object Storage.
• If your application requires a Database, read How to configure a Database.

When your application requires these services, it's important to configure them manually as documented above. Once you've completed this step, you can then proceed to deploy your application to Divio Cloud.

Creating a Wagtail app from scratch

We are here to provide you with a comprehensive guide, leading you step-by-step from the very beginning. We'll start with the creation of a new Wagtail application from scratch, and then we'll show you how to set it up and prepare it for deployment on the Divio Cloud Platform.

1

This section assumes that you are familiar with the command line and have Python installed on your machine. It is recommended to use a virtual environment to manage the dependencies for your project, both in development and in production. You can set everything up by running:

python3 -m venv .venv
. .venv/bin/activate
pip install wagtail
wagtail start myapp

Replace myapp with the name of your application. This process will create a myapp directory in your current directory and install the required dependencies.

Navigate to the newly created directory and run:

pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

This will install the dependencies, run migrations, create an admin user, and start the development server. You can access the Wagtail admin interface by visiting http://localhost:8000/admin/.

Congratulations 🎉, you have successfully set up a Wagtail project. You can now start building your website using the Wagtail admin interface. If you need help, you can refer to the official Wagtail documentation.

2

Next, we want to deploy your Wagtail application to the Divio Cloud Platform. To continue this, switch to the Migrating an existing app option.

Deploy your app

Deploy your Wagtail app

Your application has two independent server environments, Test and Live. These have their own backups, environment variables, services, and more. They can be deployed independently and configured to track different Git branches. Depending on the subscription plan you choose, you can also add more environments.

1

Once your application has been provisioned, press the Deploy button on the Test environment to start the deployment process.

This process 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 a database or media storage.

Typically, this takes a couple of minutes, depending on the complexity of your application.

2

After you have successfully deployed the Test environment, the Control Panel will indicate this in the interface with a Last deployment succeeded at ... message. The application URL in the test environment pane will display as a link, for example, https://myapp-stage.us.aldryn.io. Click the link to access the application.

3

Please note that the admin user is not created automatically. Migrations are also not run automatically. To set it up, connect via SSH and manually run:

python manage.py createsuperuser     # create admin user
python manage.py migrate             # run migrations

Migration Best Practices

When working with Wagtail, always run makemigrations <app_name> to avoid creating migrations for dependencies outside your control.

Recommended Command

To create migrations for an app named myapp, use:

python manage.py makemigrations myapp

You can find the SSH command on your applications dashboard under Dev tools > Commands within the desired environment. If the SSH shell appears to be spinning, press any key to regain control and proceed with creating the superuser.

Deployment Failures

The deployment process can fail for various reasons. If you encounter any issues, check the Last deployment failed status message on the environment card or consult the application Logs for further debugging information.

We also provide a debugging checklist that may help you further.

Any time new changes are committed to the repository, the Divio Control Panel will indicate this with a message showing the number of undeployed commits for each server environment.

If a deployment fails for whatever reason, there will be no downtime. The currently running containers will continue running, and the failing changes will not be deployed.

The application dashboard provides you with access to valuable controls and information. They are self-explanatory, and you don't need to interact with any of them at this stage, but it's worth familiarising yourself with what's available.

Setup your app locally

Setup your Wagtail app locally

1

You should have Git and Docker installed and configured on your local machine. We also strongly recommend installing the Divio CLI to interact with the Divio Cloud Platform from the command line. Alternatively, we will provide instructions on how to use Docker Compose to run your application locally instead.

2

Using the Divio CLI

From within your application's dashboard, select the Setup tab and copy the provided command. It should look something like this:

divio app setup myapp -s test

Copy the command into your terminal and run it. The Divio CLI will execute several steps to build your application locally. Depending on how much needs to be downloaded and processed, this may take a few minutes.

In addition to cloning the repository and building the application, the setup command will add a .divio directory containing some Divio-related configuration that connects it to the Divio Control Panel.

Navigate into the newly created application directory to find your application code. For example: cd myapp.

Please note that the admin user is not created automatically. To set it up, run:

docker compose run --rm web python manage.py createsuperuser

You also have to run migrations:

docker compose run --rm web python manage.py migrate

Start the application by running the following command in your terminal:

divio app start

Using Docker Compose

The Divio CLI proxies several commands to the necessary services. Alternatively, you can directly interact with Git, Docker, or Docker Compose to manage your application locally.

To set your application locally, run the command from the Clone tab; it looks something like this:

git clone -b main git@git.divio.com:myapp.git

Navigate into the newly created application directory to find your application code. For example: cd myapp.

Start the application by running the following commands in your terminal:

docker compose build

This ensures the web container is built and ready to run.

Please note that the admin user is not created automatically. To set it up, run:

docker compose run --rm web python manage.py createsuperuser

You also have to run migrations:

docker compose run --rm web python manage.py migrate

Next, start the container:

docker compose up

This command starts the application. The docker-compose.yml file should be in the root of your application and contain the necessary instructions to build and run your application.

3

The previous step will start the development server defined within your docker-compose.yml file. To view your application, open your web browser and navigate to http://127.0.0.1:8000.

Press CONTROL-C to stop the local development server or run docker compose down.

What if I already have it set up locally?

If you already have a repository or have provided some files and connected to the Divio Cloud Platform through these instructions, you can skip the setup process and start the application locally by running divio app start or docker compose up.

Helpful commands

The Divio CLI offers several commands to interact with your application. These commands, combined with Docker and Docker Compose, provide powerful tools to manage your application. Here are a few of the most useful commands:

For the Divio CLI

divio app start           # start the application locally
divio app stop            # stop the application locally
divio app logs            # show the logs of the application
divio app open            # open the application in the browser
divio app setup {app}     # setup the application locally
divio app deploy {env}    # deploy the application to an environment
# and many more, see https://github.com/divio/divio-cli for a full list

For Docker

docker ps       # show running containers
docker info     # show Docker information
# and many more, see https://docs.docker.com/reference/cli/docker/
# for a full list

For Docker Compose

docker compose build             # build the application
docker compose up                # start the application
docker compose down              # stop the application
docker compose exec web bash     # open a shell in the web container
# and many more, see https://docs.docker.com/compose/reference/
# for a full list

See our local commands cheat sheet for many more useful commands.

Dive Deeper

After setting up and deploying your Wagtail application on the Divio Cloud Platform, you can explore various features and tools that Divio offers. These tools can help you enhance your application's performance, manage your applications more efficiently, and integrate additional services seamlessly.

Basic features

Environments

Manage the test and live environment or add more.

Metrics

Real-time metrics offer insights into your app.

Logs

Access logs to debug and troubleshoot your app.

Deployments

Access history of deployments.

Activity

Provides a comprehensive audit trail and accountability.

Subscription

Manage your subscription plan for your app.

Collaborators

Invite team members to collaborate on your app.

Domains

Configure custom domains for your application.

Backups

Ensure your apps data is safe with automated backups.

Settings

Customize your app settings to meet your requirements.

Services

Integrate additional services with your app.

Mirrors

Mirror an application and use the same code-base.

Env Variables

Manage configuration settings for your app.

Cron Jobs

Schedule cron jobs to automate recurring tasks.

Maintenance

Plan maintenance tasks with minimal disruption.

Repository

Manage your source code repository through Git.

Advanced features

Once you're comfortable with the basics, you can explore more advanced features and tools to enhance your application even further:

• CI/CD: Implement continuous integration and continuous deployment pipelines. Automate your build, test, and deployment processes to ensure consistent and reliable application updates.

Enable beta features

We frequently introduce new functionalities and improvements. By opting into beta features in your account settings, you can gain early access to these innovations and provide feedback to help shape the future of the platform.

You can enable beta features from within your account settings.

Next steps

From this point, you can continue with the Getting started tutorial to learn more about Wagtail.