Skip to content

Commit 2778ffd

Browse files
Convertigo: add tips to readme (#2059)
1 parent e214f2e commit 2778ffd

File tree

1 file changed

+55
-4
lines changed

1 file changed

+55
-4
lines changed

convertigo/content.md

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ $ docker run -d --name C8O --link [mysql-container]:mysql -p 28080:28080
5353
-Dconvertigo.engine.billing.persistence.jdbc.username=[username for the c8oAnalytics db] \
5454
-Dconvertigo.engine.billing.persistence.jdbc.password=[password for specified db user] \
5555
-Dconvertigo.engine.billing.persistence.jdbc.url=jdbc:mysql://mysql:3306/c8oAnalytics" \
56-
convertigo
56+
%%IMAGE%%
5757
```
5858

5959
## Where is Convertigo MBaaS server storing deployed projects
@@ -64,7 +64,26 @@ Projects are deployed in the Convertigo workspace, a simple file system director
6464
$ docker run --name C8O -v $(pwd):/workspace -d -p 28080:28080 %%IMAGE%%
6565
```
6666

67-
You can share the same workspace by all Convertigo containers. This this case, when you deploy a project on a Convertigo container, it will be seen by others. This is the best way to build multi-instance load balanced Convertigo server farms.
67+
You can share the same workspace by all Convertigo containers. In this case, when you deploy a project on a Convertigo container, it will be seen by others. This is the best way to build multi-instance load balanced Convertigo server farms.
68+
69+
**Be sure to have a really fast file sharing between instances !!!**
70+
71+
To avoid log and cache mixing, you have to add 2 variables for instance specific paths:
72+
73+
```console
74+
-Dconvertigo.engine.cache_manager.filecache.directory=/workspace/cache/[instance name]
75+
-Dconvertigo.engine.log4j.appender.CemsAppender.File=/workspace/logs/[instance name]/engine.log
76+
```
77+
78+
## Make image with pre-deployed projects
79+
80+
If you want to make a vertical image ready to start with your application inside, you have to have your built projects **.car** files next to your `Dockerfile`:
81+
82+
```console
83+
FROM %%IMAGE%%
84+
COPY myProject.car /usr/local/tomcat/webapps/convertigo/WEB-INF/default_user_workspace/projects/
85+
COPY myDependency.car /usr/local/tomcat/webapps/convertigo/WEB-INF/default_user_workspace/projects/
86+
```
6887

6988
## Migrate from an earlier version of Convertigo
7089

@@ -78,15 +97,15 @@ The default administration account of a Convertigo serveur is **admin** / **admi
7897

7998
These accounts can be configured through the *administration console* and saved in the **workspace**.
8099

81-
### `CONVERTIGO_ADMIN_USER` and `CONVERTIGO_ADMIN_PASSWORD` variables
100+
### `CONVERTIGO_ADMIN_USER` and `CONVERTIGO_ADMIN_PASSWORD` Environment variables
82101

83102
You can change the default administration account :
84103

85104
```console
86105
$ docker run -d --name C8O -e CONVERTIGO_ADMIN_USER=administrator -e CONVERTIGO_ADMIN_PASSWORD=s3cret -p 28080:28080 %%IMAGE%%
87106
```
88107

89-
### `CONVERTIGO_TESTPLATFORM_USER` and `CONVERTIGO_TESTPLATFORM_PASSWORD` variables
108+
### `CONVERTIGO_TESTPLATFORM_USER` and `CONVERTIGO_TESTPLATFORM_PASSWORD` Environment variables
90109

91110
You can lock the **testplatform** by setting the account :
92111

@@ -104,6 +123,8 @@ Add any *Java JVM* options such as -D[something] :
104123
$ docker run -d --name C8O -e JAVA_OPTS="-DjvmRoute=server1" -p 28080:28080 %%IMAGE%%
105124
```
106125

126+
[Here the list of convertigo specific properties](https://www.convertigo.com/documentation/latest/operating-guide/appendixes/#list-of-convertigo-java-system-properties) (don't forget the `-Dconvertigo.engine.` prefix).
127+
107128
## `JXMX` Environment variable
108129

109130
Convertigo tries to allocate this amount of memory in the container and will automatically reduce it until the value is compatible for the Docker memory constraints. Once the best value found, it is used as `-Xmx=${JXMX}m` parameter for the JVM.
@@ -136,6 +157,36 @@ The default `COOKIE_SECURE` value is `false` and can be defined :
136157
$ docker run -d --name C8O -e COOKIE_SECURE="true" -p 28080:28080 %%IMAGE%%
137158
```
138159

160+
## `COOKIE_SAMESITE` Environment variable
161+
162+
Allow to configure the *SameSite* parameter for generated cookies. Can be empty, `none`, `lax` or `strict`.
163+
164+
The default `COOKIE_SAMESITE` value is *empty* and can be defined this way:
165+
166+
```console
167+
$ docker run -d --name C8O -e COOKIE_SAMESITE=lax -p 28080:28080 %%IMAGE%%
168+
```
169+
170+
## `SESSION_TIMEOUT` Environment variable
171+
172+
Allow to configure the default Tomcat *session-timeout* in minutes. This value is used for non-project calls (Administration console, Fullsync...). This value is overridden by each projects' calls (Sequence, Transaction ...).
173+
174+
The default `SESSION_TIMEOUT` value is *30* and can be defined this way:
175+
176+
```console
177+
$ docker run -d --name C8O -e SESSION_TIMEOUT=5 -p 28080:28080 %%IMAGE%%
178+
```
179+
180+
## `DISABLE_SUDO` Environment variable
181+
182+
The image include *sudo* command line, configured to allow the *convertigo* user to use it without password and to perform some *root* action inside the container. This variable allow to disable this permission.
183+
184+
The default `DISABLE_SUDO` value is *empty* and can be defined this way:
185+
186+
```console
187+
$ docker run -d --name C8O -e DISABLE_SUDO=true -p 28080:28080 %%IMAGE%%
188+
```
189+
139190
## Pre configurated Docker compose stack
140191

141192
You can use this [stack](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo MBaaS server with FullSync repository and MySQL analytics in a few command lines.

0 commit comments

Comments
 (0)