How do I set up self-hosted Canvas Commons?

Adventurer II
1 0 1,753

This document outlines the steps to install and configure Commons in a self-hosted instance of Canvas. If you are not using self-hosted Canvas, please refer to the Commons guides.

Note: Self-hosted Canvas Commons instances can only share and view public resources.

Add Developer Key

309998_SelfHostedCommons1.png

In Account Navigation, click the Developer Keys link or navigate to /accounts/self/developer_keys.

Click the Add Developer Key button.

Enter Key Settings

309999_SelfHostedCommons2.png

Enter information in the following fields:

  • Key Name [1]: An easily-identifiable, human-readable name for your Commons key.
  • Owner Email [2]: The email address for an administrator in your self-hosted Canvas instance.
  • Redirect URI (Legacy) [3]: https://lor.instructure.com

Click the Save Key button [4].

Turn Commons Key On

310000_SelfHostedCommons3.png

To turn the Commons key on, click the On toggle in the State column.

View Client Secret (Key)

310001_SelfHostedCommons4.png

Click the Show Key button to view the Client Secret (Key). Copy this key as you will need it later in the setup process.

Open Account Settings

310003_SelfHostedCommons5.png

To open Account Settings, click the Settings link.

Add App

310006_SelfHostedCommons7.png

Click the Apps tab [1].

Click the Add App button [2].

Enter App Information

310010_SelfHostedCommons8.png

In the Configuration Type drop down, select the By URL option [1]. Enter the following information:

Click the Submit button [4].

Configure App Settings

310011_SelfHostedCommons9.png

Click the Settings icon [1] and select the Configure option [2].

Enter App Configuration

310148_SelfHostedCommons10.1.png

Enter your Client ID in the Client ID field [1] and Client Secret (Key) in the Client Secret (Key) field [2]. Then click the Continue setup button [3].

Authorize Commons Key

310014_SelfHostedCommons11.png

Click the Authorize button.

Complete Commons Setup

310015_SelfHostedCommons12.png

Click the Close button.

Refresh the Browser

310016_SelfHostedCommons13.png

To see the Commons link in the Global Navigation menu, refresh the page.