Training setup – Plone deployment

Training setup

Training setup#

Ensure a seamless learning experience by preparing your computer with the necessary software before the training commences.

Prerequisites#

Operating system#

See the Plone 6 documentation for Prerequisites for installation.

macOS users should have Homebrew installed to install missing prerequisites.

jq#

Use your package manager to install jq.

brew install jq

apt install -y jq

apt-get install jq

Git#

See the Plone 6 documentation for how to install Git.

Code editor#

Choose a code editor you're comfortable with, such as VSCode, PyCharm, Sublime, vi, or Emacs.

uv#

See the Plone 6 documentation for how to install uv uv.

Docker#

Ensure Docker version 27.2.0 or above is installed. Verify with:

docker --version

Ensure Docker is running. Verify with:

docker ps

Node.js and its tools#

See the Plone 6 documentation for how to install Node.js.

Todo

In future versions of the cookiecutter template, a .nvmrc file will be included to simplify Node.js version management. The commands below will be applicable then.

nvm install
nvm use

External services#

GitHub account#

Make sure your computer is set up with the appropriate keys to access your GitHub account, as we will be utilizing GitHub extensively throughout this training.

If you are not sure about the keys you have on GitHub, you can check it by accessing the following URL:

https://github.com/<your-github-username>.keys

Container registry: GitHub or Docker Hub#

We'll use the GitHub Container Registry during the training. The concepts are also applicable to Docker Hub. If you prefer Docker Hub:

  • Create an account at Docker Hub.

  • Configure your local Docker to use Docker Hub credentials.

    docker login

Cookieplone#

The latest version of Cookieplone will be used, and it doesn't require a separate installation as we'll use uvx.

Make#

See the Plone 6 documentation for how to install Make.

Troubleshooting#

Insufficient Docker virtual disk space#

Docker requires sufficient virtual disk space to install and build images. A typical error message may be: Could not create directory. or anything else that mentions writing to the image. To resolve this, use an appropriate docker system prune option, such as:

docker system prune -a

See also

docker system prune

You can also configure settings for Docker Desktop. Under Prefences > Resources > Advanced, you can configure appropriate settings for virtual disk limit and memory.

See also

Insufficient Docker virtual memory#

Docker requires sufficient memory to install and build images. See the previous item for details.

Contents