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
Copy file name to clipboardExpand all lines: docs/admin-guide/add-ons.md
+80-85Lines changed: 80 additions & 85 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,13 +18,17 @@ The Volto frontend has its own system of add-ons using Node.js packages.
18
18
See {doc}`/volto/development/add-ons/index`.
19
19
```
20
20
21
+
## Install an add-on from PyPI
21
22
22
-
## Cookieplone
23
+
For instructions to install an add-on that is released on {term}`PyPI`, select the tab below according to your Python package manager.
23
24
24
-
Use the following instructions if you installed Plone with Cookieplone.
25
+
```{tip}
26
+
Select the tab for uv if you have a project that was created using Cookieplone.
27
+
```
25
28
29
+
`````{tab-set}
26
30
27
-
### Install an add-on
31
+
````{tab-item} uv
28
32
29
33
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
30
34
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
@@ -59,127 +63,106 @@ To actually download and install the new add-on, run the following command.
59
63
make backend-build
60
64
```
61
65
62
-
Now restart the backend.
63
-
64
-
```{seealso}
65
-
{doc}`run-plone`
66
-
```
67
-
68
-
In your web browser, and assuming you are currently logged in as an administrator, visit the URL http://localhost:8080/Plone/prefs_install_products_form.
69
-
70
-
Then click the {guilabel}`Install` button next to your add-on to complete installation of the add-on.
71
-
72
-
Some add-ons have configuration options.
73
-
To configure such add-ons, return to the {guilabel}`Site Setup` control panel.
74
-
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a control panel to configure the add-on that you just installed.
66
+
````
75
67
68
+
````{tab-item} Buildout
76
69
77
-
### Install an add-on from source
78
-
79
-
An add-on can be installed from a source control system such as GitHub.
80
-
81
-
Add a line with the name of your add-on in the file {file}`backend/requirements.txt`.
70
+
Update the file {file}`buildout.cfg`.
82
71
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/).
83
72
84
-
```
85
-
collective.easyform
86
-
```
87
-
88
-
```{note}
89
-
When installing an add-on from source, it's best not to pin a version.
90
-
This way you always get the version that's currently available in the source control system.
91
-
```
92
-
93
-
Next add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` so that its configuration will load.
The {file}`mx.ini` file configures a tool called {term}`mxdev`.
111
-
See the [documentation of `mxdev` in its README.md](https://github.com/mxstack/mxdev/blob/main/README.md) for complete information.
93
+
```{tip}
94
+
Including the add-on version, or "pinning a version", ensures that it won't unintentionally get upgraded in the future.
112
95
```
113
96
114
-
Stop the backend with {kbd}`ctrl-c`.
115
-
116
97
To actually download and install the new add-on, run the following command.
117
98
118
99
```shell
119
-
make backend-build
100
+
bin/buildout -N
120
101
```
121
102
103
+
````
104
+
105
+
`````
106
+
122
107
Now restart the backend.
123
108
124
109
```{seealso}
125
110
{doc}`run-plone`
126
111
```
127
112
128
113
In your web browser, and assuming you are currently logged in as an administrator, visit the URL http://localhost:8080/Plone/prefs_install_products_form.
129
-
An upgrade step might need to be performed in the Plone control panel.
130
-
Follow the upgrade information, if present.
131
-
Else click the {guilabel}`Install` button to complete installation of the add-on.
132
114
115
+
Then click the {guilabel}`Install` button next to your add-on to complete installation of the add-on.
116
+
117
+
Some add-ons have configuration options.
118
+
To configure such add-ons, return to the {guilabel}`Site Setup` control panel.
119
+
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a control panel to configure the add-on that you just installed.
133
120
134
-
## Buildout
135
121
136
-
Use the following instructions if you installed Plone with Buildout.
122
+
## Install an add-on from source
137
123
138
-
### Install an add-on
124
+
An unreleased add-on can be installed from a source control system such as GitHub.
139
125
140
-
Update the file {file}`buildout.cfg`.
141
-
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/).
126
+
For instructions to install an add-on that is released on {term}`PyPI`, select the tab below according to your Python package manager.
You can install an add-on from a source control system such as GitHub.
165
+
````{tab-item} Buildout
183
166
184
167
Update the file {file}`buildout.cfg`.
185
168
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/).
@@ -213,12 +196,24 @@ To actually download and install the new add-on, run the following command.
213
196
bin/buildout
214
197
```
215
198
216
-
Then restart your instance.
217
-
218
199
```{seealso}
219
-
{doc}`run-plone`
200
+
This approach uses the [`mr.developer`](https://pypi.org/project/mr.developer/) Buildout extension.
220
201
```
221
202
203
+
````
204
+
205
+
`````
206
+
207
+
Now restart the backend.
208
+
222
209
```{seealso}
223
-
This approach uses the [`mr.developer`](https://pypi.org/project/mr.developer/) Buildout extension.
210
+
{doc}`run-plone`
224
211
```
212
+
213
+
In your web browser, and assuming you are currently logged in as an administrator, visit the URL http://localhost:8080/Plone/prefs_install_products_form.
214
+
215
+
Then click the {guilabel}`Install` button next to your add-on to complete installation of the add-on.
216
+
217
+
Some add-ons have configuration options.
218
+
To configure such add-ons, return to the {guilabel}`Site Setup` control panel.
219
+
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a control panel to configure the add-on that you just installed.
0 commit comments