Skip to content

Commit 297e02e

Browse files
Run update.sh
1 parent 2778ffd commit 297e02e

File tree

1 file changed

+54
-3
lines changed

1 file changed

+54
-3
lines changed

convertigo/README.md

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,26 @@ Projects are deployed in the Convertigo workspace, a simple file system director
111111
$ docker run --name C8O -v $(pwd):/workspace -d -p 28080:28080 convertigo
112112
```
113113

114-
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.
114+
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.
115+
116+
**Be sure to have a really fast file sharing between instances !!!**
117+
118+
To avoid log and cache mixing, you have to add 2 variables for instance specific paths:
119+
120+
```console
121+
-Dconvertigo.engine.cache_manager.filecache.directory=/workspace/cache/[instance name]
122+
-Dconvertigo.engine.log4j.appender.CemsAppender.File=/workspace/logs/[instance name]/engine.log
123+
```
124+
125+
## Make image with pre-deployed projects
126+
127+
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`:
128+
129+
```console
130+
FROM convertigo
131+
COPY myProject.car /usr/local/tomcat/webapps/convertigo/WEB-INF/default_user_workspace/projects/
132+
COPY myDependency.car /usr/local/tomcat/webapps/convertigo/WEB-INF/default_user_workspace/projects/
133+
```
115134

116135
## Migrate from an earlier version of Convertigo
117136

@@ -125,15 +144,15 @@ The default administration account of a Convertigo serveur is **admin** / **admi
125144

126145
These accounts can be configured through the *administration console* and saved in the **workspace**.
127146

128-
### `CONVERTIGO_ADMIN_USER` and `CONVERTIGO_ADMIN_PASSWORD` variables
147+
### `CONVERTIGO_ADMIN_USER` and `CONVERTIGO_ADMIN_PASSWORD` Environment variables
129148

130149
You can change the default administration account :
131150

132151
```console
133152
$ docker run -d --name C8O -e CONVERTIGO_ADMIN_USER=administrator -e CONVERTIGO_ADMIN_PASSWORD=s3cret -p 28080:28080 convertigo
134153
```
135154

136-
### `CONVERTIGO_TESTPLATFORM_USER` and `CONVERTIGO_TESTPLATFORM_PASSWORD` variables
155+
### `CONVERTIGO_TESTPLATFORM_USER` and `CONVERTIGO_TESTPLATFORM_PASSWORD` Environment variables
137156

138157
You can lock the **testplatform** by setting the account :
139158

@@ -151,6 +170,8 @@ Add any *Java JVM* options such as -D[something] :
151170
$ docker run -d --name C8O -e JAVA_OPTS="-DjvmRoute=server1" -p 28080:28080 convertigo
152171
```
153172

173+
[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).
174+
154175
## `JXMX` Environment variable
155176

156177
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.
@@ -183,6 +204,36 @@ The default `COOKIE_SECURE` value is `false` and can be defined :
183204
$ docker run -d --name C8O -e COOKIE_SECURE="true" -p 28080:28080 convertigo
184205
```
185206

207+
## `COOKIE_SAMESITE` Environment variable
208+
209+
Allow to configure the *SameSite* parameter for generated cookies. Can be empty, `none`, `lax` or `strict`.
210+
211+
The default `COOKIE_SAMESITE` value is *empty* and can be defined this way:
212+
213+
```console
214+
$ docker run -d --name C8O -e COOKIE_SAMESITE=lax -p 28080:28080 convertigo
215+
```
216+
217+
## `SESSION_TIMEOUT` Environment variable
218+
219+
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 ...).
220+
221+
The default `SESSION_TIMEOUT` value is *30* and can be defined this way:
222+
223+
```console
224+
$ docker run -d --name C8O -e SESSION_TIMEOUT=5 -p 28080:28080 convertigo
225+
```
226+
227+
## `DISABLE_SUDO` Environment variable
228+
229+
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.
230+
231+
The default `DISABLE_SUDO` value is *empty* and can be defined this way:
232+
233+
```console
234+
$ docker run -d --name C8O -e DISABLE_SUDO=true -p 28080:28080 convertigo
235+
```
236+
186237
## Pre configurated Docker compose stack
187238

188239
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)