-
-
Notifications
You must be signed in to change notification settings - Fork 174
add install notes for classic ui, pip and buildout method #1701
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
d96bf8f
cb3d1ee
578c226
5b9f1fd
fcd8eb6
f0a842c
bcb8403
0fad521
7edd163
bb2e9ec
2b3ac41
935ed91
601577e
2482786
6c4e276
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,198 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "Installation notes for Plone Classic UI" | ||
"property=og:description": "Installation notes for Plone Classic UI" | ||
"property=og:title": "Installation notes for pip and buildout based installation paths" | ||
"keywords": "Plone, Classic UI, classic-ui, installation, pip, buildout" | ||
--- | ||
|
||
(classic-ui-installation-label)= | ||
|
||
# Installation | ||
|
||
This sections describes how to install Plone 6 Classic UI. | ||
Examples include the following. | ||
|
||
- pip based install method | ||
- buildout based install method | ||
|
||
(classic-ui-installation-pip-label)= | ||
|
||
## Quickstart pip based installation | ||
|
||
install notes for linux | ||
|
||
requirements: | ||
|
||
- python3.10 or greater | ||
- python venv module | ||
|
||
in our example we use python3.12 | ||
|
||
On debian based systems you can install python with following command | ||
|
||
```bash | ||
sudo apt install python3.12 python3.12-dev python3.12-venv | ||
``` | ||
|
||
Select a directory of your choice | ||
|
||
```bash | ||
mkdir -p /tmp/plone && cd /tmp/plone | ||
``` | ||
|
||
Create a virtual environment | ||
|
||
```bash | ||
python3 -m venv ./venv | ||
``` | ||
|
||
Activate the virtual environment | ||
|
||
```bash | ||
source ./venv/bin/activate | ||
``` | ||
|
||
Install Plone and a helper package | ||
|
||
```bash | ||
pip install Plone cookiecutter | ||
``` | ||
|
||
```bash | ||
cookiecutter -f --no-input --config-file ./instance.yaml https://github.com/plone/cookiecutter-zope-instance | ||
``` | ||
|
||
Deactivate the virtual environment | ||
|
||
```bash | ||
deactivate | ||
``` | ||
|
||
minimal content for the `instance.yaml` file | ||
|
||
```yaml | ||
# please change the password to a secrue token! | ||
default_context: | ||
initial_user_name: "admin" | ||
initial_user_password: "admin" | ||
wsgi_listen: "localhost:8080" | ||
debug_mode: false | ||
verbose_security: false | ||
db_storage: "direct" | ||
environment: { | ||
"zope_i18n_compile_mo_files": true, | ||
} | ||
``` | ||
|
||
Start the instance for quick test | ||
|
||
```bash | ||
./venv/bin/runwsgi -v instance/etc/zope.ini | ||
``` | ||
|
||
Your instance starts in foreground mode, which is only advisable for troubleshooting or for local demonstration purposes, | ||
|
||
Now you can call the url `http://localhost:8080` in your browser and you can add a **Classic UI Plone site** | ||
|
||
Let's have fun with Plone! | ||
|
||
```{todo} | ||
add an example to create a zeo installation | ||
``` | ||
|
||
```{todo} | ||
add an example to start the instance via for systemd | ||
``` | ||
|
||
(classic-ui-installation-buildout-label)= | ||
|
||
## Quickstart buildout based installation | ||
|
||
install notes for linux | ||
|
||
requirements: | ||
|
||
- python3.10 or greater | ||
- python venv module | ||
|
||
in our example we use python3.12 | ||
|
||
On debian based systems you can install python with following command | ||
|
||
```bash | ||
sudo apt install python3.12 python3.12-dev python3.12-venv | ||
``` | ||
|
||
Select a directory of your choice | ||
|
||
```bash | ||
mkdir -p /tmp/plone && cd /tmp/plone | ||
``` | ||
|
||
Create a virtual environment | ||
|
||
```bash | ||
python3 -m venv . | ||
``` | ||
|
||
Activate the virtual environment | ||
|
||
```bash | ||
source ./bin/activate | ||
``` | ||
|
||
install requirements | ||
|
||
```bash | ||
pip install -r https://dist.plone.org/release/6-latest/requirements.txt | ||
``` | ||
|
||
add a minimal `buildout.cfg` file to your directory | ||
|
||
```cfg | ||
[buildout] | ||
extends = | ||
https://dist.plone.org/release/6-latest/versions.cfg | ||
|
||
parts = | ||
instance | ||
|
||
[instance] | ||
recipe = plone.recipe.zope2instance | ||
user = admin:admin | ||
http-address = 8080 | ||
eggs = | ||
Plone | ||
``` | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i would add the following command, which creates the bin/buildout script, so venv does need to be used after that anymore.
then deactivate venv and jut run ./bin/buildout when ever something in the buildout config has changed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @MrTango Are you actually using the |
||
run buildout | ||
|
||
```bash | ||
buildout | ||
``` | ||
|
||
Start the instance for quick test in foreground mode | ||
|
||
```bash | ||
./bin/instance fg | ||
``` | ||
|
||
Start the instance normal | ||
|
||
```bash | ||
./bin/instance start | ||
``` | ||
|
||
Stop the instance | ||
|
||
```bash | ||
./bin/instance stop | ||
``` | ||
|
||
Your instance starts in foreground mode, which is only advisable for troubleshooting or for local demonstration purposes, | ||
MrTango marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Now you can call the url `http://localhost:8080` in your browser and you can add a **Classic UI Plone site** | ||
|
||
Let's have fun with Plone! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe also a zeo setup? |
Uh oh!
There was an error while loading. Please reload this page.