How do I set up self-hosted Canvas Commons?

Document created by Nathan Atkinson Employee on Apr 16, 2019Last modified by jivedocs@instructure.com on Sep 21, 2019
Version 2Show Document
  • View in full screen mode

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

 

 

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

 

Click the Add Developer Key button.

 

Enter Key Settings

 

 

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

 

 

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

 

View Client Secret (Key)

 

 

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

 

 

To open Account Settings, click the Settings link.

 

 

Add App

 

 

Click the Apps tab [1].

 

Click the Add App button [2].

 

Enter App Information

 

 

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

 

Click the Submit button [4].

 

Configure App Settings

 

 

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

 

Enter App Configuration

 

 

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

 

 

Click the Authorize button.

 

Complete Commons Setup

 

 

Click the Close button.

 

Refresh the Browser

 

 

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

Attachments

    Outcomes