Skip to content

Commit d4ac53d

Browse files
committed
Clean up Install / Containers chapter
1 parent d8097ad commit d4ac53d

File tree

14 files changed

+264
-172
lines changed

14 files changed

+264
-172
lines changed

docs/glossary.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -285,16 +285,16 @@ DPI
285285
```{seealso}
286286
https://developer.mozilla.org/en-US/docs/Web/CSS/resolution#dpi
287287
```
288-
```
289288
290289
Docker
291-
[Docker](https://docker.com) is an open platform for developing, shipping, and running applications using containers.
290+
[Docker](https://www.docker.com/) is an open platform for developing, shipping, and running applications using containers.
292291
293292
RelStorage
294-
[RelStorage](https://relstorage.readthedocs.io) is a storage implementation for ZODB that stores pickles in a relational database.
293+
[RelStorage](https://relstorage.readthedocs.io/en/latest/) is a storage implementation for ZODB that stores pickles in a relational database.
295294
296295
ZEO
297-
[ZEO](https://zeo.readthedocs.io) is a client-server storage for ZODB for sharing a single storage among many clients.
296+
[ZEO](https://zeo.readthedocs.io/en/latest/) is a client-server storage for ZODB for sharing a single storage among many clients.
298297
299298
PostgreSQL
300299
[PostgreSQL](https://www.postgresql.org/) is a powerful, open source object-relational database.
300+
```

docs/install/containers/examples/index.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
html_meta:
33
"description": "Examples of Plone 6 setup with containers"
44
"property=og:description": "Examples of Plone 6 setup with containers"
5-
"property=og:title": "Example usage of Plone 6 with containers"
5+
"property=og:title": "Examples of Plone 6 using containers"
66
"keywords": "Plone 6, install, installation, docker, containers"
77
---
8-
# Examples
8+
9+
# Examples of Plone 6 using containers
910

1011
```{toctree}
1112
:maxdepth: 2
@@ -17,11 +18,11 @@ nginx-volto-plone-postgresql
1718
nginx-plone
1819
```
1920

20-
Examples of projects running Plone using `docker-compose`
21+
Examples of projects running Plone using `docker-compose`.
2122

22-
| Project example | Description |
23-
| ------------------------------------------------------------ | ------------------------------------------------------- |
24-
| [nginx-volto-plone](nginx-volto-plone) | Stack with nginx, Frontend and Backend |
25-
| [nginx-volto-plone-zeo](nginx-volto-plone-zeo) | Stack with nginx, Frontend, Backend and ZEO server |
26-
| [nginx-volto-plone-postgresql](nginx-volto-plone-postgresql) | Stack with nginx, Frontend, Backend and PostgreSQL DB |
27-
| [nginx-plone](nginx-plone) | Stack with nginx, and Backend (Plone Classic) |
23+
| Project example | Description |
24+
| --- | --- |
25+
| [nginx-volto-plone](nginx-volto-plone) | Stack with nginx, Frontend and Backend |
26+
| [nginx-volto-plone-zeo](nginx-volto-plone-zeo) | Stack with nginx, Frontend, Backend and ZEO server |
27+
| [nginx-volto-plone-postgresql](nginx-volto-plone-postgresql) | Stack with nginx, Frontend, Backend and PostgreSQL DB |
28+
| [nginx-plone](nginx-plone) | Stack with nginx, and Backend (Plone Classic) |

docs/install/containers/examples/nginx-plone.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
# Nginx, Plone Classic
1+
---
2+
html_meta:
3+
"description": "Simple Plone 6 setup with one backend and data being persisted in a Docker volume."
4+
"property=og:description": "Simple Plone 6 setup with one backend and data being persisted in a Docker volume."
5+
"property=og:title": "Nginx, Plone Classic container example"
6+
"keywords": "Plone 6, Container, Docker, Nginx, Plone Classic"
7+
---
8+
9+
# Nginx, Plone Classic container example
210

311
Simple setup with one backend and data being persisted in a Docker volume.
412

13+
514
## Setup
615

7-
Create an empty project directory named `nginx-plone`
16+
Create an empty project directory named `nginx-plone`.
817

918
```shell
1019
mkdir nginx-plone
@@ -16,6 +25,7 @@ Change into your project directory.
1625
cd nginx-plone
1726
```
1827

28+
1929
### nginx configuration
2030

