scenari/lti-suite repository overview

⁠Supported tags and respective Dockerfile links

• 2, 2.0, latest⁠
• 1, 1.0⁠

⁠How to use this image.

⁠Start a LTI-suite server instance

To run the default LTI-suite server in the background, use the following command:

$ docker run --name LTI-suite -d --publish 8080:8080 -e SC_MARIADB_HOST=mariadb -e SC_MARIADB_USER=ltisuite -e SC_MARIADB_DATABASE=ltisuite -e SC_MARIADB_PASSWORD=changeMe -e SC_WEBAPP_NAME=ltisuite -e SC_PUBLIC_URL=http://127.0.0.1:8080/ltisuite scenari/lti-suite:latest

You can test it by visiting http://127.0.0.1:8080/ltisuite/& 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: ltisuite10

⁠SC_WEBAPP_DISPLAY_NAME

Display name. By default: LTI-suite

⁠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

⁠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_LT_URL

Set a URL for Language Tool. Example: https://api.languagetool.org or https://api.languagetoolplus.com

⁠SC_LT_MAX_LENGTH

Set the Max Length by request to Language Tool. Example: 20000

⁠SC_LT_API_USER

If you use Language Tool Premium , set SC_LT_API_USER with your Username.

⁠SC_LT_API_KEY

If you use Language Tool Premium , set SC_LT_API_KEY with your API Key.

⁠SC_MARIADB_HOST

SC_MARIADB_HOST is mandatory. Hostname for the MariaDB server. Example: db.domain.local

⁠SC_MARIADB_PORT

Set Port for MariaDB server. By default: 3306

⁠SC_MARIADB_USER

Set Database Username for MariaDB server. By default value of MARIADB_USER variable.

⁠SC_MARIADB_DATABASE

Set Database Name for MariaDB server. By default value of MARIADB_DATABASE variable. The Database need to use Collation utf8mb4_bin.

⁠SC_MARIADB_PASSWORD

Set Database Password for MariaDB server. By default value of MARIADB_PASSWORD variable.

⁠Path

Each path need read/write permissions for UID 3000.

• Jetty logs: /var/log/jetty
• 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 LTI-suite container. Example: docker exec LTI-suite sc_backup pre
• Backup the volume for Scenari data /var/lib/scenari
• Launch the command sc_backup post in LTI-suite container. Example: docker exec LTI-suite sc_backup post

⁠Restore

Steps:

• Stop your LTI-suite 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 LTI-suite container

⁠CheckDB

Health check for the Chain DB, call this command once a days.

• Launch the command sc_backup check_chain_db in LTI-suite container. Example: docker exec LTI-suite sc_backup check_chain_db

⁠Documentations

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

⁠Docker compose example :

services:
  mariadb:
    image: mariadb:11.8
    stop_grace_period: 120s
    restart: always
    environment:
      - MARIADB_AUTO_UPGRADE=1
      - MARIADB_ROOT_PASSWORD=changeRootPassword
      - MARIADB_USER=ltisuite
      - MARIADB_DATABASE=ltisuite
      - MARIADB_PASSWORD=changeMe
    volumes:
      - mariadbdata:/var/lib/mysql

  ltisuite:
    depends_on:
      - mariadb
    image: scenari/lti-suite:2.0
    stop_grace_period: 120s
    restart: always
    environment:
      - SC_PUBLIC_URL=http://127.0.0.1:8080/ltisuite
      - SC_WEBAPP_NAME=ltisuite
      - SC_MARIADB_HOST=mariadb
      - SC_MARIADB_USER=ltisuite
      - SC_MARIADB_DATABASE=ltisuite
      - SC_MARIADB_PASSWORD=changeMe
    volumes:
      - scenaridata:/var/lib/scenari
      - jettylog:/var/log/jetty
      - scenarilog:/var/log/scenari
    ports:
      - 8080:8080

volumes:
  mariadbdata: {}
  scenaridata: {}
  scenarilog: {}
  jettylog: {}