Difference between revisions of "Dropbox repository"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: Dropbox repository.

m
(updating Dropbox app info (MDL-52051))
 
Line 1: Line 1:
 
{{Repositories}}
 
{{Repositories}}
 +
See MDL-52051 for details of the Dropbox API v2 migration.
 +
 
The Dropbox repository enables users to copy or create a shortcut or alias to files from ''their own'' Dropbox. See [[Working with files]] for more details.
 
The Dropbox repository enables users to copy or create a shortcut or alias to files from ''their own'' Dropbox. See [[Working with files]] for more details.
  
 
==Enabling the Dropbox repository==
 
==Enabling the Dropbox repository==
  
The Dropbox repository may be enabled by a site administrator in ''Administration > Site administration > Plugins> Repositories > Manage repositories''.
+
The Dropbox repository may be enabled by a site administrator from the Manage repositories link in Site administration.
  
 
===Dropbox configuration===
 
===Dropbox configuration===
Once enabled the administrator will need to add a Dropbox API Key and Secret.  To get one, click on the "Dropbox Developers" link on the Dropbox repository settings page and follow the instructions below.
+
*Once enabled the administrator will need to add a Dropbox API Key and Secret.  To get one, click on the "Dropbox developers" link on the Dropbox repository settings page, opening it in a new tab for convenience:
 +
 
 +
[[File:dropboxrepo01.png|thumb|700px|center]]
 +
 
 +
*On the next screen, sign in or create an account on Dropbox. If you don't immediately see a blue button 'Create app' then click the Developers link at the bottom of the screen. On the next screen, click to create a new app.
 +
 
 +
* Choose '''Dropbox API', 'Full dropbox''' and name your app according to the branding rules:
 +
 
 +
[[File:dropboxrepo02.png|thumb|center|700px]]
 +
 
 +
* Click the blue 'Create app' button
 +
 
 +
* On the next screen you will see an App key and an App secret. Copy these and go back to your Moodle site Dropbox repository settings page.
 +
 
 +
* Paste these into the appropriate fields (1 below) and then copy the Redirect URL (2 below):
 +
 
 +
[[File:dropboxrepo4.png|thumb|center|700px]]
  
===Getting sign up app keys at Dropbox===
+
* Return to the Dropbox site. Paste in the Redirect URl and click Add:
  
*Click the "Dropbox Developers" link to go to https://www.dropbox.com/developers/apps and sign in.
+
[[File:dropboxrepo05.png|center]]
* Click on "Create an app" and  select "Dropbox API app":
 
[[File:dropboxapinew.png|center]]
 
*Choose the following:
 
** "Files and datastores"
 
** "My app needs access to files already on Dropbox
 
** "All file types"
 
[[File:dropboxsettings.png|center]]
 
  
*Give your app a name. (Make sure your app name does not contain the word "Dropbox". See note below.)
+
*If you wish, you can click the Branding tab and add extra information for your users, including a custom logo they will see when they connect to Dropbox on your site:
* Copy the app keys to Moodle and save your changes.
 
* Please note that to make the Dropbox repository available to more than one hundred users on your site, you will need to request that your status be changed to "Production". Follow the link on Dropbox which allows you to make that request.
 
  
NOTE: Your app name cannot contain the word "Dropbox" as it goes against Dropbox branding policy (found here: https://www.dropbox.com/developers/branding). For quick approval of of your app to production status you are advised to completely follow the guidelines in the branding policy.
+
[[File:dropboxrepo06.png|center]]
  
 +
==Using the Dropbox repository==
  
 
To select a file via Dropbox, editing teachers will click on the Dropbox link in the file picker and log on to access the files in their account. They will see a message requesting access:
 
To select a file via Dropbox, editing teachers will click on the Dropbox link in the file picker and log on to access the files in their account. They will see a message requesting access:

Latest revision as of 09:50, 2 February 2017

See MDL-52051 for details of the Dropbox API v2 migration.

The Dropbox repository enables users to copy or create a shortcut or alias to files from their own Dropbox. See Working with files for more details.

Enabling the Dropbox repository

The Dropbox repository may be enabled by a site administrator from the Manage repositories link in Site administration.

Dropbox configuration

  • Once enabled the administrator will need to add a Dropbox API Key and Secret. To get one, click on the "Dropbox developers" link on the Dropbox repository settings page, opening it in a new tab for convenience:
dropboxrepo01.png
  • On the next screen, sign in or create an account on Dropbox. If you don't immediately see a blue button 'Create app' then click the Developers link at the bottom of the screen. On the next screen, click to create a new app.
  • Choose Dropbox API', 'Full dropbox and name your app according to the branding rules:
dropboxrepo02.png
  • Click the blue 'Create app' button
  • On the next screen you will see an App key and an App secret. Copy these and go back to your Moodle site Dropbox repository settings page.
  • Paste these into the appropriate fields (1 below) and then copy the Redirect URL (2 below):
dropboxrepo4.png
  • Return to the Dropbox site. Paste in the Redirect URl and click Add:
dropboxrepo05.png
  • If you wish, you can click the Branding tab and add extra information for your users, including a custom logo they will see when they connect to Dropbox on your site:
dropboxrepo06.png

Using the Dropbox repository

To select a file via Dropbox, editing teachers will click on the Dropbox link in the file picker and log on to access the files in their account. They will see a message requesting access:

dropboxlogin.png

When they are done, they can log out.

Repository capabilities

There is just one capability, View a Dropbox folder, which is allowed for the default authenticated user role.

See also