Skip to content
@YorkUITInnovation

YorkUITInnovation

README.md

Cria Installation Manual

These instructions are specific to installing Cria with a docker using a Virtual Machine provided by UIT SMS.

Virtual Machine (VM) Requirements

VCPU: 4

RAM: 16 GB

Drive: 1 TB Mount to /data

Important, use an attached drive (sdb) and not an NFS drive.

OS: Latest version of Ubuntu

Docker Installation

If docker has been installed using the predefined repositories in Ubuntu (sudo apt install), Male sure to remove the installation and all related folders.

Uninstall Docker Engine[1]

  1. Uninstall the Docker Engine, CLI, containerd, and Docker Compose packages:

    sudo apt-get purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin docker-ce-rootless-extras

  2. Images, containers, volumes, or custom configuration files on your host aren't automatically removed. To delete all images, containers, and volumes:

    sudo rm -rf /var/lib/docker
    sudo rm -rf /var/lib/containerd

sudo rm –rf /etc/docker

Install from package[2]

If you can't use Docker's apt repository to install Docker Engine, you can download the deb file for your release and install it manually. You need to download a new file each time you want to upgrade Docker Engine.

  1. Go to https://download.docker.com/linux/ubuntu/dists/
  2. Select your Ubuntu version in the list.
  3. Go to pool/stable/ and select the applicable architecture (amd64, armhf, arm64, or s390x).
  4. Download the following deb files for the Docker Engine, CLI, containerd, and Docker Compose packages:
  5. containerd.io_<version>_<arch>.deb
  6. docker-ce_<version>_<arch>.deb
  7. docker-ce-cli_<version>_<arch>.deb
  8. docker-buildx-plugin_<version>_<arch>.deb
  9. docker-compose-plugin_<version>_<arch>.deb
  10. Install the .deb packages. Update the paths in the following example to where you downloaded the Docker packages.
sudo dpkg -i ./containerd.io_<version>\_<arch>.deb \\
    ./docker-ce_<version>\_<arch>.deb \\  
    ./docker-ce-cli_<version>\_<arch>.deb \\  
    ./docker-buildx-plugin_<version>\_<arch>.deb \\  
    ./docker-compose-plugin_<version>\_<arch>.deb

The Docker daemon starts automatically.

Verify that the Docker Engine installation is successful by running the hello-world image.

sudo service docker start  
sudo docker run hello-world


This command downloads a test image and runs it in a container. When the container runs, it prints a confirmation message and exits.

You have now successfully installed and started Docker Engine.

Grant Docker privileges to non-sudo users

Docker only works with sudo. To allow non-sudo users to run docker commands, add the user(s) to the docker group.

sudo usermod -aG docker $USER

If the docker group does not exist on the system, create it

sudo groupadd docker

Move Docker default folder to the attached drive

The default drive space on UIT VMs (64GB) is too small to host docker. It is essential that the default docker folder (/var/lib/docker) be set in the attached drive.

  1. Create a folder within the attached drive
sudo mkdir /data/docker_data
  1. Stop the docker service
sudo service docker stop
  1. Rsync the default docker folder to /data/docker_data
rsync –avz /var/lib/docker /data/docker_data
  1. Create daemon.json and add path to new location. Nano is used here, but any editor will work.
sudo nano /etc/docker/daemon.json

{
   "data-root": "/data/docker_data/docker"  
}


Save the file ctrl-x and Y when prompted.

  1. Start docker engine
sudo service docker start

Cria Installation

Prepare docker-compose.yml file

  1. Create a folder named cria-prod and cd into it.
