Skip to content

Commit 2603852

Browse files
committed
Add run-plone to admin guide
1 parent 440c34e commit 2603852

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed

docs/admin-guide/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ install-plonestarter
2828
:caption: Operate
2929
:maxdepth: 1
3030
31+
run-plone
3132
upgrade
3233
```
3334

docs/admin-guide/run-plone.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Run Plone"
5+
"property=og:description": "Run Plone"
6+
"property=og:title": "Run Plone"
7+
"keywords": "Plone 6, run, start, command"
8+
---
9+
10+
(run-plone-label)=
11+
12+
# Run Plone
13+
14+
This chapter shows the commands to run Plone after it is installed.
15+
16+
There are different commands to run Plone, depending on which method you used to install Plone.
17+
18+
## Run Plone in foreground mode
19+
20+
Running Plone in foreground mode will show output in the terminal. This is recommended while developing a Plone site.
21+
22+
with Cookieplone:
23+
: ```shell
24+
make backend-start
25+
```
26+
27+
with Buildout:
28+
: ```shell
29+
bin/instance fg
30+
```
31+
32+
with pip:
33+
: ```shell
34+
bin/runwsgi instance/etc/zope.ini
35+
```
36+
37+
with `cookiecutter-plone-starter`:
38+
: ```shell
39+
make start-backend
40+
```
41+
42+
## Run Volto
43+
44+
If you are using the Volto frontend, you need to run the frontend in a separate process.
45+
46+
with Cookieplone:
47+
: ```shell
48+
make frontend-start
49+
```
50+
51+
with `cookiecutter-plone-starter`:
52+
: ```shell
53+
make start-frontend
54+
```
55+
56+
## Start Plone as a background service
57+
58+
with Buildout:
59+
: ```shell
60+
bin/instance start
61+
```
62+
63+
## Stop Plone as a background service
64+
65+
with Buildout:
66+
: ```shell
67+
bin/instance stop
68+
```
69+
70+
## Run a debug console
71+
72+
The debug console gives you a Python prompt with the Plone site's configuration loaded.
73+
Use this for troubleshooting.
74+
75+
with Cookieplone:
76+
: ```shell
77+
make -C backend console
78+
```
79+
80+
with Buildout:
81+
: ```shell
82+
bin/instance debug
83+
```
84+
85+
with pip:
86+
: ```shell
87+
bin/zconsole debug instance/etc/zope.ini
88+
```
89+
90+
with `cookiecutter-plone-starter`:
91+
: ```shell
92+
make -C backend debug
93+
```

0 commit comments

Comments
 (0)