Note: You are currently viewing documentation for Moodle 2.0. Up-to-date documentation for the latest stable version is available here: File system repository.

File system repository: Difference between revisions

From MoodleDocs
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Repositories}}
{{Repositories}}
<p class="note">'''Please refer to [[Page_notes#File system repository configuration|these notes]] before editing this page.'''</p>
The file system repository allows users within Moodle to access files which have been uploaded via FTP into designated folders on the server.  A file system repository may be available site wide for everyone; within an individual course or for an individual user.(However - see this [http://tracker.moodle.org/browse/MDL-28656  tracker entry] regarding course and individual repositories)


==What is the file system repository?==
This must be done by a systems admin who  has write permissions to the server directories.
 
The file system repository allows users within Moodle to access files which have been uploaded via FTP into designated folders on the server.  A files system repository may be available site wide for everyone; within an individual course or for an individual user
 
This must be done by a systems admin who  has write permissions to the server directories
 
Here is [http://moodle.drupalgardens.com/article/tue-06152010-1918/ftp-files-moodle-20-repository-api a video] that may be helpful.


=== Creating  folders for your file system repositories===
=== Creating  folders for your file system repositories===
Line 14: Line 8:
*Inside it, create a folder  called "repository"
*Inside it, create a folder  called "repository"
*Inside that folder, create as many folders as you need, named appropriately.
*Inside that folder, create as many folders as you need, named appropriately.
[[File:Moodledatarepo.png]]
[[File:Moodledatarepo2.png]]
*FTP into the appropriate folder the files you want. (The folders can hold all types of files)
*FTP into the appropriate folder the files you want. (The folders can hold all types of files)


=== Enabling the File System repository plugin===
=== Enabling the File System repository plugin===


*Go to Site Administration>Plugins>Repositories>Manage Repositories;  
*Go to ''Settings > Site administration > Plugins > Repositories > Manage Repositories'';  
*Select from the drop down next to File sytem "Enabled and visible"
*Select from the drop down next to File sytem "Enabled and visible"
[[File:Filesystemrepo.png]]
[[File:Filesystemrepo.png]]
Line 32: Line 24:
[[File:Sitefilesystemrepo.png]]
[[File:Sitefilesystemrepo.png]]
*Give it a name and (if there are several folders on the server) choose from the dropdown the one you want. Click save
*Give it a name and (if there are several folders on the server) choose from the dropdown the one you want. Click save
[[File:Namedfilesystemrepo.png]]
[[File:Namedfilesystem.png]]
*It will now be available in the file picker in all courses.
*It will now be available in the file picker in all courses.
''NOTE: Just repeat the process to get more than one site wide file system repository''
''NOTE: Just repeat the process to get more than one site wide file system repository''


===Setting up a repository inside a course)===
===Setting up a repository inside a course===
''NOTE:  A regular user needs to have been given permission to do this by admin (MORE DETAILS SOON)''
''NOTE:  A regular user needs to have been given permission to do this by admin (MORE DETAILS SOON)''
*Go to the desired course and click on “repositories” in the administration block
*Go to the desired course and click on “repositories” in the administration block
*Scroll down and click “ create File System instance
*Scroll down and click "Create File System instance"
*Follow the same process as in ... above
[[File:Courseinstance.png]]
 
*Follow the same process as [[#Setting_up_a_site-wide_file_system_repository|here]]


===Setting up an individual file system repository instance===
===Setting up an individual file system repository instance===
Line 49: Line 41:
*Click on “repositories”
*Click on “repositories”
*Scroll down and click “create File System instance”
*Scroll down and click “create File System instance”
*Follow the same process as in .. above
*Follow the same process as [[#Setting_up_a_site-wide_file_system_repository|here]]
*This will create a personal file system repository connecting just you to a folder on the server.
*This will create a personal file system repository connecting just you to a folder on the server.
[[File:Privaterepo2.png]]


===6. Use it!===
===Using it===
 
If you try to add a file in Moodle, then the File Picker should show you your new file system repository, and you should be able to browse it and select files to use.   
Everything should be working.  If you try to add a file in Moodle, then the File Picker should show you your new file system repository, and you should be able to browse it and select files to use.   


Note that file types are respected (based on file extensions), so if you are adding an image in the editor, then you won't see Office docs (for example) appear in the File Picker.
Note that file types are respected (based on file extensions), so if you are adding an image in the editor, then you won't see Office docs (for example) appear in the File Picker.


[[Image:Repository-filesystem-filepicker.png]]
[[File:Filesystemeg.png]]


==FAQ==
==Repository permissions==
===How do the files get into the File system repository?===
#Get your person with server access to copy them in
#Set up FTP
#Set up access to that folder as a Windows share


===Is there a way to upload files to a File system repository from inside Moodle?===
This repository is accessible by default to administrators, course creators, teachers, editing teachers and managers, but not to guests or students. This [[Capabilities/repository/filesystem:view|capability]] can be changed to control access to users with specific roles.
If you are talking about core (vanilla) Moodle: not at the moment


==See also==
==See also==
*[[File_system_repository_FAQ|File system repository FAQ]]
* Overview of [[Repositories|Repositories]]
* Overview of [[Repositories|Repositories]]
* [http://moodle.drupalgardens.com/article/tue-06152010-1918/ftp-files-moodle-20-repository-api FTP files into Moodle 2.0 with the repository API article from moodle.drupalgardens.com] including screencast
* [http://moodle.drupalgardens.com/article/tue-06152010-1918/ftp-files-moodle-20-repository-api FTP files into Moodle 2.0 with the repository API article from moodle.drupalgardens.com] including screencast
* MDL-28656 "File system settings need clarification" tracker issue


[[Category:Repositories]]
[[Category:Site administration]]
[[de:Dateisystem-Repository]]
[[de:Dateisystem-Repository]]

Latest revision as of 08:25, 5 November 2012

The file system repository allows users within Moodle to access files which have been uploaded via FTP into designated folders on the server. A file system repository may be available site wide for everyone; within an individual course or for an individual user.(However - see this tracker entry regarding course and individual repositories)

This must be done by a systems admin who has write permissions to the server directories.

Creating folders for your file system repositories

  • Find the moodledata folder on the server
  • Inside it, create a folder called "repository"
  • Inside that folder, create as many folders as you need, named appropriately.

Moodledatarepo2.png

  • FTP into the appropriate folder the files you want. (The folders can hold all types of files)

Enabling the File System repository plugin

  • Go to Settings > Site administration > Plugins > Repositories > Manage Repositories;
  • Select from the drop down next to File sytem "Enabled and visible"

Filesystemrepo.png


Setting up a site-wide file system repository

  • Once the repository is enabled as above, click on the "Settings" link to the right.
  • Scroll down to Repositories instances of the site
  • Click Create a repository instance

Sitefilesystemrepo.png

  • Give it a name and (if there are several folders on the server) choose from the dropdown the one you want. Click save

Namedfilesystem.png

  • It will now be available in the file picker in all courses.

NOTE: Just repeat the process to get more than one site wide file system repository

Setting up a repository inside a course

NOTE: A regular user needs to have been given permission to do this by admin (MORE DETAILS SOON)

  • Go to the desired course and click on “repositories” in the administration block
  • Scroll down and click "Create File System instance"

Courseinstance.png

  • Follow the same process as here

Setting up an individual file system repository instance

NOTE: A regular user needs to have been given permission to do this by admin (MORE DETAILS SOON)

  • In the navigation block, click on “my profile”
  • Click on “repositories”
  • Scroll down and click “create File System instance”
  • Follow the same process as here
  • This will create a personal file system repository connecting just you to a folder on the server.

Privaterepo2.png

Using it

If you try to add a file in Moodle, then the File Picker should show you your new file system repository, and you should be able to browse it and select files to use.

Note that file types are respected (based on file extensions), so if you are adding an image in the editor, then you won't see Office docs (for example) appear in the File Picker.

Filesystemeg.png

Repository permissions

This repository is accessible by default to administrators, course creators, teachers, editing teachers and managers, but not to guests or students. This capability can be changed to control access to users with specific roles.

See also