Skip to content

Commit 57f62b7

Browse files
Apply suggestions from code review
1 parent cefde36 commit 57f62b7

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

bonita/content.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Bonita is an open-source business process management and workflow suite created
1414
$ docker run --name bonita -d -p 8080:8080 %%IMAGE%%
1515
```
1616

17-
This will start a container running [Bonita runtime](https://documentation.bonitasoft.com/bonita/2022.1/tomcat-bundle): a Tomcat bundle with Bonita Engine + Bonita Portal. With no environment variables specified, it's as if you have launched the bundle on your host using startup.{sh|bat} (with security hardening on REST and HTTP APIs, cf Security part). Bonita uses a H2 database here.
17+
This will start a container running [Bonita runtime](https://documentation.bonitasoft.com/bonita/latest/tomcat-bundle): a Tomcat bundle with Bonita Engine + Bonita Portal. With no environment variables specified, it's as if you have launched the bundle on your host using startup.{sh|bat} (with security hardening on REST and HTTP APIs, cf Security part). Bonita uses a H2 database here.
1818

1919
You can access the Bonita Portal on http://localhost:8080/bonita and login using the default credentials: install / install
2020

@@ -28,16 +28,16 @@ You can work with either a PostgreSQL Container, or PostgreSQL as an installed s
2828
### PostgreSQL Container
2929

3030

31-
From Bonita 2022.1 onwards, the Bonita docker image does not include configuration scripts for Postgres
31+
From Bonita 2022.1 onwards, the Bonita docker image does not include configuration scripts to automatically create databases and users anymore.
3232

3333

3434
Therefore the PostgreSQL container needs to be configured to work with Bonita before starting the Bonita container.
35-
The configuration of a PostgreSQL database to work with Bonita is described in detail in the xref:database-configuration.adoc[database configuration page]. +
35+
The configuration of a PostgreSQL database to work with Bonita is described in details in the [database configuration page](https://documentation.bonitasoft.com/bonita/latest/runtime/database-configuration#postgres_setup). +
3636
Alternatively, Bonita provides a preconfigured [PostgreSQL image](https://hub.docker.com/r/bonitasoft/bonita-postgres) on docker-hub. +
3737
You can run the image with the following command:
3838

3939
```
40-
docker run --name mydbpostgres -h <hostname> -v <your-bonita-license-folder>:/opt/bonita_lic/ -d bonitasoft/bonita-postgres:12.6
40+
docker run --name mydbpostgres -h <hostname> -d bonitasoft/bonita-postgres:12.6
4141
```
4242

4343
This image is built from the following [GitHub repository](https://github.com/Bonitasoft-Community/bonita-database-docker/tree/main/postgres/12), which can be further adapted/customized to suit your needs.
@@ -51,11 +51,10 @@ Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml
5151
* Replace `<hostname>` with the one used in the licence generation command
5252
* leave double `$$` untouched
5353

54-
Run `docker-compose up`, wait for it to initialize completely, and visit `+http://localhost:8080+`, or `+http://host-ip:8080+` (as appropriate).
5554

5655
### PostgreSQL as an installed service
5756

58-
If you don't want to run your database in a docker container, the following file `env.txt` needs to be configured and provided to the docker run command:
57+
If you don't want to run your database in a docker container, the following `env.txt` file needs to be configured and provided to the docker run command:
5958

