Difference between revisions of "Managing repositories"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.2. Up-to-date documentation for the latest stable version of Moodle is probably available here: Managing repositories.

(Allow adding to legacy course files)
m (Repository capabilities: removing alfresco:view)
 
(15 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
==Enabling repositories==
 
==Enabling repositories==
  
Repositories can be enabled by an administrator in ''Settings > Site administration > Plugins > Repositories > Manage repositories''.
+
Repositories can be enabled by an administrator in ''Site administration > Plugins > Repositories > Manage repositories''.
  
A repository plugin may be set to
+
A repository plugin may be set to one of three possible statuses:
  
* Enabled and visible - appears in the file picker
+
* "Enabled and visible" means available for use in the [[File picker]]
* Enabled and hidden
+
* "Enabled and hidden" means not available in the [[File picker]]
* Disabled - default setting
+
* "Disabled" means not available for use and if content has been added to your site you will be given the following message:
 +
<pre>
 +
Are you sure you want to remove this repository plugin, its options and all of its instances - [Repository Name here]? If you choose "Continue and download", file references to external contents will be downloaded to Moodle. This could take a long time to process.
 +
</pre>
 +
With options to Continue, Continue and download, or Cancel.
  
 
The order in which repositories are shown in the [[File picker|file picker]] may be set using the up and down arrows.
 
The order in which repositories are shown in the [[File picker|file picker]] may be set using the up and down arrows.
  
 
==Vocabulary==
 
==Vocabulary==
'''Repository plugin''': it is also called a repository type. It can be named Box.net, Flickr, Mahara, Youtube... Adding a plugin allow users to create instances of this plugin. Only instances are displayed into the file picker. Type only exist in order to let a Moodle administrator to deactivate/delete all instances of a type in one click.
+
'''Repository plugin''': it is also called a repository type. It can be named Box, Flickr, Mahara, Youtube... Adding a plugin allow users to create instances of this plugin. Only instances are displayed into the file picker. Type only exist in order to let a Moodle administrator to deactivate/delete all instances of a type in one click.
  
 
'''Repository instance''': An instance is displayed into the file picker and it is the access point to an external repository. An instance can have specific settings (for example be linked to a personal account).
 
'''Repository instance''': An instance is displayed into the file picker and it is the access point to an external repository. An instance can have specific settings (for example be linked to a personal account).
 
   
 
   
*First case: when you add the plugin, an instance is automatically created and can not be edited. The Moodle administrator cannot change the instance name. The instance name displayed into the file picker will be exactly the same as the plugin name. For example Youtube, Box.net...
+
*First case: when you add the plugin, an instance is automatically created and can not be edited. The Moodle administrator cannot change the instance name. The instance name displayed into the file picker will be exactly the same as the plugin name. For example Youtube, Box...
 
*Second case: the plugin allow the Moodle administrator to add multiple instances. An instance has a name for example Flickr Public access to Martin account, Martin's Mahara... <br/>For this second case it is important to identify two different kind of instances:
 
*Second case: the plugin allow the Moodle administrator to add multiple instances. An instance has a name for example Flickr Public access to Martin account, Martin's Mahara... <br/>For this second case it is important to identify two different kind of instances:
 
#Common instances: The instances set by Moodle administrator in these same administration pages will be available into any file picker.
 
#Common instances: The instances set by Moodle administrator in these same administration pages will be available into any file picker.
Line 24: Line 28:
 
==Common repository settings==
 
==Common repository settings==
  
Common repository settings can be set by an administrator in ''Settings > Site administration > Plugins > Repositories > Common Repository settings'':
+
Common repository settings can be set by an administrator in ''Site administration > Plugins > Repositories > Common Repository settings'':
  
===Cache Expire===
+
===Cache expire===
 +
You can specify how long in seconds file listings are cached locally when browsing external repositories.
 +
 
 +
===Timeout settings===
 +
 
 +
If users are reporting timeouts when using repositories, an admin can increase the timeout for downloading or synchronising files.
  
You can specify how long in seconds file listings are cached locally when browsing external repositories.
+
====Get file timeout====
 +
Timeout in seconds for downloading an external file into Moodle. Defaults to 30.
 +
====Sync file timeout====
 +
Timeout in seconds for syncronising the external file size. Defaults to 1.
 +
====Sync image timeout====
 +
Timeout in seconds for downloading an image file from external repository during syncronisation. Defaults to 3.
  
 
===Allow external links===
 
===Allow external links===
  
 
With some repositories such as Flickr and Wikimedia, users can have the choice whether to copy the media into Moodle (the preferred solution) or to make a link to it instead.
 
With some repositories such as Flickr and Wikimedia, users can have the choice whether to copy the media into Moodle (the preferred solution) or to make a link to it instead.
 +
 +
Defaults to Yes.
  
 
===Legacy course files in new courses===
 
===Legacy course files in new courses===
  
This repository is not normally available in new courses as it is designed for upgraded 1.9 courses. However, if it is checked here then it will appear when new courses are created - but certain backup and restore features won't work with it. See [[Legacy course files]] for more details.
+
This repository is not normally available in new courses as it is designed for upgraded 1.9 courses. However, if it is checked here then it will appear when new courses are created - but certain backup and restore features won't work with it.  
 +
 
 +
See [[Legacy course files]] for more details. This should not be enabled in sites not originally upgraded from Moodle 1.9.
 +
 
 +
Defaults to No.
  
 
===Allow adding to legacy course files===
 
===Allow adding to legacy course files===
Line 44: Line 64:
 
==Repository capabilities==
 
==Repository capabilities==
  
*[[Capabilities/repository/alfresco:view|View alfresco repository]]
+
Authenticated user role:
*[[Capabilities/repository/boxnet:view|View box.net repository]]
+
 
*[[Capabilities/repository/coursefiles:view|Use course files repository plugin]]
+
*[[Capabilities/repository/areafiles:view|View Embedded files]]
 +
*[[Capabilities/repository/boxnet:view|View Box repository]]
 
*[[Capabilities/repository/dropbox:view|View a Dropbox folder]]
 
*[[Capabilities/repository/dropbox:view|View a Dropbox folder]]
*[[Capabilities/repository/filesystem:view|View file system repository]]
 
 
*[[Capabilities/repository/flickr:view|View Flickr repository]]
 
*[[Capabilities/repository/flickr:view|View Flickr repository]]
 
*[[Capabilities/repository/flickr public:view|Use Flickr public repository in file picker]]
 
*[[Capabilities/repository/flickr public:view|Use Flickr public repository in file picker]]
*[[Capabilities/repository/googledocs:view|View google docs repository]]
+
*[[Capabilities/repository/googledocs:view|View Google Drive repository]]
*[[Capabilities/repository/local:view|View server repository]]
 
 
*[[Capabilities/repository/merlot:view|View the Merlot repository]]
 
*[[Capabilities/repository/merlot:view|View the Merlot repository]]
*[[Capabilities/repository/picasa:view|View picasa repository]]
+
*[[Capabilities/repository/picasa:view|View Picasa repository]]
*[[Capabilities/repository/recent:view|View recent files]]
+
*[[Capabilities/repository/recent:view|View Recent files]]
*[[Capabilities/repository/s3:view|View amazon s3 repository]]
+
*[[Capabilities/repository/s3:view|View Amazon s3 repository]]
 +
*[[Capabilities/repository/skydrive:view|View Microsoft OneDrive repository]]
 
*[[Capabilities/repository/upload:view|Use uploading in file picker]]
 
*[[Capabilities/repository/upload:view|Use uploading in file picker]]
 
*[[Capabilities/repository/url:view|Use URL downloader in file picker]]
 
*[[Capabilities/repository/url:view|Use URL downloader in file picker]]
*[[Capabilities/repository/user:view|View user private files]]
+
*[[Capabilities/repository/user:view|View use Private files]]
 +
*[[Capabilities/repository/wikimedia:view|View Wikimedia repository]]
 +
*[[Capabilities/repository/youtube:view|Use YouTube in file picker]]
 +
 
 +
Manager, Course creator, Teacher, Non-editing teacher Roles:
 +
 
 +
*[[Capabilities/repository/coursefiles:view|Use Legacy course files repository]]
 +
*[[Capabilities/repository/filesystem:view|View File system repository]]
 +
*[[Capabilities/repository/local:view|View Server repository]]
 
*[[Capabilities/repository/webdav:view|View WebDav repository]]
 
*[[Capabilities/repository/webdav:view|View WebDav repository]]
*[[Capabilities/repository/wikimedia:view|View wikimedia repository]]
+
 
*[[Capabilities/repository/youtube:view|Use youtube in file picker]]
 
  
 
[[de:Repositories verwalten]]
 
[[de:Repositories verwalten]]
 
[[es:Gestionando repositorios]]
 
[[es:Gestionando repositorios]]
 +
[[ja:リポジトリ管理]]

Latest revision as of 10:08, 24 November 2016

Enabling repositories

Repositories can be enabled by an administrator in Site administration > Plugins > Repositories > Manage repositories.

A repository plugin may be set to one of three possible statuses:

  • "Enabled and visible" means available for use in the File picker
  • "Enabled and hidden" means not available in the File picker
  • "Disabled" means not available for use and if content has been added to your site you will be given the following message:
Are you sure you want to remove this repository plugin, its options and all of its instances - [Repository Name here]? If you choose "Continue and download", file references to external contents will be downloaded to Moodle. This could take a long time to process.

With options to Continue, Continue and download, or Cancel.

The order in which repositories are shown in the file picker may be set using the up and down arrows.

Vocabulary

Repository plugin: it is also called a repository type. It can be named Box, Flickr, Mahara, Youtube... Adding a plugin allow users to create instances of this plugin. Only instances are displayed into the file picker. Type only exist in order to let a Moodle administrator to deactivate/delete all instances of a type in one click.

Repository instance: An instance is displayed into the file picker and it is the access point to an external repository. An instance can have specific settings (for example be linked to a personal account).

  • First case: when you add the plugin, an instance is automatically created and can not be edited. The Moodle administrator cannot change the instance name. The instance name displayed into the file picker will be exactly the same as the plugin name. For example Youtube, Box...
  • Second case: the plugin allow the Moodle administrator to add multiple instances. An instance has a name for example Flickr Public access to Martin account, Martin's Mahara...
    For this second case it is important to identify two different kind of instances:
  1. Common instances: The instances set by Moodle administrator in these same administration pages will be available into any file picker.
  2. Private instance: A teacher can set some instances available only for a course, and an user can set some instances only available for himself. In order to set instances for a course the teacher will go to the course page, and in order to set instances for a personal use, a user will go on his profile page. An administrator cannot add/edit private instances from the administration pages.

Common repository settings

Common repository settings can be set by an administrator in Site administration > Plugins > Repositories > Common Repository settings:

Cache expire

You can specify how long in seconds file listings are cached locally when browsing external repositories.

Timeout settings

If users are reporting timeouts when using repositories, an admin can increase the timeout for downloading or synchronising files.

Get file timeout

Timeout in seconds for downloading an external file into Moodle. Defaults to 30.

Sync file timeout

Timeout in seconds for syncronising the external file size. Defaults to 1.

Sync image timeout

Timeout in seconds for downloading an image file from external repository during syncronisation. Defaults to 3.

Allow external links

With some repositories such as Flickr and Wikimedia, users can have the choice whether to copy the media into Moodle (the preferred solution) or to make a link to it instead.

Defaults to Yes.

Legacy course files in new courses

This repository is not normally available in new courses as it is designed for upgraded 1.9 courses. However, if it is checked here then it will appear when new courses are created - but certain backup and restore features won't work with it.

See Legacy course files for more details. This should not be enabled in sites not originally upgraded from Moodle 1.9.

Defaults to No.

Allow adding to legacy course files

When 'Legacy course files' is available in a course, this setting controls if users are able to add new files to it. When enabled, users will be able to add files and directories, as well as delete. When disabled, users will not be able to add files and directories.

Repository capabilities

Authenticated user role:

Manager, Course creator, Teacher, Non-editing teacher Roles: