|
| 1 | +--- |
| 2 | +html_meta: |
| 3 | + "description": "Install Plone 6" |
| 4 | + "property=og:description": "Install Plone 6" |
| 5 | + "property=og:title": "Install Plone 6" |
| 6 | + "keywords": "installation, installing, buildout, pip, docker" |
| 7 | +--- |
| 8 | + |
| 9 | +(backend-installation-label)= |
| 10 | + |
| 11 | +# Installation |
| 12 | + |
| 13 | +Some documentation about installation: |
| 14 | + |
| 15 | +* [Installation instructions from the Mastering Plone 6 training](https://training.plone.org/5/mastering-plone/installation.html) |
| 16 | +* {ref}`frontend-getting-started-installing-volto-label` |
| 17 | +* [Community post](https://community.plone.org/t/our-pip-based-development-workflow-for-plone/14562) on work in progress with [`plone-kickstarter`](https://github.com/bluedynamics/plone-kickstarter) and [`mxdev`](https://github.com/bluedynamics/mxdev). |
| 18 | + |
| 19 | +If you use Docker, we have some images: |
| 20 | + |
| 21 | +* `plone/plone-backend` (5.2 and 6.0) |
| 22 | +* `plone/plone-frontend` (Volto) |
| 23 | +* `plone/plone-haproxy` |
| 24 | + |
| 25 | +If you don't do Docker, you will have to do the backend by hand. |
| 26 | +The links above should give you information on how to install the prerequisites, like Python, also on Windows. |
| 27 | +Here, we will focus on Unix-like systems (Linux, Mac OSX), but Windows should work as well. |
| 28 | +The steps are: |
| 29 | + |
| 30 | +* Install the Plone (Classic) backend with buildout or pip. |
| 31 | +* Create the Plone Site in the browser. |
| 32 | +* Install the Plone frontend (Volto) with node. |
| 33 | + |
| 34 | +Below we will install Plone 6.0.0a4. |
| 35 | +You should use the latest from the Plone 6.0 series. |
| 36 | +We install it with Python 3.9. |
| 37 | +Python 3.7 and 3.8 are also supported. |
| 38 | +Please use the most recent version supported by your platform. |
| 39 | + |
| 40 | + |
| 41 | +(installation-backend-buildout-label)= |
| 42 | + |
| 43 | +## Install backend with buildout |
| 44 | + |
| 45 | +Change to a new directory and put a file `buildout.cfg` in it: |
| 46 | + |
| 47 | +```ini |
| 48 | +[buildout] |
| 49 | +extends = https://dist.plone.org/release/6.0.0a4/versions.cfg |
| 50 | +parts = instance |
| 51 | + |
| 52 | +[instance] |
| 53 | +recipe = plone.recipe.zope2instance |
| 54 | +eggs = |
| 55 | + Plone |
| 56 | +user = admin:admin |
| 57 | +``` |
| 58 | + |
| 59 | +Install it with: |
| 60 | + |
| 61 | +```shell |
| 62 | +python3.9 -m venv . |
| 63 | +bin/pip install -r https://dist.plone.org/release/6.0.0a4/requirements.txt |
| 64 | +bin/buildout |
| 65 | +bin/instance fg |
| 66 | +``` |
| 67 | + |
| 68 | + |
| 69 | +(installation-backend-pip-label)= |
| 70 | + |
| 71 | +## Install backend with pip |
| 72 | + |
| 73 | +If you do not want to use buildout, you can install the Plone Python packages with `pip`. |
| 74 | +Change to a new directory and then: |
| 75 | + |
| 76 | +```shell |
| 77 | +python3.9 -m venv . |
| 78 | +bin/pip install -U pip setuptools wheel |
| 79 | +bin/pip install Plone -c https://dist.plone.org/release/6.0.0a4/constraints.txt |
| 80 | +bin/mkwsgiinstance -u admin:admin -d . |
| 81 | +bin/runwsgi -v etc/zope.ini |
| 82 | +``` |
| 83 | + |
| 84 | +Note: you may need to edit `etc/zope.conf` to add a `blob-dir`. |
| 85 | +See [issue 3345](https://github.com/plone/Products.CMFPlone/issues/3345#issuecomment-953700024). |
| 86 | + |
| 87 | + |
| 88 | +(installation-create-plone-backend-label)= |
| 89 | + |
| 90 | +## Create Plone backend |
| 91 | + |
| 92 | +After you have installed the backend with buildout or pip, open a browser and go to http://localhost:8080/. |
| 93 | +Click 'Create a new Plone site' to prepare for the new Volto frontend. |
| 94 | +If you want Plone Classic instead, click 'Create Classic Plone site'. |
| 95 | +(If this button is not available, then you did not install `plone.volto` with buildout or pip. 'Create a new Plone site' will create a Classic site then.) |
| 96 | + |
| 97 | +Note: For Volto, make sure the Path identifier is Plone. You can change this, but then you need to change some Volto frontend configuration as well. |
| 98 | + |
| 99 | +Submit the form and your backend is ready. |
| 100 | +If you want Classic Plone, you are done. |
| 101 | +If you want the full Plone 6 with Volto, read on. |
| 102 | + |
| 103 | + |
| 104 | +(installation-frontend-node-label)= |
| 105 | + |
| 106 | +## Frontend with node |
| 107 | + |
| 108 | +You should probably read the chapter on {ref}`frontend-getting-started-installing-volto-label`. |
| 109 | +But the following gives you the general idea. |
| 110 | + |
| 111 | +First you may want to install `nvm`, the Node Version Manager: |
| 112 | + |
| 113 | +* On Linux: `apt-get install nvm` |
| 114 | +* On Mac: `brew install nvm` |
| 115 | +* Or use the installation procedure detailed in the [nvm documentation](https://github.com/nvm-sh/nvm) |
| 116 | + |
| 117 | +You use `nvm` to install recent `node/npm/yarn` versions: |
| 118 | + |
| 119 | +```shell |
| 120 | +nvm install --lts |
| 121 | +npm install --global yarn |
| 122 | +``` |
| 123 | + |
| 124 | +Create a Volto project: |
| 125 | + |
| 126 | +```shell |
| 127 | +npm init yo @plone/volto |
| 128 | +``` |
| 129 | + |
| 130 | +This will take long, and then ask for a project name. |
| 131 | +It will create a directory with this name. |
| 132 | +Go to that directory and start the frontend: |
| 133 | + |
| 134 | +```shell |
| 135 | +yarn start |
| 136 | +``` |
| 137 | + |
| 138 | +In your browser go to [http://localhost:3000](http://localhost:3000/). |
| 139 | + |
| 140 | +You are done. Welcome to Plone 6! |
0 commit comments