mkdir cria-prod
cd cria-prod
  1. Copy past the following code into a file named docker-compose.yml
  services:
    redis:
      image: 'docker.io/redis:latest'
      environment:
        REDIS_ARGS: "--requirepass root"
      ports:
        - '127.0.0.1:6379:6379'
      volumes:
        - ./redis_data/redis.conf:/usr/local/etc/redis/redis.conf
    # Cria-Front MySQL
    mysql:
      image: 'docker.io/mysql:8.4'
      command: [ 'mysqld','--mysql-native-password=ON' ]
      restart: always
      environment:
        MYSQL_ROOT_PASSWORD: cria
      healthcheck:
        test: mysqladmin ping -h 127.0.0.1 -uroot --password=$$MYSQL_ROOT_PASSWORD
        start_period: 1s
        interval: 5s
        timeout: 5s
        retries: 5
      ports:
        - '127.0.0.1:3306:3306'
      volumes:
        - ./init.sql:/docker-entrypoint-initdb.d/init.sql
        - './mysql_data:/var/lib/mysql:cached'
    # Cria-Front Moodle
    cria:
      platform: linux/amd64
      image: 'uitadmin/cria:latest'
      environment:
        MYSQL_DATABASE: cria
        DB_USER: 'cria'
        DB_PASS: 'root'
      ports:
        - '127.0.0.1:80:80'
      volumes:
      - ./logs:/var/log/apache2
      - ./moodledata:/var/www/moodledata
      # This is a hack to copy the moodledata files from the container to the host
      entrypoint: ["/bin/sh", "-c", "if [ ! -f /var/www/moodledata/.initialized ]; then cp -r /tmp/moodledata/* /var/www/moodledata/ && touch /var/www/moodledata/.initialized; fi && exec apache2-foreground"]
      depends_on:
        - mysql
        - redis
    # Cria-Front CriaScraper
    criascraper:
      image: amerkurev/scrapper:latest
      restart: unless-stopped
      ports:
        - "127.0.0.1:3000:3000"
      volumes:
        - "./user_data:/home/user/user_data"
        - "./user_scripts:/home/user/user_scripts"
    # Cria-Back Qdrant (pronounced cue-drant, Patrick!!!!)
    qdrant:
      image: qdrant/qdrant:v1.9.6
      ports:
        - "127.0.0.1:6333:6333"
        - "127.0.0.1:6334:6334"
      volumes:
        - ./qdrant_data/storage:/qdrant/storage
        - ./qdrant_data/config:/qdrant/config/custom_config.yaml
    # Cria-Back Criadex
    criadex:
      image: uitadmin/criadex:v1.7.7
      ports:
        - "127.0.0.1:25574:25574"
      environment:
        ENV_PATH: "./env/docker.env"
      volumes:
        - ./criadex_data:/home/cria/env
      depends_on:
        mysql:
          condition: service_healthy
        qdrant:
          condition: service_started
      healthcheck:
        test: [ "CMD", "curl", "-f", "http://criadex:25574/health_check" ]
        start_period: 1s
        interval: 5s
        timeout: 5s
        retries: 5
    # Cria-Back Criabot
    criabot:
      image: uitadmin/criabot:v1.7.8
      ports:
        - "127.0.0.1:25575:25575"
      environment:
        ENV_PATH: "./env/docker.env"
      volumes:
        - ./criabot_data:/home/cria/env
      depends_on:
        mysql:
          condition: service_healthy
        redis:
          condition: service_started
        criadex:
          condition: service_healthy
      healthcheck:
        test: [ "CMD", "curl", "-f", "http://criabot:25575/health_check" ]
        start_period: 1s
        interval: 5s
        timeout: 5s
        retries: 5
    # Cria-Back CriaParse
    criaparse:
      image: uitadmin/criaparse:v0.2.4
      ports:
        - "127.0.0.1:25576:25576"
      environment:
        ENV_PATH: "./env/docker.env"
      volumes:
        - ./criaparse_data:/home/cria/env
      depends_on:
        criadex:
          condition: service_healthy
    # Cria-Back Embed API
    criaembed-api:
      image: uitadmin/criaembed-api:v0.3.3
      ports:
        - "127.0.0.1:3003:3003"
      environment:
        ENV_PATH: "./env/docker.env"
      volumes:
        - ./criaembed-api_data:/home/cria/env
      depends_on:
        criabot:
          condition: service_healthy
    # Cria-Back Embed App
    criaembed-app:
      image: uitadmin/criaembed-app:v0.3.4
      ports:
        - "127.0.0.1:4000:4000"
      environment:
        ENV_PATH: "./env/docker.env"
      volumes:
        - ./criaembed-app_data:/home/cria/env
      depends_on:
        criabot:
          condition: service_healthy
  1. Start the containers
docker-compose up -d

This will create the folders required for various configurations. When you first run the docker-compose up command, it will download the images and create the containers. This process may take a few minutes. Note, you will also get errors as the configuration files are not yet in place.

Create the required folders and add configuration files

If any folders are missing, create them using the following commands:

mkdir criabot_data
mkdir criadex_data
mkdir criaparse_data
mkdir criaembed-api_data
mkdir criaembed-app_data
mkdir html
mkdir log
mkdir moodledata
mkdir qdrant_data
mkdir redis_data
mkdir user_data
mkdir user_scripts

