Install Plone with Buildout

Install Plone with Buildout#

This chapter describes how you can install Plone using Buildout.

This is one way to install Plone with the Classic UI. Using Buildout will be the most familiar approach for administrators who have experience with Plone 3, 4, or 5.

See also

For other installation options, see Install Plone.

Prerequisites for installation#

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

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.8, 3.9, 3.10, 3.11, or 3.12.

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 the minimal Python packages needed in order to run Buildout.

venv/bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt

Create a buildout.cfg file in your directory with the following contents.

[buildout]
extends =
    https://dist.plone.org/release/6-latest/versions.cfg

parts =
    instance

[instance]
recipe = plone.recipe.zope2instance
# user = username:password - Use a secure token in a production environment.
user = admin:admin
http-address = 8080
eggs =
    Plone

Use Buildout's bootstrap command to install a local buildout script in the bin directory.

venv/bin/buildout bootstrap

Run Buildout.

bin/buildout

This may take a few minutes.

Whenever you change the Buildout configuration, run ./bin/buildout again.

Start Plone in foreground mode#

Start the instance for a quick test in foreground mode:

bin/instance fg

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.

Start Plone as a background service#

Start the instance.

bin/instance start

Stop Plone as a background service#

Stop the instance.

bin/instance stop
Contents