Dropbox repository: Difference between revisions

Latest revision as of 03:40, 17 May 2021

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.

Site administration > Plugins > Repositories > Manage repositories > Settings

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:

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:

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):

Return to the Dropbox site. Paste in the Redirect URl and click Add:

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:

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:

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.

@@ Line 1: / Line 1: @@
 {{Repositories}}
-A Dropbox repository can be enabled by a site administrator in ''Settings > Site administration > Modules > Repositories > Manage repositories''.
+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.
-==Sign up app keys at dropbox==
+==Enabling the Dropbox repository==
-# Go to https://www.dropbox.com/developers/apps
+The Dropbox repository may be enabled by a site administrator from the Manage repositories link in Site administration.
-# Create an app, you must change app status to Production. This feature is only availble for new API developers, but not for Moodle repository users. See MDL-26949
+ Site administration > Plugins > Repositories > Manage repositories > Settings
-# Copy the app keys (scroll if necessary)
-NOTE: The only way to get App stats for Production approved is to use an acceptable App name. The App name should be something like "Moodle With Dropbox" - with dropbox is the key part of the name (can't just use dropbox). Otherwise, you'll receive an email that says "Your app name does not follow Dropbox branding guidelines (found here: https://www.dropbox.com/developers/branding ). Please choose a new name and submit a request to change your app name to api-program@dropbox.com."
+===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:
-==Configuration==
+[[File:dropboxrepo01.png|thumb|700px|center]]
-Once enabled by the administrator a Dropbox API Key and Secret will need to be added to the Dropbox settings in order for it to work.  This will be ''the'' Dropbox available to all users throughout the site (and each will need the correct Dropbox login credentials to access it from their courses).  To gather the Dropbox API Key and Secret click the "Dropbox Developers" link on the Dropbox repository settings page.  On the next page you'll be prompted to login with your Dropbox username and password and to create a Dropbox app.
-Once the App has been created at Dropbox.com you'll have the API Secret and Key available at the bottom of the App page.  Entering those on the Dropbox settings page (and clicking Save) back in Moodle will finish the configuration.  Dropbox is now available to the entire site.
+*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.
-To access it editing teachers need only "Add..." a new file while editing or creating a resource to see Dropbox as a new option.
+* 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==
+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:
+[[File:dropboxlogin.png|center]]
+When they are done, they can log out.
+==Repository capabilities==
+There is just one capability, [[Capabilities/repository/dropbox:view|View a Dropbox folder]], which is allowed for the default authenticated user role.
 ==See also==
-* [http://www.youtube.com/watch?v=V221JLCywWs Import files from Dropbox into Moodle 2.0 video]
+* [http://www.somerandomthoughts.com/blog/2012/10/23/using-dropbox-repository-with-moodle/ Using Dropbox Repository with Moodle] blog post by Gavin Henrick
-* MDL-19168
+* MDL-52051 - Dropbox API v2 migration
-* MDL-26949 - Can't change the Dropbox API key and secret to production status
+* MDL-70268 - Dropbox scope updates
+* MDL-70271 - Dropbox API token updates
-[[Category:Site administration]]
+[[de:Dropbox Repository]]
-[[de:Dropbox]]
+[[es:Repositorio Dropbox]]
 [[ja:Dropbox]]

Documentation