How to install Scaffold

Installation of Scaffold is implemented via the Canvas theme editor. We provide two options for installing the JavaScript (JS) and Cascading Style Sheets (CSS).

Canvas theme editor

Before you start, it's important to know the basics of the Canvas theme editor.

As a Canvas admin, you can use the Theme Editor to create custom themes for your institution. Themes are created from existing Canvas templates. Any theme applied to the account also applies to all subaccounts, though the Theme Editor can also be used to create themes for individual subaccounts. Once you have created and saved a theme, you can apply the theme to your account at any time. 

• The Theme Editor is not available for Free-For-Teacher accounts.
• If you are a sub-account admin and the Themes link is not visible in Account Navigation, Themes has not been enabled for sub-accounts. If the CSS/JS Upload tab is not visible, file uploads have not been enabled for sub-accounts.

You can find additional information on the Canvas forums:

https://community.canvaslms.com/t5/Admin-Guide/How-do-I-create-a-theme-for-an-account-using-the-Theme-Editor/ta-p/242

https://community.canvaslms.com/t5/Admin-Guide/How-do-I-upload-custom-JavaScript-and-CSS-files-to-an-account/ta-p/253

Installing Scaffold

The two options to install Scaffold are:

1. Uploading the Scaffold CSS and JS files directly to the Canvas theme
2. Uploading the Scaffold loader file to the Canvas theme

Uploading the Scaffold CSS and JS files directly to the Canvas theme

To upload the Scaffold CSS and JS files, you first need to download the build files for your Scaffold template.

1. Log in to Scaffold and select your template.
2. Under the Build and Deploy section, ensure that you have built the files, to update any of the latest changes.
3. Then download the Live versions of following files:
   1. Web/editor JS
   2. Mobile JS
   3. Web/editor CSS
   4. Mobile CSS
4. Log in to Canvas and then navigate to the sub-account where you want to install the Scaffold files.
5. Select 'Themes from the admin menu.
6. Create a new theme or edit an existing theme by clicking on an existing theme.
7. On the left sidebar, click on the Upload tab.
8. Upload the relevant web/editor files and the mobile files to the theme.
9. Click Save theme and then Apply theme.
10. To apply the theme to your entire account, click the OK button. To return to the Theme Editor, click the Cancel button.
11. To exit the theme and return to the Themes page, click the Exit button.

Uploading the Scaffold loader file to the Canvas theme

1. Log in to Scaffold and select your template.
2. Under the Build and Deploy section, ensure that you have built the files, to update any of the latest changes.
3. Then download the Live versions of following files:
   1. Web/Editor Loader JS
   2. Mobile Loader JS
4. Log in to Canvas and then navigate to the sub-account where you want to install the Scaffold files.
5. Select 'Themes from the admin menu.
6. Create a new theme or edit an existing theme by clicking on an existing theme.
7. On the left sidebar, click on the Upload tab.
8. Upload the relevant web/editor files and the mobile files to the theme.
9. Click Save theme and then Apply theme.
10. To apply the theme to your entire account, click the OK button. To return to the Theme Editor, click the Cancel button.
11. To exit the theme and return to the Themes page, click the Exit button.