2131
Add a `default.conf` that will be used by the nginx image:
@@ -40,9 +50,10 @@ server {
4050
}
4151
```
4252

43-
### Service configuration with docker-compose
4453

45-
Now, let's create a `docker-compose.yml` file:
54+
### Service configuration with `docker-compose`
55+
56+
Now let's create a `docker-compose.yml` file:
4657

4758
```yaml
4859
version: "3"
@@ -71,22 +82,25 @@ volumes:
7182
data: {}
7283
```
7384
85+
7486
## Build the project
7587
76-
Start the stack with `docker-compose` (or `docker compose` for newer versions)
88+
Start the stack with `docker-compose`.
7789

7890
```shell
7991
docker-compose up -d
8092
```
8193

82-
This will pulls the needed images, and starts Plone.
94+
This pulls the needed images and starts Plone.
95+
8396

8497
## Access Plone via Browser
8598

8699
After startup, go to `http://plone.localhost/` and you should see the site.
87100

101+
88102
## Shutdown and cleanup
89103

90-
The command docker-compose down removes the containers and default network, but preserves the Plone database.
104+
The command `docker-compose down` removes the containers and default network, but preserves the Plone database.
91105

92-
The command docker-compose down --volumes removes the containers, default network, and the Plone database.
106+
The command `docker-compose down --volumes` removes the containers, default network, and the Plone database.

docs/install/containers/examples/nginx-volto-plone-postgresql.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
# Nginx, Frontend, Backend, Postgres
1+
---
2+
html_meta:
3+
"description": "Very simple Plone 6 setup with only one or more backend instances accessing a PostgreSQL server and data being persisted in a Docker volume."
4+
"property=og:description": "Very simple Plone 6 setup with only one or more backend instances accessing a PostgreSQL server and data being persisted in a Docker volume."
5+
"property=og:title": "Nginx, Frontend, Backend, PostgreSQL container example"
6+
"keywords": "Plone 6, Container, Docker, Nginx, Frontend, Backend, PostgreSQL, "
7+
---
8+
9+
# Nginx, Frontend, Backend, PostgreSQL container example
210

311
Very simple setup with only one or more backend instances accessing a Postgres server and data being persisted in a Docker volume.
412

13+
514
## Setup
615

7-
Create an empty project directory named `nginx-volto-plone-postgresql`
16+
Create an empty project directory named `nginx-volto-plone-postgresql`.
817

918
```shell
1019
mkdir nginx-volto-plone-postgresql
@@ -16,6 +25,7 @@ Change into your project directory.
1625
cd nginx-volto-plone-postgresql
1726
```
1827

28+
1929
### nginx configuration
2030

2131
Add a `default.conf` that will be used by the nginx image:
@@ -65,9 +75,10 @@ server {
6575
}
6676
```
6777

68-
### Service configuration with docker-compose
6978

70-
Now, let's create a `docker-compose.yml` file:
79+
### Service configuration with `docker-compose`
80+
81+
Now let's create a `docker-compose.yml` file:
7182

7283
```yaml
7384
version: "3"
@@ -117,30 +128,34 @@ volumes:
117128
data: {}
118129
```
119130
131+
120132
## Build the project
121133
122-
Start the stack with `docker-compose` (or `docker compose` for newer versions)
134+
Start the stack with `docker-compose`.
123135

124136
```shell
125137
docker-compose up -d
126138
```
127139

128-
This will pulls the needed images, and starts Plone.
140+
This pulls the needed images and starts Plone.
141+
129142

130143
## Access Plone via Browser
131144

132145
After startup, go to `http://plone.localhost/` and you should see the site.
133146

147+
134148
## Increase the number of backends
135149

136-
To use two containers for backend, run `docker-compose` with `--scale`
150+
To use two containers for backend, run `docker-compose` with `--scale`.
137151

138152
```shell
139153
docker-compose up --scale backend=2
140154
```
141155

156+
142157
## Shutdown and cleanup
143158

144-
The command docker-compose down removes the containers and default network, but preserves the Plone database.
159+
The command `docker-compose down` removes the containers and default network, but preserves the Plone database.
145160

146-
The command docker-compose down --volumes removes the containers, default network, and the Plone database.
161+
The command `docker-compose down --volumes` removes the containers, default network, and the Plone database.

docs/install/containers/examples/nginx-volto-plone-zeo.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
# Nginx, Frontend, Backend, ZEO
1+
---
2+
html_meta:
3+
"description": "Very simple Plone 6 setup with only one or more backend instances accessing a ZEO server and data being persisted in a Docker volume."
4+
"property=og:description": "Very simple Plone 6 setup with only one or more backend instances accessing a ZEO server and data being persisted in a Docker volume."
5+
"property=og:title": "Nginx, Frontend, Backend, ZEO container example"
6+
"keywords": "Plone 6, Container, Docker, Nginx, Frontend, Backend, ZEO"
7+
---
8+
9+
# Nginx, Frontend, Backend, ZEO container example
210