6059
```
6160
DB_VENDOR=postgres
@@ -81,7 +80,7 @@ docker run --name=bonita -h <hostname> -e "TENANT_LOGIN=tech_user" -e "TENANT_PA
8180

8281
Now you can access the Bonita Runtime on localhost:8080/bonita and login using: tech_user / secret
8382

84-
## Where data is stored
83+
## Where data are stored
8584

8685
Bonita uses tomcat that writes file to a working directory and a temp directory.
8786

@@ -145,7 +144,7 @@ This optional environment variable allows to activate/deactivate writing Tomcat
145144
In practice, it is only useful when mounting a volume to the aforementioned directory. Default value is *false*.
146145

147146
### ACCESSLOGS_PATH
148-
If `ACCESSLOGS_FILES_ENABLED=true`, this optional environment variable overrides the default path to of the access log file.
147+
If `ACCESSLOGS_FILES_ENABLED=true`, this optional environment variable overrides the default path to the access log files.
149148
Default value is */opt/bonita/logs*.
150149

151150
### ACCESSLOGS_PATH_APPEND_HOSTNAME
@@ -157,7 +156,7 @@ If `ACCESSLOGS_FILES_ENABLED=true`, this optional environment variable allows to
157156

158157
### HTTP_MAX_THREADS
159158
This optional environment variable allows to specify the maximum Http thread number Tomcat will use to serve HTTP/1.1 requests. Directly modifies the *maxThreads* parameter in the *server.xml* file of the Tomcat inside the docker container.
160-
More information on the usefulness of this parameter can be found https://tomcat.apache.org/tomcat-9.0-doc/config/http.html[here]. Default value is *20*.
159+
More information on the usefulness of this parameter can be found [here](https://tomcat.apache.org/tomcat-9.0-doc/config/http.html). Default value is *20*.
161160

162161
### JAVA_OPTS
163162
This optional environment variable is used to customize JAVA_OPTS. The default value is -Xms1024m -Xmx1024m -XX:MaxPermSize=256m.
@@ -171,7 +170,7 @@ These variables are optional, used in conjunction to configure the bonita image
171170

172171
### DB_NAME, DB_USER, DB_PASS
173172

174-
These variables are used in conjunction to create a new user, set that user's password, and create the bonita database.
173+
These variables are used in conjunction to define how Bonita should access its database for internal functioning.
175174

176175
`DB_NAME` default value is bonitadb.
177176

@@ -181,7 +180,8 @@ These variables are used in conjunction to create a new user, set that user's pa
181180

182181
### BIZ_DB_NAME, BIZ_DB_USER, BIZ_DB_PASS
183182

184-
These variables are used in conjunction to create a new user, set that user's password and create the bonita business database.
183+
184+
These variables are used in conjunction to define how Bonita should access the [Business Data](https://documentation.bonitasoft.com/bonita/latest/data/define-and-deploy-the-bdm) database.
185185

186186
`BIZ_DB_NAME` default value is businessdb.
187187

@@ -192,34 +192,38 @@ These variables are used in conjunction to create a new user, set that user's pa
192192

193193
## Logger configuration
194194

195+
**Since 2022.1**
196+
195197
The logger can be configured by mounting a volume on folder `/opt/bonita/conf/logs` containing the configuration files.
196198

197199
the volume must contain the 2 files
198200
[log4j2-loggers.xml](https://raw.githubusercontent.com/bonitasoft/bonita-distrib/7.14.0/tomcat-resources/tomcat-distrib-for-bonita/src/main/resources/tomcat/server/conf/log4j2-loggers.xml)
199201
and
200-
[log4j2-appenders.xml](https://raw.githubusercontent.com/bonitasoft/bonita-distrib/7.14.0/docker/files/log4j2/log4j2-appenders.xml)
202+
[log4j2-appenders.xml](https://raw.githubusercontent.com/bonitasoft/bonita-distrib/7.14.0/docker/files/log4j2/log4j2-appenders.xml).
203+
204+
Any change made to one of this 2 files is automatically hot-reloaded and taken into account immediately.
201205

202206
## Security
203207

204208
This Docker image activates both static and dynamic authorization checks by default on REST API. To be consistent, it also deactivates the HTTP API.
205209

206210
- REST API authorization
207211

208-
- [Static authorization checking](https://documentation.bonitasoft.com/bonita/2022.1/rest-api-authorization#static_authorization)
212+
- [Static authorization checking](https://documentation.bonitasoft.com/bonita/latest/rest-api-authorization#static_authorization)
209213

210214
- [HTTP API](https://documentation.bonitasoft.com/bonita/2022.1/rest-api-authorization#_activating_and_deactivating_authorization)
211215

212216
For specific needs you can override this behavior by setting HTTP_API to true:
213217

214218
```console
215-
$ docker run -e HTTP_API=true --name bonita -d -p 8080:8080 %%IMAGE%%
219+
$ docker run -e HTTP_API=true -e HTTP_API_PASSWORD="My-Cust0m_S3cR3T" --name bonita -d -p 8080:8080 %%IMAGE%%
216220
```
217221

218-
## Update from an earlier version of
222+
## Update from an earlier version of Bonita
219223

220-
For updating from a version before 7.10.0, please refere to the documention
224+
For updating from a version before 7.10.0, please refer to the [documentation](https://documentation.bonitasoft.com/bonita/latest/version-update/migrate-from-an-earlier-version-of-bonita)
221225

222-
- Stop the container to perform a backup
226+
- Stop the container to perform a database backup
223227

224228
```console
225229
$ docker stop bonita
@@ -239,7 +243,7 @@ For updating from a version before 7.10.0, please refere to the documention
239243
$ pg_dump -O -x -h 172.17.0.26 -U postgres bonitadb > /tmp/bonitadb.sql
240244
```
241245

242-
Note that businessdb won't be updated with the update tool but you may want to also backup/move it.
246+
Note that businessdb won't be updated by the update tool but you may want to also backup/move it.
243247

244248
- Load the dump
245249

@@ -264,7 +268,7 @@ For updating from a version before 7.10.0, please refere to the documention
264268
$ cd bonita-update-tool-3.0.0
265269
```
266270

267-
edit the update tool config to point towards the copy of bonita home and db
271+
edit the update tool configuration file `Config.properties` to point towards the database.
268272

269273
```console
270274
$ vim Config.properties
@@ -285,7 +289,7 @@ For updating from a version before 7.10.0, please refere to the documention
285289
$ ./bonita-update-tool
286290
```
287291

288-
- Launch the new container pointing towards the copy of DB and filesystem
292+
- Launch the new container pointing towards the copy of the database.
289293

290294
```console
291295
$ docker run --name=bonita --link mydbpostgres:postgres -e "DB_NAME=newbonitadb" -e "DB_USER=newbonitauser" -e "DB_PASS=newbonitapass" -d -p 8081:8080 %%IMAGE%%:2022.1-u0

0 commit comments

Comments
 (0)