Dropbox repository: Difference between revisions

From MoodleDocs
(added Requires updating to this page)
(page update - thanks to info from https://moodle.org/mod/forum/discuss.php?d=448105)
Line 5: Line 5:
==Enabling the Dropbox repository==
==Enabling the Dropbox repository==


The Dropbox repository may be enabled by a site administrator from the Manage repositories link in Site administration.
To use the Dropbox repository, an administrator must first create an [[OAuth 2 services|OAuth 2 service]].
Site administration > Plugins > Repositories > Manage repositories > Settings


===Dropbox configuration===
# Go to OAuth 2 services in Site administration - Server and click the button to create a new custom service.
*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:
# Go to 'Manage repositories' in Site administration and enable the Dropbox repository.
 
# On the Dropbox configuration page, select the OAuth 2 service then save changes.
[[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]]
 
* Return to the Dropbox site. Paste in the Redirect URl and click Add:
 
[[File:dropboxrepo05.png|center]]
 
* Go to the 'Permissions' tab and set the following scopes:
# account_info.read
# files.metadata.read
# files.content.read
# sharing.read
# sharing.write
'''NOTE: This is not required if it is an existing backpack created prior to Sept 17, 2020.'''
 
*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:
 
[[File:dropboxrepo06.png|center]]


==Using the Dropbox repository==
==Using the Dropbox repository==
Line 56: Line 24:
==See also==
==See also==


* [http://www.somerandomthoughts.com/blog/2012/10/23/using-dropbox-repository-with-moodle/ Using Dropbox Repository with Moodle] blog post by Gavin Henrick
* MDL-52051 - Dropbox API v2 migration
* MDL-70268 - Dropbox scope updates
* MDL-70268 - Dropbox scope updates
* MDL-70271 - Dropbox API token updates
* MDL-70271 - Dropbox API token updates

Revision as of 07:56, 16 August 2023

This page requires updating. Please do so and remove this template when finished.


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

To use the Dropbox repository, an administrator must first create an OAuth 2 service.

  1. Go to OAuth 2 services in Site administration - Server and click the button to create a new custom service.
  2. Go to 'Manage repositories' in Site administration and enable the Dropbox repository.
  3. On the Dropbox configuration page, select the OAuth 2 service then save changes.

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