15.1 LMS Configuration Guide (LTI 1.3) - Canvas

This guide will walk you through the process of installing CurricuLLM into your Canvas LMS environment. CurricuLLM is an AI-powered tool designed for schools.

Prerequisites

Before you begin, ensure you have:

• Canvas administrator access
• Permission to create and manage Developer Keys in Canvas
• Access to your Canvas instance's admin panel
• If hosting your own version of Canvas, please ensure redis is setup and configured properly as this is required for LTI+ registrations (See: Canvas Production Start Guide)

Installation Steps

Step 1: Access Developer Keys

• Log in to Canvas as an administrator
• Navigate to Admin → Developer Keys
• Click the + Developer Key button
• Select + LTI Key from the dropdown menu

Step 2: Configure the LTI Key

You have two options for configuring the LTI key:

Option A: Manual Entry (Recommended)

• Select Manual Entry as the configuration method
• Fill in the required fields:
  • Key Name: CurricuLLM AI
  • Owner Email: Your administrative email address
  • Redirect URIs: https://lti.curricullm.com/lti/launch
  • Title: CurricuLLM
  • Description: AI for your curriculum
  • Target Link URI: https://lti.curricullm.com/lti/launch
  • OpenID Connect Initiation Url: https://lti.curricullm.com/lti/login
  • JWK Method: Select Public JWK URL
  • Public JWK URL: https://lti.curricullm.com/lti/keys
• Configure LTI Advantage Services (if available in your Canvas version):
  • Enable Data Associated with Context Service
  • Enable Account Lookup Service
• Setup Privacy Level:
  • Enable PUBLIC. We require access to user attributes in order to authenticate Canvas users with CurricuLLM
• Set up Placements:
  • Account Navigation
  • Link Selection
  • Course Navigation
• Click Save to create the key

Option B: JSON Configuration (Advanced) - Beta

For administrators comfortable with JSON configuration, you can use the following configuration snippet:

`` { "title": "CurricuLLM", "description": "AI for your curriculum", "target_link_uri": "https://lti.curricullm.com/lti/launch", "oidc_initiation_url": "https://lti.curricullm.com/lti/login", "public_jwk_url": "https://lti.curricullm.com/lti/keys", "scopes": [ "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly", "https://canvas.instructure.com/lti/account_lookup/scope/show" ], "extensions": [ { "domain": "app.curricullm.com", "privacy_level": "public", "platform": "canvas.instructure.com", "settings": { "text": "CurricuLLM", "icon_url": "https://app.curricullm.com/img/curricullm%20logo.svg", "placements": [ { "placement": "account_navigation", "message_type": "LtiResourceLinkRequest" }, { "placement": "link_selection", "message_type": "LtiResourceLinkRequest" }, { "default": "enabled", "placement": "course_navigation", "message_type": "LtiResourceLinkRequest", "windowTarget": "_blank" } ] } } ] } ``

Note: Replace "org_guid": " " with your actual organization GUID provided by CurricuLLM. Please reach out to helpdesk@curricullm.com if you have not received your organisation GUID.

You have some flexibility in determining how you want your users to launch CurricuLLM within Canvas. In the above JSON we have set windowTarget: "_blank" to launch our product in a new tab. This is our preferred experience, however, you may wish to change this. For further information see: Canvas Registration Documentation

Step 3: Activate the Developer Key

• After saving, locate the newly created CurricuLLM AI key in your Developer Keys list
• Find the key's Details column and note the Client ID (it will be a long numerical string, e.g., 10000000000083)
• Toggle the key's State from Off to On (the checkmark icon should turn green)

Step 4: (Optional) Add the App to a Course

Now that the developer key is configured and activated, you can add CurricuLLM to individual courses:

• Navigate to the course where you want to add CurricuLLM
• Go to Settings → Apps tab
• Click the + App button
• In the Add App dialog:
  • Configuration Type: Select By Client ID
  • Client ID: Enter the Client ID from Step 3 (e.g., 10000000000083)
• Click Submit
• The CurricuLLM app will now be available in your course navigation and can be accessed by instructors and students based on your permissions settings.

Verification

Before you can commence verification, please email helpdesk@curricullm.com with the following details of your Canvas installation:

• What type of instance you are running (i.e. self-hosted or Instructure Cloud)
• If you are self-hosted, we require:
  • Platform name e.g. d230fe1c-3e94-4f3e-9ab8-63b6312d8e40. This is the organization GUID that you received as part of your registration
  • URL (also known as the "Issuer") e.g. https://canvaslms.myschool.com.au
  • Platform client ID (this is the Client ID from Step 3 above)

Please allow 24–48 hours for us to load you into CurricuLLM's backend to allow verification.

To verify the installation was successful, after receiving confirmation from above:

• Navigate to a course where you installed CurricuLLM
• Look for CurricuLLM in the course navigation menu
• Click on it to launch the application
• The tool should open (in a new window or in an iFrame depending on your configuration) and authenticate successfully

Placement Options

CurricuLLM can appear in three locations within Canvas:

• Account Navigation — Available from the main account menu for administrators
• Course Navigation — Available in the left sidebar of each course (recommended for instructors and students)
• Link Selection — Allows embedding CurricuLLM content within course modules and assignments

Troubleshooting

• Issue: The app doesn't appear in course navigation
  • Solution: Ensure the developer key state is set to "On" and that you've added the app to the specific course
• Issue: Authentication errors when launching the app
  • Solution: Verify that all URLs in the configuration are correct and that the Public JWK URL is accessible
• Issue: Client ID not working
  • Solution: Double-check that you're using the correct Client ID from the Developer Keys page. Click "Show Key" if needed to reveal the full ID

Support

If you encounter any issues during installation or have questions about CurricuLLM, please contact:

• Email: helpdesk@curricullm.com