Skip to content

Updated documentation for Convertigo 8.4.6 #2712

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.

Sign up for GitHub

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

Open
nicolas-albert wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated documentation for Convertigo 8.4.6 #2712

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions convertigo/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Before exposing the server to end users, change the default administration crede

## Connect Convertigo to a CouchDB database for FullSync (Convertigo EE only)

Convertigo FullSync uses Apache CouchDB 3.2.2 as its NoSQL repository.
Convertigo FullSync uses Apache CouchDB 3.5 as its NoSQL repository.

For modern Docker setups, prefer one of these approaches:

Expand Down Expand Up @@ -73,7 +73,7 @@ $ docker network create c8o-net
```

```console
$ docker run -d --name fullsync --network c8o-net couchdb:3.2.2
$ docker run -d --name fullsync --network c8o-net couchdb:3.5
```

```console
Expand Down Expand Up @@ -121,7 +121,7 @@ If the database runs in another container, connect both containers to the same u
Projects are deployed in the Convertigo workspace, a simple file system directory. You can map the docker container **/workspace** to your physical system by using:

```console
$ docker run --name C8O -v $(pwd):/workspace -d -p 28080:28080 %%IMAGE%%
$ docker run --name C8O -v $PWD:/workspace -d -p 28080:28080 %%IMAGE%%
```

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.
Expand Down Expand Up @@ -179,9 +179,11 @@ $ docker run --name C8O2 -v /my-shared-workspace:/workspace -d -p 28082:28080 \

At each container start, the image copies the contents of these workspace directories into the Convertigo web application before Tomcat starts:

- `/workspace/lib/` to `WEB-INF/lib/` for JAR files and their dependencies
- `/workspace/lib/` to `WEB-INF/lib/` for JAR files, their dependencies and native libraries
- `/workspace/classes/` to `WEB-INF/classes/` for compiled classes and resources

`WEB-INF/lib/` is also added to the JVM native library path, so a native library dropped in `/workspace/lib/` is found without extra configuration. This is the place for the libraries the server itself loads and cannot ship, such as the official JDBC driver of the database cache (`ojdbc.jar`, `mysql-connector.jar` or `db2jcc.jar`, replacing the placeholder of the same name) or the SAP Java Connector (`sapjco3.jar`, kept under this exact name, with its `libsapjco3.so`). A library used only by the projects (SQL connectors) belongs to `/workspace/libs/` instead; a `README.md` in each of these workspace directories gives the details.

The directory structure is preserved and overlays the files provided by the image; it does not remove existing web-application files. For classes, keep the package directory structure below `/workspace/classes/` (for example, `com/example/MyClass.class`). Restart or recreate the container after adding or updating these files. To remove an injected file, remove it from the workspace and recreate the container, since a restart does not delete files already copied into the web application.

For example, prepare a workspace and mount it into the container:
Expand All @@ -190,7 +192,7 @@ For example, prepare a workspace and mount it into the container:
$ mkdir -p workspace/lib workspace/classes/com/example
$ cp my-driver.jar workspace/lib/
$ cp build/classes/java/main/com/example/MyClass.class workspace/classes/com/example/
$ docker run --name C8O -v "$(pwd)/workspace:/workspace" -d -p 28080:28080 %%IMAGE%%
$ docker run --name C8O -v "$PWD/workspace:/workspace" -d -p 28080:28080 %%IMAGE%%
```

This is also useful when iterating on a custom Java extension without building a derived Convertigo image. Ensure that the mounted workspace is writable by the container at startup.
Expand All @@ -205,7 +207,7 @@ $ cp company-root-ca.crt custom-ca/
$ cp partner-intermediate-ca.crt custom-ca/
$ docker run --name C8O \
-e USE_SYSTEM_CA_CERTS=1 \
-v "$(pwd)/custom-ca:/certificates:ro" \
-v "$PWD/custom-ca:/certificates:ro" \
-d -p 28080:28080 convertigo
```

Expand Down Expand Up @@ -351,6 +353,8 @@ Log file still exists until you add the `LOG_FILE=false` environment variable :
$ docker run -d --name C8O -e LOG_STDOUT=true -e LOG_FILE=false -p 28080:28080 %%IMAGE%%
```

To ship these logs to a log platform (Elasticsearch / Kibana, Graylog, IBM Cloud Logs...), let the collector of your infrastructure read the container's standard output: the log format, the multi-line rule and a Fluent Bit example are described in the [Centralize the logs](https://doc.convertigo.com/documentation/latest/operating-guide/production-deployment-recommendations/#centralize-the-logs) section of the Operating Guide.

## `JXMX` Environment variable

Set `JXMX` to define the JVM heap size in MiB. The image then adds `-Xms128m -Xmx=${JXMX}m` to the JVM options. Make sure the container memory limit leaves room for memory outside the Java heap.
Expand Down
Loading