Vault - Site backup and migration
Versions
Current version
4.5.1 (2026051200)
4.5.1
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2026051200
Version release name: 4.5.1
Maturity: Stable
Supported Moodle versions: 4.5, 5.0, 5.1, 5.2
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v4.5.1
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[4.5.1] - 2026-05-12
Fixed
- Restore plugins pre-check no longer fails on version mismatches for plugins listed in the
restorepreservepluginssetting, since those plugins are skipped during restore.
[4.5.0] - 2026-04-18
Changed
- Bumped minimum supported Moodle version to 4.5. Older Moodle versions (pre-4.5)
are supported for backup only and continue to receive updates under the 3.9.x
version numbering series. - Start backup, start restore and dry-run popups have been converted to proper
dynamic forms. - Refactored upgrade classes to use a shared base class.
Added
- Support for Moodle 5.2.
- Built-in upgrade steps to upgrade to Moodle 4.4 (requirement for Moodle 5.2)
Removed
- Legacy API key check form (no longer needed on Moodle 4.5+).
- Other legacy code paths that were only required for pre-4.5 versions of Moodle.
Fixed
- Fixed fully qualified exception class name in restore model and site_restore.
[3.9.16] - 2026-03-02
Fixed
- Fixed wildcard pattern matching in the backup exclude tables setting #21
- Fixed "Show backtrace" link toggling wrong section when multiple errors are displayed #5
- Fixed orphaned temporary directories causing debugging messages in PHPUnit tests #18
- Coding style fixes to comply with the latest version of moodle-plugin-ci
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.18 (2026030202)
3.9.18
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2026030202
Version release name: 3.9.18
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v3.9.18
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.18] - 2026-05-12
Fixed
- Restore plugins pre-check no longer fails on version mismatches for plugins listed in the
restorepreservepluginssetting, since those plugins are skipped during restore.
[3.9.17] - 2026-04-18
Fixed
- Changed reference to namespaced moodle_exception class not available in the old Moodle versions
[3.9.16] - 2026-03-02
Fixed
- Fixed wildcard pattern matching in the backup exclude tables setting #21
- Fixed "Show backtrace" link toggling wrong section when multiple errors are displayed #5
- Fixed orphaned temporary directories causing debugging messages in PHPUnit tests #18
- Coding style fixes to comply with the latest version of moodle-plugin-ci
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
4.5.0 (2026041800)
4.5.0
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2026041800
Version release name: 4.5.0
Maturity: Stable
Supported Moodle versions: 4.5, 5.0, 5.1, 5.2
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v4.5.0
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[4.5.0] - 2026-04-18
Changed
- Bumped minimum supported Moodle version to 4.5. Older Moodle versions (pre-4.5)
are supported for backup only and continue to receive updates under the 3.9.x
version numbering series. - Start backup, start restore and dry-run popups have been converted to proper
dynamic forms. - Refactored upgrade classes to use a shared base class.
Added
- Support for Moodle 5.2.
- Built-in upgrade steps to upgrade to Moodle 4.4 (requirement for Moodle 5.2)
Removed
- Legacy API key check form (no longer needed on Moodle 4.5+).
- Other legacy code paths that were only required for pre-4.5 versions of Moodle.
Fixed
- Fixed fully qualified exception class name in restore model and site_restore.
[3.9.16] - 2026-03-02
Fixed
- Fixed wildcard pattern matching in the backup exclude tables setting #21
- Fixed "Show backtrace" link toggling wrong section when multiple errors are displayed #5
- Fixed orphaned temporary directories causing debugging messages in PHPUnit tests #18
- Coding style fixes to comply with the latest version of moodle-plugin-ci
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.17 (2026030201)
3.9.17
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2026030201
Version release name: 3.9.17
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v3.9.17
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.17] - 2026-04-18
Fixed
- Changed reference to namespaced moodle_exception class not available in the old Moodle versions
[3.9.16] - 2026-03-02
Fixed
- Fixed wildcard pattern matching in the backup exclude tables setting #21
- Fixed "Show backtrace" link toggling wrong section when multiple errors are displayed #5
- Fixed orphaned temporary directories causing debugging messages in PHPUnit tests #18
- Coding style fixes to comply with the latest version of moodle-plugin-ci
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.16 (2026030200)
3.9.16
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2026030200
Version release name: 3.9.16
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v3.9.16
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.16] - 2026-03-02
Fixed
- Fixed wildcard pattern matching in the backup exclude tables setting #21
- Fixed "Show backtrace" link toggling wrong section when multiple errors are displayed #5
- Fixed orphaned temporary directories causing debugging messages in PHPUnit tests #18
- Coding style fixes to comply with the latest version of moodle-plugin-ci
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.15 (2025100900)
3.9.15
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025100900
Version release name: 3.9.15
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0, 5.1
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v3.9.15
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.15] - 2025-10-09
Added
- Support for Moodle 5.1
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.14 (2025073000)
3.9.14
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025073000
Version release name: 3.9.14
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v3.9.14
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.14] - 2025-07-30
Changed
- Changed plugin name to "Vault - Site backup and migration" to better reflect its purpose.
- Button style changes, changes in README file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
3.9.13 (2025051000)
3.9.13
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025051000
Version release name: 3.9.13
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch: MOODLE_39_STABLE
Repository tag: v3.9.13
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[3.9.13] - 2025-05-10
Changed
- New version numbering scheme. The version number now has format X.Y.Z, where:
- X.Y is the minimum supported version of Moodle (for example, 3.9)
- Z is the version of the plugin within this series
Maximum supported version of Moodle can be found in the version.php file, for example
$plugin->supported = [39, 500];means that the plugin will work on Moodle 3.9 to 5.0.
Fixed
- Do not analyse plugins in restore pre-check if the backup is from a higher version of Moodle
- Small fixes to the db schema check when the backed up site had incorrect field types
- Add delay between retries when uploading/downloading files to/from cloud storage
or contacting Vault API.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.12 (2025040300)
2.12
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025040300
Version release name: 2.12
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 5.0
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.12
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.12] - 2025-04-03
Fixed
- Exception in built-in upgrade when some users have "social" fields
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.11 (2025033100)
2.11
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025033100
Version release name: 2.11
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.11
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.11] - 2025-03-31
Added
- Support for Moodle 5.0 and PHP 8.4. Upgrade scripts to support the new version.
Fixed
- Some ad-hoc tasks were not properly scheduled during the built-in upgrade
- Disable caches during the built-in upgrade
- Prevent debugging messages during the built-in upgrade (see also MDL-77237)
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.10 (2025031400)
2.10
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2025031400
Version release name: 2.10
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.10
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.10] - 2025-03-14
Added
- Allow to resume a restore that failed during datadir or files stages. For restores that
require upgrade step, the restore can only be resumed from the CLI, since cron will not
run if an upgrade is pending.
Fixed
- Improved required temporary disk space calculation for very small backups
- Improved server error logging when "Mysql has gone away" and can't write to database
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.9 (2024111701)
2.9
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024111701
Version release name: 2.9
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.9
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.9] - 2024-11-17
Fixed
- Correction to the additional header 'X-Tool-Vault: true'
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.8 (2024111700)
2.8
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024111700
Version release name: 2.8
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.8
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.8] - 2024-11-17
Fixed
- Fixed built-in upgrade from 3.11 to 4.5 (exception about undefined function
upgrade_delete_orphaned_file_records()) - Better error message during disk space pre-check if any paths inside dataroot
are not readable - When function
free_disk_space()is not available, use a fallback to check if
there is enough space in the temp directory for backup or restore.
Added
- Allow to backup and restore char fields longer than 1333 symbols, even though
Moodle does not normally allow them. - Additional header 'X-Tool-Vault: true' when vault puts the site in maintenance
mode during backup or restore.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.7 (2024101800)
2.7
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024101800
Version release name: 2.7
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.7
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.7] - 2024-10-18
Added
- Shutdown handler to detect if the process was interrupted.
- Capture all output and show in the vault log.
- Setting to force developer debugging during backup/restore.
Fixed
- Fixed error when restoring data into tables with reserved words as fields if backup and
restore sites are on different database engines (mysql/postgres). - Improved warning message about operation timeout and restoring access to the site.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.6 (2024101300)
2.6
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024101300
Version release name: 2.6
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.6
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.6] - 2024-10-13
Added
- Callback to allow custom distributions to execute code after each table is restored #17
- Setting to change the zip compression level at the backup
Fixed
- Files over 5Gb were rejected by the storage provider. They are now uploaded using
multipart upload.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.5 (2024100600)
2.5
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024100600
Version release name: 2.5
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.5
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.5] - 2024-10-06
Added
- Pre-check for both backup and restore checking the PHP setting max_execution_time.
Fail if it is under one hour, warn if it has a limit. - Support for Moodle 4.5
Fixed
- Moved missing plugins information on the top of pre-check results
- Added lang string for 'API key' and changed quotes for some lang strings to
work around AMOS import bug #14
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.4 (2024092400)
2.4
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024092400
Version release name: 2.4
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.4
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.4] - 2024-09-24
Fixed
- Fixed failing restore pre-check when restoring into a higher Moodle version where
some standard plugins were removed.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.3 (2024092200)
2.3
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024092200
Version release name: 2.3
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.3
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.3] - 2024-09-22
Added
- CHANGE OF DEFAULT BEHAVIOR! New setting "Allow restore with missing plugins", when
disabled (default), the restore pre-check will fail if there are plugins in the backup
that are not present on this site. - Setting to preserve admin password after restore
- Improved logging of the database restore progress (showing restored size rather than
number of tables). - Increased size of batches when inserting data in the DB taking into account
mysql config variable max_allowed_packet
Fixed
- Migrated after_config callback to hook for Moodle 4.5
- Do not schedule backup precheck in unittests and behat, improving test performance #12
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.2 (2024081900)
2.2
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024081900
Version release name: 2.2
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.2
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.2] - 2024-08-19
Fixed
- Avoid exception when the field type in the actual database does not match definition
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.1 (2024061200)
2.1
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024061200
Version release name: 2.1
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.1
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.1] - 2024-06-12
Fixed
- Fixed error in the "uninstall missing plugins" script when it is executed right after
upgrade - Improved performance by skipping compression of the files that are already compressed
(for example, zip, jpg, mbz, mp4, etc). It may very slightly increase the backup size
however it will noticeably reduce the time needed to create archives.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
2.0 (2024061000)
2.0
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024061000
Version release name: 2.0
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v2.0
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[2.0] - 2024-06-10
Added
- Setting to run upgrade as part of the restore process. When selected, Vault will upgrade
from any version that it supports, which means the upgrades directly from 3.9 -> 4.3 will be
possible without the need to upgrade to intermediate version (by itself Moodle 4.3 can only
upgrade from 3.11.8 or later). - This also allows to run "uninstall missing plugins" script after any restore.
- Added "Tools" section and the "Uninstall missing plugins" as a tool that can be run
independently.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
1.9 (2024050500)
1.9
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024050500
Version release name: 1.9
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.9
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[1.9] - 2024-05-05
Added
- Improvements to the CLI backup/restore, allow to run backup pre-check from CLI
- Setting to disable web access to tool_vault and execute from CLI only
Fixes
- Fixes to README file and automated tests
[1.8] - 2024-04-30
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
[1.7] - 2024-04-24
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
1.8 (2024043000)
1.8
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024043000
Version release name: 1.8
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.8
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Fixed
- Changed wording for backups with passphrases and a number of other strings
- Fixes to coding style to comply with the latest version of moodle-plugin-ci
1.7 (2024042400)
1.7
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024042400
Version release name: 1.7
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3, 4.4
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.7
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Added
- Possibility to choose where in which region to store your data during backup (for eligible plans)
- Possibility to choose expiration date during backup
- Explanation of the restrictions on the backup screen (for plans with restrictions)
- Reminder to refresh the progress page to see the updated logs
Fixed
- Do not automatically uninstall missing plugins if an upgrade is pending - it can cause exceptions
and plugins can be left in half-deleted state that is hard to fix. - Small fixes to exception messages
- Validate the S3 domain only if S3 encryption headers are sent
1.6 (2024040900)
1.6
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024040900
Version release name: 1.6
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.6
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Changelog
All notable changes to the tool_vault plugin will be documented in this file.
[1.6] - 2024-04-09
Added
- Improve how extra/invalid tables are reported, allow to exclude them in one click
Fixed
- Removed excessive validation checks, some plugins have
datetimecolumns, it is allowed in xmldb
but reported as error in the "Database check" in Moodle. Vault should allow them. - Fixed exceptions when table names contain characters that Moodle does not allow (i.e.
mdl_tablename-old)
[1.5] - 2024-04-07
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
[1.0] - 2024-03-16
Initial release
1.5 (2024040700)
1.5
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024040700
Version release name: 1.5
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.5
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Added
- Ability to restore into a higher major version of Moodle
Fixed
- Display more details when backup or restore pre-checks fail, send error backtrace to the server
1.4 (2024032900)
1.4
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024032900
Version release name: 1.4
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.4
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
[1.4] - 2024-03-29
Fixed
- Quoting names of the columns that are reserved words (for example, there is a database column
'count' in the local_wunderbyte_table plugin)
1.3 (2024032700)
1.3
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024032700
Version release name: 1.3
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.3
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
[1.3] - 2024-03-27
Fixed
- Prevent curl from sending Authorization header to AWS S3 where it is not needed and
causes an error. - Improved error reporting
1.2 (2024032500)
1.2
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024032500
Version release name: 1.2
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.2
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
[1.2] - 2024-03-25
Fixed
- Catch exceptions when building list of database modifications, since some plugins
may have errors in the schema (i.e. block_grade_me)
1.1 (2024032400)
1.1
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024032400
Version release name: 1.1
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.1
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
[1.1] - 2024-03-24
Added
- Privacy provider notification that the site is backed up to the external location
- Syntax validation for submitted API key
1.0 (2024031600)
1.0
Plugin type: Administration tools
Frankenstyle component name: tool_vault
Version build number: 2024031600
Version release name: 1.0
Maturity: Stable
Supported Moodle versions: 3.10, 3.11, 3.9, 4.0, 4.1, 4.2, 4.3
Repository URL (Git): https://github.com/lmscloud-io/moodle-tool_vault
Repository branch:
Repository tag: v1.0
Issue/bug tracker URL: https://github.com/lmscloud-io/moodle-tool_vault/issues
Vault allows you to make a full backup of the site, push it to the cloud and then restore on the other Moodle site.
See also https://lmsvault.io/
Features:
- Vault will export and import database structure, schema modifications, tables content and sequences.
- Vault can restore not only into a different DB version but also into a different DB type
(i.e. from mysql to postgres or vice versa); - Vault plugin does not need to have access to mysqldump or pgdump, database will be exported using Moodle DML.
- Vault will export and import all files, regardless of the file system (local disk, S3, etc), the file
system on the restored site can be different from the backup site; - Vault will export and import additional folders in the dataroot.
- After restore Vault will perform some necessary post-restore actions, for example, purge caches, kill all
sessions, optionally reset site identifier, optionally uninstall missing plugins etc. - Vault does not back up or restore Moodle code or add-on plugins code.
- Vault does not back up or restore its own tables.
- Other plugins can also be excluded during backup/restore (with some limitations).
- You may choose to set passphrase during backup which will be used to encrypt uploaded
files. Vault API never has access to your passphrase, it is only used to sign the
requests to AWS S3.
Requirements:
- The site where you restore also has to have Moodle installed, it can be a fresh installation;
- Plugin tool_vault has to be installed on both sites - where you backup and where you restore;
- The site where you are restoring has to have the same or higher Moodle version than the backup site;
- Supported databases - postgres, mysql and mariadb. Other database types are not yet supported;
- There are some restrictions on database modifications, see below;
- You need to have enough space in your temp folder on the backed up site and enough space to store
downloaded files on the site where you plan to restore.