311
Very simple setup with only one or more backend instances accessing a ZEO server and data being persisted in a Docker volume.
412

13+
514
## Setup
615

7-
Create an empty project directory named `nginx-volto-plone-zeo`
16+
Create an empty project directory named `nginx-volto-plone-zeo`.
817

918
```shell
1019
mkdir nginx-volto-plone-zeo
@@ -16,6 +25,7 @@ Change into your project directory.
1625
cd nginx-volto-plone-zeo
1726
```
1827

28+
1929
### nginx configuration
2030

2131
Add a `default.conf` that will be used by the nginx image:
@@ -65,9 +75,10 @@ server {
6575
}
6676
```
6777

68-
### Service configuration with docker-compose
6978

70-
Now, let's create a `docker-compose.yml` file:
79+
### Service configuration with `docker-compose`
80+
81+
Now let's create a `docker-compose.yml` file:
7182

7283
```yaml
7384
version: "3"
@@ -114,30 +125,34 @@ volumes:
114125
data: {}
115126
```
116127
128+
117129
## Build the project
118130
119-
Start the stack with `docker-compose` (or `docker compose` for newer versions)
131+
Start the stack with `docker-compose`.
120132

121133
```shell
122134
docker-compose up -d
123135
```
124136

125-
This will pulls the needed images, and starts Plone.
137+
This pulls the needed images and starts Plone.
138+
126139

127140
## Access Plone via Browser
128141

129142
After startup, go to `http://plone.localhost/` and you should see the site.
130143

144+
131145
## Increase the number of backends
132146

133-
To use two containers for backend, run `docker-compose` with `--scale`
147+
To use two containers for the backend, run `docker-compose` with `--scale`.
134148

135149
```shell
136150
docker-compose up --scale backend=2
137151
```
138152

153+
139154
## Shutdown and cleanup
140155

141-
The command docker-compose down removes the containers and default network, but preserves the Plone database.
156+
The command `docker-compose down` removes the containers and default network, but preserves the Plone database.
142157

143-
The command docker-compose down --volumes removes the containers, default network, and the Plone database.
158+
The command `docker-compose down --volumes` removes the containers, default network, and the Plone database.

docs/install/containers/examples/nginx-volto-plone.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
# Nginx, Frontend, Backend
1+
---
2+
html_meta:
3+
"description": "Very simple Plone 6 setup with only one backend and data being persisted in a Docker volume."
4+
"property=og:description": "Very simple Plone 6 setup with only one backend and data being persisted in a Docker volume."
5+
"property=og:title": "Nginx, Frontend, Backend container example"
6+
"keywords": "Plone 6, Container, Docker, Nginx, Frontend, Backend"
7+
---
8+
9+
# Nginx, Frontend, Backend container example
210

311
Very simple setup with only one backend and data being persisted in a Docker volume.
412

13+
514
## Setup
615

716
Create an empty project directory named `nginx-volto-plone`
@@ -16,6 +25,7 @@ Change into your project directory.
1625
cd nginx-volto-plone
1726
```
1827

28+
1929
### nginx configuration
2030

2131
Add a `default.conf` that will be used by the nginx image:
@@ -65,9 +75,10 @@ server {
6575
}
6676
```
6777

68-
### Service configuration with docker-compose
6978

70-
Now, let's create a `docker-compose.yml` file:
79+
### Service configuration with `docker-compose`
80+
81+
Now let's create a `docker-compose.yml` file:
7182

7283
```yaml
7384
version: "3"
@@ -105,22 +116,25 @@ volumes:
105116
data: {}
106117
```
107118
119+
108120
## Build the project
109121
110-
Start the stack with `docker-compose` (or `docker compose` for newer versions)
122+
Start the stack with `docker-compose`.
111123

112124
```shell
113125
docker-compose up -d
114126
```
115127

116-
This will pulls the needed images, and starts Plone.
128+
This pulls the needed images and starts Plone.
129+
117130

118131
## Access Plone via Browser
119132

120133
After startup, go to `http://plone.localhost/` and you should see the site.
121134

135+
122136
## Shutdown and cleanup
123137

124-
The command docker-compose down removes the containers and default network, but preserves the Plone database.
138+
The command `docker-compose down` removes the containers and default network, but preserves the Plone database.
125139

126-
The command docker-compose down --volumes removes the containers, default network, and the Plone database.
140+
The command `docker-compose down --volumes` removes the containers, default network, and the Plone database.

0 commit comments

Comments
 (0)