Moodle Setup


Before you begin, you'll need to have an active Coursebank account. Sign up for a free account here:

The Coursebank Moodle plugin can be found on at:

The simplest method of installing the plugin is to choose "Download" on the right hand side of the Moodle plugin page. Once you've done this, unzip the Coursebank code and copy it to the admin/tool/coursebank directory within your Moodle codebase. On most modern Linux systems, this can be accomplished with:

cp -r coursebank <your_moodle_directory>/admin/tool/coursebank

Once you've copied the plugin, you can finish the installation process by logging into your Moodle site as an administrator and visiting the "notifications" page:


Your site should prompt you to upgrade.


Once the installation process is complete, you'll be prompted to fill in some configuration details. You can also find the Coursebank configuration page again at any time via the Moodle administration block:

Site Adminstration -> Plugins -> Admin tools -> Course Bank

To begin with, you'll want to set the Target URL and Authentication token. These will be provided to you as part of the process of setting up your Coursebank account. If your Moodle installation is fairly straightforward, you might be able to stop there. Save your changes and navigate to the Coursebank configuration page.

Test your connection

After you have set the Target URL and Authentication token, go to the top of the page and

  • click on the Check connection button
    • This will test that you can successfully connect to Coursebank
  • ​then click on the Test Transfer Speed button
    • ​This will establish a recommended chunk size for backup file transfers to Coursebank

Testing connection and speed.

Testing connection and connection speed.

Additional configuration options:

There are a few other configuration options which aren't essential, but which you can use to further tailor your Coursebank installation to your needs.


You can use this to enable and disable the plugin without having to uninstall it.

Chunk size:

This setting can be used to optimise your backup transfer speed. The default of 500kB should work well for most sites. If you'd like to tweak this setting to improve backup transfer times, click on the Test transfer speed button at the top of the page to find a suggested chunk size which will work best with your site.

Use external cron:

By default, the Coursebank module will check for new backup files to transfer with every run of the Moodle cron. This happens every minute for most modern Moodle sites (you can learn more about the Moodle cron here: If you'd like more control over when the Coursebank module checks for and transfers backups, you can enable this setting and set up your own external cron process to run the Coursebank sync. This setting is intended for more hands-on Moodle site adminstrators that like to carefully configure their Moodle environment.

Delete local backups:

If this setting is enabled, backup files will be removed from your server as soon as they are safely backed up to Coursebank. This setting can be enabled to free up space on your Moodle server.

Proxy configuration:

If your Moodle site is hosted within a network environment that requires a proxy for outbound internet access, you can configure Coursebank to work over this proxy. Your network administrator should be able to provide you with the necessary proxy configuration details.

Configuring your backup schedule

Go to your Moodle's automated backup settings page:

Site Adminstration->Courses->Backups->Automated backup setup

Ensure the following settings have been configured:


Set this to Enabled or  Manual.  If you choose Manual you will need to ensure that you schedule Moodle's automated backup cli script to run on your server.


Choose which days of the week you want the automated backups to be performed.

Automated backup storage:

Set this to either 

  • Course backup filearea or 
  • Course backup filearea and the specified directory

Coursebank does not support the Specified directory for automated backups option.   

Automated backup settings

Automated backup settings page.

Getting your backups from Coursebank

To access your backups go to:

Site Administration -> Courses -> Backups -> Course Bank -> Download backups

The download backups page will list all your backups currently in Coursebank.

Listing backups

You can then download by clicking on the download icon in the Action column:

Downloading backups