Install Plone with pip

Install Plone with pip#

This chapter describes how you can install Plone using pip.

This is one way to install Plone with the Classic UI. It provides a basic installation without many additional tools to help with development.

See also

For other installation options, see Install Plone.

Supported web browsers#

You can view the list of supported browsers for Classic UI at Browserslist.

The supported web browsers for Classic UI are set according to Bootstrap. The following code snippet is the browserslist configuration for Bootstrap 5.3.3.

>= 0.5%
last 2 major versions
not dead
Chrome >= 60
Firefox >= 60
Firefox ESR
iOS >= 12
Safari >= 12
not Explorer <= 11

Prerequisites for installation#

  • For Plone 6.0, Python 3.9, 3.10, 3.11, 3.12, or 3.13

Python#

Installing Python is beyond the scope of this documentation. However, it is recommended to use a Python version manager, pyenv, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.

Plone 6.0 requires Python version 3.9, 3.10, 3.11, 3.12, or 3.13.

Added in version Plone: 6.0.14

Support for Python 3.13.

Removed in version Plone: 6.0.14

Support for Python 3.8.

Warning

Do not create or activate a Python virtual environment at this time. The instructions below will create one.

Installation#

Select a directory of your choice, and change it to your working directory.

mkdir -p <my_projects>/plone
cd <my_projects>/plone

Create a Python virtual environment.

python3 -m venv venv

Install Plone and a helper package, pipx.

venv/bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx

Create a Zope instance#

Create a file instance.yaml in your directory with the following contents.

default_context:
  initial_user_name: "admin"
# Use a secure token for the password in a production environment.
  initial_user_password: "admin"
  wsgi_listen: "localhost:8080"
  debug_mode: false
  verbose_security: false
  db_storage: "direct"
  environment: {
    "zope_i18n_compile_mo_files": true,
  }

Now run the cookiecutter tool to create configuration for a Zope instance.

bin/pipx run cookiecutter -f --no-input --config-file instance.yaml gh:plone/cookiecutter-zope-instance

Start Plone in foreground mode#

Start the instance for a quick test.

bin/runwsgi -v instance/etc/zope.ini

Your instance starts in foreground mode. This should be used only for troubleshooting or local demonstration purposes.

Now you can visit http://localhost:8080 in your browser. Click the button Create Classic UI Plone site.

Enter username of admin, and password of admin.

Enter values in the form, and click the button Create Plone Site.

You will be redirected to your new Classic UI Plone site.

To stop the Plone instance in foreground mode, type ctrl-c.

Contents