Add the following configuration files to the respective folders:

  1. criabot_data
    • docker.env
# Redis Credentials (Cache)
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_USERNAME=default
REDIS_PASSWORD=password

# MySQL Credentials (Management)
MYSQL_HOST=<host_address>
MYSQL_PORT=3306
MYSQL_USERNAME=<mysql_username>
MYSQL_PASSWORD=<mysql_password>
MYSQL_DATABASE=criabot

# Initial API Key
APP_INITIAL_MASTER_KEY=<criadex_api_key>
  1. criadex_data
    • docker.env
# Criadex API Settings
APP_API_MODE=PRODUCTION
APP_API_PORT=25574

# Qdrant Credentials (Vector Database)
QDRANT_HOST=qdrant
QDRANT_PORT=6333
QDRANT_GRPC_PORT=6334
QDRANT_API_KEY=NONE

# MySQL Credentials (Management)
MYSQL_HOST=<host_address>
MYSQL_PORT=3306
MYSQL_USERNAME=<mysql_username>
MYSQL_PASSWORD=<mysql_password>
MYSQL_DATABASE=criadex

# Initial API Key
APP_INITIAL_MASTER_KEY=<criadex_api_key>
  1. criaembed-api_data
    • docker.env
MYSQL_HOST=<host_address>
MYSQL_PORT=3306
MYSQL_USERNAME=<mysql_username>
MYSQL_PASSWORD=<mysql_password>
MYSQL_DATABASE=criaembed

CRIA_SERVER_URL="<cria_server_url (Moodle)>"
CRIA_SERVER_TOKEN="<cria_server_token from Moodle>"
CRIA_BOT_SERVER_URL="http://criabot:25575/"
CRIA_BOT_SERVER_TOKEN="<cria_bot_server_token>"
THIS_APP_URL="url_to_api_server. e.g. https://criaembedapi.uit.yorku.ca"
WEB_APP_URL="url_to_app_server e.g. https://criaembedapp.uit.yorku.ca"
ASSETS_FOLDER_PATH="./dist/src/assets/"

DEFAULT_BOT_GREETING="Hello there! Got a question?"
APP_MODE=PRODUCTION

RATE_LIMIT_MINUTE_MAX=30
RATE_LIMIT_HOUR_MAX=120
RATE_LIMIT_DAY_MAX=1000

RATE_LIMIT_EMBED_MINUTE_MAX=15
RATE_LIMIT_EMBED_HOUR_MAX=100
RATE_LIMIT_EMBED_DAY_MAX=200

RATE_LIMIT_CHAT_MINUTE_MAX=50
RATE_LIMIT_CHAT_HOUR_MAX=100
RATE_LIMIT_CHAT_DAY_MAX=1000

AZURE_SPEECH_API_URL="https://canadacentral.tts.speech.microsoft.co>
AZURE_SPEECH_API_KEY=<azure_speech_api_key>

REDIS_HOST=redis
REDIS_PORT=6379
REDIS_USERNAME=default
REDIS_PASSWORD=password

DEBUG_ENABLED=true
  1. criaparse_data
    • docker.env
# Criaparse API Settings
APP_API_MODE=PRODUCTION
APP_API_PORT=25576

# SDK For auth
CRIADEX_SDK_IO_TIMEOUT=500
CRIADEX_API_BASE=http://criadex:25574
CRIADEX_API_KEY=<criadex_api_key>

Change folder and file permissions

sudo chgrp -R docker criabot_data/ criadex_data/ criaembed-api_data/ criaembed-app_data/ criaparse_data/

sudo chmod -R 664 criabot_data/ criadex_data/ criaembed-api_data/ criaembed-app_data/ criaparse_data/

Folders user_data and user_scripts should be owned by the user and not the docker group.

sudo chown -R 1001:1001 user_data/ user_scripts/
sudo chmod -R 755 user_data/ user_scripts/

Restart the containers

docker-compose down
docker-compose up -d

Cria front end installation

Cria uses Moodle 4.1 as a framework. The following steps will get Cria working.

Download Moodle

git clone git://git.moodle.org/moodle.git
cd moodle
git branch --track MOODLE_401_STABLE origin/MOODLE_401_STABLE
git checkout MOODLE_401_STABLE

Remove the default html folder and replace it with the moodle folder

rm -rf html
mv moodle html

