scenari/suite-starter repository overview

⁠Supported tags and respective Dockerfile links

• 6, 6.5, latest⁠
• 6.4⁠
• 6.3⁠
• 6.2⁠

⁠How to use this image.

⁠Start a SCENARIsuite-starter server instance

To run the default SCENARIsuite-starter server in the background, use the following command:

$ docker run --name SCENARIsuite-starter -d --publish 8080:8080 -e SC_PUBLIC_URL=http://127.0.0.1:8080/scsuitestr scenari/suite-starter:latest

You can test it by visiting http://127.0.0.1:8080/scsuitestr/& in a browser (login/password: admin/admin).

⁠Environment Variables

⁠JT_JAVA_OPTS

Options for Java (Example for set JVM Memory, 1024MB by default). By default: -Xms1024m -Xmx1024m

⁠SC_WEBAPP_NAME

Name of the webapp. By default: scsuitestr63

⁠SC_WEBAPP_DISPLAY_NAME

Display name. By default: SCENARIsuite-starter

⁠SC_LANG

App Language fr or en . By default: fr

⁠SC_PUBLIC_URL

SC_PUBLIC_URL is mandatory. User access URL to the webapp. Example: SC_PUBLIC_URL=http://mydomain:8080/$SC_WEBAPP_NAME

⁠SC_USER_SYSTEM_PASS

Set the password for the "system" user. By default it is automatically generated at each start.

⁠SC_USER_SUPERADMIN_PASS

Set the password for the "superadmin" user. By default it is automatically generated at each start.

⁠SC_DISPLAY_GEN_PASSWORD

Set to true for display generated password in docker logs. By default: false (since version 6.3)

⁠SC_LDAP_ENABLED

Set to true for enable LDAP. By default: false

⁠SC_LDAP_URL

Set URL of your LDAP. Example: ldaps://example.org

⁠SC_LDAP_BASENAME

Set BaseName of your LDAP. Example: ou=people,dc=example,dc=org

⁠SC_LDAP_SEARCH

Set SearchPattern of your LDAP. Example: (&(objectClass=Person)(\|(sn={0})(givenName={0})))

You need to escape each character |.

⁠SC_LDAP_SEARCH_ACCOUNT_LOGIN

Set a Login if you do not use Anonymous authentication. Example: uid=scenari_search,ou=service,dc=example,dc=org

⁠SC_LDAP_SEARCH_ACCOUNT_PASSWORD

Set a Password if you do not use Anonymous authentication. Example: ExamplePasswordChangeMe

⁠SC_HOME_PWA

Set to true for enable PWA. By default: false (since version 6.5.3)

⁠SC_HOME_QRCODE

Set to true for enable QR Code. By default: false (since version 6.5.3)

⁠SC_LT_URL

Set a URL for Language Tool. Example: https://api.languagetool.org or https://api.languagetoolplus.com (since version 6.2.3)

⁠SC_LT_MAX_LENGTH

Set the Max Length by request to Language Tool. Example: 20000 (since version 6.2.3)

⁠SC_LT_API_USER

If you use Language Tool Premium , set SC_LT_API_USER with your Username. (since version 6.2.3)

⁠SC_LT_API_KEY

If you use Language Tool Premium , set SC_LT_API_KEY with your API Key. (since version 6.2.3)

⁠Path

Each path need read/write permissions for UID 3000.

• Jetty logs: /var/log/jetty (/var/log/jetty9 for 6.1 and before)
• Scenari data: /var/lib/scenari (By default a Volume)
• Scenari logs: /var/log/scenari

⁠Backup / Restore / CheckDB

⁠Backup

Steps:

• Launch the command sc_backup pre in SCENARIsuite-starter container. Example: docker exec SCENARIsuite-starter sc_backup pre
• Backup the volume for Scenari data /var/lib/scenari
• Launch the command sc_backup post in SCENARIsuite-starter container. Example: docker exec SCENARIsuite-starter sc_backup post

⁠Restore

Steps:

• Stop your SCENARIsuite-starter container
• Copy your backup in the volume for Scenari data /var/lib/scenari
• Replace the content of directory /var/lib/scenari/data/prl-chain/db by content of directory /var/lib/scenari/backup/prl-chain/dbBkp
• Start your SCENARIsuite-starter container

⁠CheckDB

Health check for the Chain DB, call this command once a days. (since version 6.2.3)

• Launch the command sc_backup check_chain_db in SCENARIsuite-starter container. Example: docker exec SCENARIsuite-starter sc_backup check_chain_db

⁠Documentations

https://doc.scenari.software/[email protected]/linux/⁠