This Docker image runs the core system of the XStudio server. This server includes a servlet container (Tomcat) listening on port 8080 in HTTP (and optionally on port 8443 in HTTPS if you provide an optional certificate).
The server will expose interface for:
The tag (i.e. "6beta4") represents the version of XStudio installed. Please refer to https://www.xqual.com/documentation/install/install_xstudio_docker.html#Versions to use a version compatible with the xqual/xstudio-mariadb image's version.
The docker needs a few parameters to be customized with your own preferences:
| Parameter | Description | Example |
|---|---|---|
| MYSQL_DATABASE | Name of the database that will host XStudio's data | xstudiodb |
| MYSQL_USER | Name of the MariaDB account that XStudio will use | xstudio |
| MYSQL_PASSWORD_ENCRYPTED | Encrypted password of the MariaDB account that XStudio will use. You can encrypt a clear password using our REST API service, however we advise to start with the default value which is 560B599C2331BE79C3ADD6621DBE8BDC which corresponds to the user xstudio with clear password xstudiopwd) | - |
| SERVER_NAME | Name of the server | xstudio-prod1.acme.com |
| SERVER_PROTOCOL | Protocol to connect to the server | http (or https if you provide a SSL certificate) |
| SERVER_PORT | Port to connect to the server | 8080 (or 8443 if you provide a SSL certificate) |
| LICENSE_KEY (opt.) | The license key you purchased from us. If you do not provide a license key, the server will stay in community version with all its limitations | - |
| CUSTOMER_REPOSITORY (opt.) | A URL where you can store your custom visuals and/or SSL certificate | http://acme-server.com/docker |
| CUSTOMER_INSTANCE_NAME (opt.) | Name of the folder on the customer repository that will store the custom visuals and/or SSL certificate | acme_prod_1 |
| SSL_KEYSTORE_ALIAS (opt.) | The alias to use with the Java Keystore containing the certificate for the SSL access | 1 |
| SSL_KEYSTORE_FILENAME (opt.) | The file name of the java Keystore containing the certificate for the SSL access | acme.jks |
| SSL_KEYSTORE_PASSWORD (opt.) | The password to use with the Java Keystore containing the certificate for the SSL access | acmepwd |
As you can see, this docker image can take a few optional parameters which are used only if you wish to:
Based on the above example values, the image can be run in a container using the command:
docker run --name xstudio-tomcat-container
-e MYSQL_DATABASE=xstudio_db
-e MYSQL_USER=xstudio
-e MYSQL_PASSWORD_ENCRYPTED=560B599C2331BE79C3ADD6621DBE8BDC
-e SERVER_NAME=xstudio-prod1.acme.com
-e SERVER_PROTOCOL=http
-e SERVER_PORT=8080
-e LICENSE_KEY=<license_key>
-e CUSTOMER_REPOSITORY=http://acme-server.com/docker
-e CUSTOMER_INSTANCE_NAME=acme_prod_1
-e SSL_KEYSTORE_ALIAS=1
-e SSL_KEYSTORE_FILENAME=acme.jks
-e SSL_KEYSTORE_PASSWORD=acmepwd
xqual/xstudio-tomcat:6beta4
If you wish to customize your XStudio instance with some custom visuals and a SSL certificate, your repository must be accessible from the docker image. Based on the above example, the repository should serve the files this way:
You can include only the visuals you are interested in.
Here is a description of each files your repository can host:
| Filename | Description | Requirements |
|---|---|---|
| icon.png | Will be used as the JNLP client's icon | PNG file with a dimension 16x16 pixels |
| logo.png | Will be used for instance in the header of the paper reports | PNG file with a dimension preferably not exceeding 300x300 pixels |
| splashscreen.png | Will be used as splashscreen of the JNLP client | PNG file with a dimension preferably not exceeding 700x700 pixels |
| custom.app_title.txt | Will be used as application title in the JNLP client's header | Text file containing only a one-line text (do NOT add a new line feed at the end) |
| custom.report.docx_header.txt | Will be used in the header of the .docx paper reports | Text file containing only a one-line text (do NOT add a new line feed at the end) |
It is not really useful to run this container by itself though. You should use Docker-compose to run it as part as an integrated instance. More details here: https://www.xqual.com/documentation/install/install_xstudio_docker.html
Content type
Image
Digest
sha256:15eb34a66…
Size
2.9 GB
Last updated
18 days ago
docker pull xqual/xstudio-tomcat:v15sp2