You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Install Plone Backend from Source – Step by Step
12
+
# Install Plone backend from Scratch – Step by Step
13
13
14
-
For system requirements and Pre-requisites for the installation see {ref}`install-source-system-requirements-label`.
15
14
16
-
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxstack` and other fancy helpers.
15
+
(install-source-stepbystep-backend-start-label)=
17
16
17
+
## Backend
18
18
19
-
(install-source-installation-steps-label)=
19
+
For system requirements and pre-requisites for the installation see {ref}`install-source-system-requirements-label`.
20
20
21
-
### Installation steps
21
+
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxdev` and other fancy helpers.
22
22
23
-
```{admonition} Jump in!
24
-
:class: margin
25
-
Go to {ref}`install-source-installation-jump-label` if you want to develop and want to jump in with all steps prepared by an overall cookiecutter.
23
+
```{note}
24
+
There will be one single cookiecutter template to install both backend and frontend from scratch. You will find the instructions on {ref}`install-source-installation-jump-label`. That chapter is for you if you want to develop and want to jump in with all steps prepared by an overall cookiecutter. The subsequent sections explain the installation of the backend step by step. You will learn the details of the installation included in the future overall cookiecutter.
26
25
```
27
26
27
+
28
+
(install-source-installation-steps-label)=
29
+
30
+
### Installation steps
31
+
28
32
Create a new directory to hold your project, make it your current directory, then issue the following commands in a shell session.
29
33
30
34
Create a Python virtual environment in the current directory.
@@ -118,22 +122,23 @@ You can stop the instance later with {kbd}`ctrl-esc`.
118
122
If you now open the browser with http://localhost:8080/, you see that you already can create a Plone instance.
119
123
Before doing this, we configure our Zope instance for blobs, configure add-ons, etc..
120
124
For the configuration, you have two options:
121
-
- manual configuration of site.zcml and zope.conf
122
-
-use of helper`cookiecutter-zope-instance`
125
+
- manual configuration of site.zcml and zope.conf (^[Configuring and Running Zope](https://zope.readthedocs.io/en/latest/operation.html))
`Cookiecutter` creates projects from project templates. `cookiecutter-zope-instance` is such a template that allows to create a complete Zope configuration. Zope configuration means: blob storage, type of file storage (Zope style or relational database), ZEO, you name it.
132
+
`Cookiecutter` creates projects from project templates.
133
+
{term}`cookiecutter-zope-instance` is such a template that allows to create a complete Zope configuration. Zope configuration means: blob storage, type of file storage (Zope style or relational database), ZEO, you name it.
129
134
130
135
Install cookiecutter:
131
136
132
137
```shell
133
138
pip install cookiecutter
134
139
```
135
140
136
-
You could now run `cookiecutter` to create a Zope instance sceleton with configuraton with the following command, which would prompt you for parameter values.
141
+
You could now run `cookiecutter` to create a Zope instance sceleton including configuration with the following command. It prompts you for parameter values.
Head over to http://localhost:8080/ and see that Plone is running.
221
-
You could now create a Plone instance {ref}`install-source-create-plone-site-label` and enable the add-on `my.awesome.addon` in {guilabel}`Site Setup` [http://localhost:8080/Plone/prefs_install_products_form](http://localhost:8080/Plone/prefs_install_products_form).
226
+
You could now create a Plone instance {ref}`install-source-create-plone-site-label` and enable the add-on `collective.easyform` in {guilabel}`Site Setup` [http://localhost:8080/Plone/prefs_install_products_form](http://localhost:8080/Plone/prefs_install_products_form).
222
227
223
228
If you want to run Plone with some add-ons, you are ready with the installation of the backend.\
224
229
If you decided to go with the Plone Classic UI this is also your frontend.\
225
-
If you decided to go with the Plone Volto frontend, then section {ref}`install-source-volto-frontend-label` shows your next steps.
230
+
If you decided to go with the Plone Volto frontend, then section {ref}`install-source-volto-frontend-label` explains your next steps.
226
231
227
232
If you want to develop a Plone package, then the subsequent section is for you.
228
233
@@ -267,7 +272,7 @@ collective.easyform
267
272
collective.easyform==3.4.5
268
273
```
269
274
270
-
{file}`sources.ini`
275
+
{file}`mx.ini`
271
276
272
277
```ini
273
278
[settings]
@@ -281,7 +286,7 @@ branch = master
281
286
extras = test
282
287
```
283
288
284
-
A run of mxdev reads {file}`requirements.txt`and {file}`sources.ini`, and writes new combined requirements in {file}`constraints-mxdev.txt` and writes new constraints in {file}`constraints-mxdev.txt` according to {file}`source.ini`:
289
+
A run of mxdev reads {file}`requirements.txt`, {file}`constraints.txt`and {file}`mx.ini`, and writes new combined requirements in {file}`requirements-mxdev.txt` and writes new constraints in {file}`constraints-mxdev.txt` according to {file}`mx.ini`:
285
290
286
291
- 'version-overrides' in [settings]
287
292
- checkout settings in [packagename] sections
@@ -296,11 +301,11 @@ Create
296
301
297
302
- {file}`requirements.txt`
298
303
- {file}`constraints.txt`
299
-
- {file}`sources.ini`
304
+
- {file}`mx.ini`
300
305
301
306
```shell
302
307
pip install mxdev
303
-
mxdev -c sources.ini
308
+
mxdev -c mx.ini
304
309
pip install -r requirements-mxdev.txt
305
310
runwsgi instance/etc/zope.ini
306
311
```
@@ -309,10 +314,10 @@ Create
309
314
So with the three files above, run `mxdev` with:
310
315
311
316
```shell
312
-
mxdev -c sources.ini
317
+
mxdev -c mx.ini
313
318
```
314
319
315
-
You are now ready to install your packages with `pip` and the new constraints file:
320
+
You are now ready to install your packages with `pip` and the new requirements file:
You have seen how `mxdev` helps with versions and checkouts. It can do a lot more for you. See {ref}`install-source-tools-label` for more information.
333
+
You have seen how `mxdev` helps with versions and checkouts. It can do a lot more for you. See [mxdev](https://github.com/mxstack/mxdev) for more information.
329
334
```
330
335
331
-
You can now continue with {ref}`install-source-create-plone-site-label`.
: Add a line with the name of your add-on to `requirements.txt` and add it to {ref}`instance.yaml<install-source-cookiecutter-zope-instance-presets-label>`, then install with pip and apply cookiecutter:
: A version can **not** be pinned in requirements.txt if the package is mentionend in the constraints of Plone.
348
-
Any other package version could be pinned in requirements.txt. Instead see section {ref}`install-source-checkout-and-pin` for a clean and well documented set up of your Zope/Plone installation.
336
+
You can now continue with chapter {ref}`install-source-create-plone-site-label`.
0 commit comments