Change permissions on folders

sudo chown -R www-data:eaas html/ moodledata/ log/

Add the cria local and theme plugins

cd html/local
git clone git@github.com:YorkUITInnovation/moodle-local_cria.git cria
cd ../theme
git clone git@github.com:YorkUITInnovation/moodle-theme_cria.git cria

cd ../../
sudo chown -R www-data:eaas html/
sudo chmod -R 775 html/ 
(These will be changed later for better security)

Restart the containers

docker-compose stop
docker-compose up -d

Complete the installation

  1. Go to http://your_cria_url:8080
  2. Follow the installation instructions
  3. Use the MySQL credentials provided.

Configure the front-end server

Coming soon!

Configuring Nginx

  1. Make sure moodle config.php is configured with $CFG->reverseproxy = true; and $CFG->sslproxy = true.
  2. Add the following nginx configuration. Modify as needed.
server
{

        server_name _;

        listen 80 default_server;
        listen [::]:80 default_server;

        root /var/www/html;
        index index.html index.htm index.nginx-debian.html;

        return 301 https://$host$request_uri;

}

server
{
        server_name your.hostname.ca;
        listen 443 ssl;
        listen [::]:443 ssl;

        ssl_certificate /etc/letsencrypt/live/your.hostname.ca/cert.pem;
        ssl_certificate_key /etc/letsencrypt/live/your.hostname.ca/privkey.pem;
        include /etc/letsencrypt/options-ssl-nginx.conf;
        ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;

        location /
        {
                proxy_read_timeout 600s;
                proxy_pass http://127.0.0.1:8080/;
                proxy_redirect off;
                client_max_body_size 69G;
        }
}

Footnotes

  1. https://docs.docker.com/engine/install/ubuntu/#uninstall-docker-engine ↑

  2. https://docs.docker.com/engine/install/ubuntu/#install-from-a-package ↑

Popular repositories Loading

  1. moodle-local_cria moodle-local_cria Public

    PHP 2

  2. moodle-theme_cria moodle-theme_cria Public

    JavaScript 1

  3. moodle-block_ai_assitant moodle-block_ai_assitant Public

    PHP 1

  4. .github .github Public

  5. SemanticDocumentParser SemanticDocumentParser Public

    Semantic document parser

    Python

  6. CriadexSDK CriadexSDK Public

    Python

Repositories

Showing 10 of 12 repositories
  • moodle-local_earlyalert Public
    YorkUITInnovation/moodle-local_earlyalert’s past year of commit activity
    PHP 0 GPL-3.0 0 0 0 Updated Jan 31, 2025
  • moodle-local_etemplate Public

    Email templating system for Moodle

    YorkUITInnovation/moodle-local_etemplate’s past year of commit activity
    PHP 0 MIT 0 0 0 Updated Jan 26, 2025
  • moodle-local_organization Public
    YorkUITInnovation/moodle-local_organization’s past year of commit activity
    PHP 0 GPL-3.0 0 0 0 Updated Jan 20, 2025
  • moodle-tool_disclaimer Public
    YorkUITInnovation/moodle-tool_disclaimer’s past year of commit activity
    PHP 0 GPL-3.0 0 0 0 Updated Jan 7, 2025
  • moodle-local_cria Public
    YorkUITInnovation/moodle-local_cria’s past year of commit activity
    PHP 2 GPL-3.0 0 1 0 Updated Dec 24, 2024
  • SemanticDocumentParser Public

    Semantic document parser

    YorkUITInnovation/SemanticDocumentParser’s past year of commit activity
    Python 0 0 0 0 Updated Dec 23, 2024
  • CriadexSDK Public
    YorkUITInnovation/CriadexSDK’s past year of commit activity
    Python 0 0 0 0 Updated Dec 12, 2024
  • moodle-theme_yulearn_moove Public
    YorkUITInnovation/moodle-theme_yulearn_moove’s past year of commit activity
    CSS 0 GPL-3.0 0 0 0 Updated Dec 9, 2024
  • moodle-block_yulearn_user Public
    YorkUITInnovation/moodle-block_yulearn_user’s past year of commit activity
    Mustache 0 0 0 0 Updated Dec 4, 2024
  • moodle-block_ai_assitant Public
    YorkUITInnovation/moodle-block_ai_assitant’s past year of commit activity
    PHP 1 GPL-3.0 0 0 0 Updated Sep 16, 2024
View all repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…