# Deployment Guide

This guide describes how to add the Annoto App to your Instructure Canvas environment. This guide is intended for IT and administrators.

{% hint style="success" %}
This is the recomended deployment method which uses **LTI 1.3**

The Annoto App for Canvas is implemented as a set of LTI external tools.
{% endhint %}

## Prerequisites

* A Canvas Administrator account with access to manage [Canvas Developer Keys](https://community.canvaslms.com/t5/Admin-Guide/How-do-I-manage-developer-keys-for-an-account/ta-p/249).
* A URL to the [JSON Configuration](https://canvas.instructure.com/doc/api/file.lti_dev_key_config.html) provided by Annoto
  * Example: `https://auth.eu.annoto.net/lti/register/{host_id}/canvas`
* Redirct URIs provided by Annoto

  * Example: 

  ```
  https://auth.eu.annoto.net/hosts/{host_id}/lti/app
  https://auth.eu.annoto.net/hosts/{host_id}/lti/embed/select
  https://auth.eu.annoto.net/hosts/{host_id}/lti/embed/launch
  https://auth.eu.annoto.net/hosts/{host_id}/lti/dashboard/launch
  ```

{% hint style="info" %}
To obtain the JSON configuration link and Redirct URIs please contact us at <support@annoto.net>
{% endhint %}

## **Step 1: Create LTI Developer Key**

{% hint style="info" %}
[Instructure Community Guide for managing developer Keys](https://community.canvaslms.com/t5/Admin-Guide/How-do-I-manage-developer-keys-for-an-account/ta-p/249)
{% endhint %}

1. Navigate to the Admin tab.
2. Navigate the Developer Keys
3. Click on "+ Developer Key" Button
4. Click "+ LTI Key"

<figure><img src="/files/G2D9BuoBVpcs1Q1VacBf" alt=""><figcaption></figcaption></figure>

## Step 2: Configure the LTI Developer Key

1. Change the Method to "Enter URL"
2. Paste the "JSON URL" provided by Annoto
3. Paste the "Redirect URIs" provided by Annoto
4. Set Key Name to "Annoto LTI Advantage"
5. Set Owner email (optional)
6. Click on "Save"

<figure><img src="/files/ZOMIJ9R2Jbyv3bTtWKNe" alt=""><figcaption></figcaption></figure>

## Step 3: Enable the LTI Developer Key

The newely created Key would be listed in your Account and have it's "State" set to off:

<figure><img src="/files/Q1tlghOfxe6GrsNRJ7fy" alt=""><figcaption></figcaption></figure>

Click on the Toggle to enable the Key:

<figure><img src="/files/3eZWAqmqAcDRoOtLsAxI" alt=""><figcaption></figcaption></figure>

## Step 4: Share the Client ID with Annoto

The Client ID of the LTI Developer Key is available in "Details" column:

<figure><img src="/files/TZuvTbAaFbJJMT5WJeA8" alt=""><figcaption></figcaption></figure>

Please copy the key and share it with Annoto team to finalize the deployment.

{% hint style="warning" %}
Do not click on the "Show Key", it will show a different private key, not required by Annoto. The Client ID is the visible ID in the Developers Keys table.
{% endhint %}

## Support

If you need any additional information or have any questions, please contact us at [Annoto Support](mailto:support@annoto.net?subject=Annoto%20Support)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.annoto.net/setup-guides/canvas/deployment-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.