Renaming, changing readme

Author: marinaglancy

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the tool_vault plugin will be documented in this file.
 
+## Unreleased
+### 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:

README.md

@@ -1,52 +1,14 @@
-# Vault - Site migration #
+# Vault - Site backup and migration #
 
 Vault allows you to make a **full backup of the site**, push it to the cloud and then **restore** on any 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, the 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 be excluded during backup/restore (with some limitations).
-- All data transferred to or from tool_vault is encrypted during transit using SSL/TLS.
-- In some plans you may choose to set a passphrase during backup which will be used to encrypt data stored
-  at rest in the cloud.
-  Vault API never has access to your passphrase, it is only used to sign the
-  requests to Amazon S3.
-
-### Requirements:
-- The site where you restore must have **Moodle installed**, it can be a fresh installation;
-- Plugin **tool_vault** must be installed on both sites - where you back up and where you restore;
-- The site where you are restoring to must have the same or higher Moodle version than the backed up 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.
-
-## Site backup with Vault
-
-- Login as site administrator and navigate to **Site administration > Server > Vault - Site migration**
-- Before backup, Vault performs a number of pre-checks. They can also
-  be executed independently. The results are displayed on the 'Site backup' page.
-- Backup can be performed only when all pre-checks are successful, which means you have enough disk space,
-  and do not have (or excluded) incompatible database schema modifications. The pre-checks will run
-  again in the beginning of the backup process.
-- If you want to make changes to what needs to be backed up, you can do it in the "Settings" section.
-- When everything is ready, open the **"Site backup"** section, register with the LMSVault cloud (or enter existing
-  API key) and schedule a backup.
-- Backup will be performed during the next cron run. Every step is logged and you can monitor the process
-  on the backup page.
-
-### Protecting your backup site from accidental restores
+<p align="center"><big><big><strong>
+Find more information about Vault features at <a href="https://lmsvault.io">https://lmsvault.io</a> or <a href="https://moodle.org/plugins/tool_vault">https://moodle.org/plugins/tool_vault</a>
+</strong></big></big></p>
+
+This README file contains information for the **server administrators**.
+
+### Protecting your site from restores
 
 The ability to restore is disabled by default when `tool_vault` is installed. Restores are not
 possible if you did not register an account, did not enter an API key, or your API key does not allow restores.
@@ -58,29 +20,6 @@ $CFG->forced_plugin_settings = $CFG->forced_plugin_settings ?? [];
 $CFG->forced_plugin_settings['tool_vault'] = ['allowrestore' => 0];
 ```
 
-## Site restore with Vault
-
-- Login as site administrator and navigate to **Site administration > Server > Vault - Site migration**
-- Go to the "Settings" section and check **enable restores** on this site.
-- Enter your **API key** that you received during registration when you performed the backup.
-- In the **"Site restore"** section you will see the list of all backups that are available for you to restore.
-  This list is cached and you can refresh it at any moment to look for new backups.
-- **Choose the backup** you want to restore, execute pre-checks for it to make sure that you have enough
-  disk space and if you need to adjust the restore settings.
-- **Schedule the restore**. You will be provided with a link to the restore progress page that can be accessed
-  without authentication. Remember that during restore everything is erased from the database and
-  nobody will be able to login.
-- Remember to check **the restore log** since it may not be possible to send a notification to the person who
-  initiated restore after the restore process has finished because the site configuration will be overridden
-  with the config of the backed up site.
-- **After restore** has completed, login with the username and password of a user from the backed up site
-  (remember that the users table in the database was replaced).
-- If your site version is higher than the version of the restored site or you have plugins that were not
-  present on the restored site, you will be prompted to run the **upgrade process**.
-- If the backed up site had **plugins** that are not present on the restored site, all database tables, settings,
-  and files of these plugins will be restored and Moodle will report them as **"Missing from disk"**. You will
-  need to install these plugins code yourself.
-
 ## Backup and restore of site configuration
 
 - As part of backing up the database, Vault backs up the **tables 'config' and 'config_plugins'**.
@@ -91,21 +30,7 @@ $CFG->forced_plugin_settings['tool_vault'] = ['allowrestore' => 0];
   backed up in the **"Config overrides" pre-check** on the backed up site.
 - On the restored site if there is anything set in **config.php** it will take precedence over the restored
   config settings values.
-- Vault does not backup or restore `cache`, `localcache`, or `muc` directories in the dataroot.
-
-## Backup and restore of database modifications
-
-- As part of the **"Database modifications" pre-check** Vault analyses the actual database and compares it
-  with the schema definitions in install.xml files in Moodle core, standard and add-on plugins.
-- There are the following **types** of possible database modifications: extra tables, missing tables, extra
-  indexes, missing indexes, extra table fields, missing table fields, modified table fields.
-- Note that not all **field modifications** can be detected, for example, changing the length or precision
-  of the int/double/float fields.
-- Some database modifications are not supported in the Moodle DML, for example, indexes
-  on text fields, varchar fields with length over 1333. If you have such modifications, the pre-check
-  will fail and Vault **will not be able to perform backup**.
-- In the "Settings" section you can specify that some **modifications should be excluded**. You can re-run
-  the pre-check after you modified the settings to see if it passes.
+- When you exclude plugins from backup or choose to preserve plugin data during restore, the settings from these plugins will not be backed up or restored.
 
 ## CLI access
 

db/hooks.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Hook callbacks for Vault - Site migration
+ * Hook callbacks for Vault - Site backup and migration
  *
  * @package    tool_vault
  * @copyright  Marina Glancy

lang/en/tool_vault.php

@@ -175,7 +175,7 @@
 $string['lastupdated'] = 'Last updated';
 $string['loginexplanation'] = 'Create an account on {$a} to be able to backup or restore the site. With the <b>free account</b> you will be able to backup and restore small sites and store them up to 7 days in the cloud.';
 $string['manageremoteaccount'] = 'Manage your account';
-$string['messageprovider:statusupdate'] = 'Status update for Vault - Site migration';
+$string['messageprovider:statusupdate'] = 'Status update for Vault - Site backup and migration';
 $string['moodleversion_backupinfo'] = 'Backup made in version {$a->version} (Moodle {$a->branch})';
 $string['moodleversion_fail'] = 'Site version number has to be greater than or equal to the version in the backup. This backup is {$a->version} and this site is {$a->siteversion}';
 $string['moodleversion_fail_cannotupgrade'] = 'Restore is blocked because Moodle cannot upgrade from {$a->backuprelease} to {$a->currentrelease}. See the <a href="{$a->url}">environment page</a> for upgrade requirements. Vault is able to upgrade from this version if you choose "Automatically upgrade Moodle after restore" in the <a href="{$a->settingsurl}">settings</a>.';
@@ -239,11 +239,11 @@
 $string['settings_backupexcludetables'] = 'Exclude tables';
 $string['settings_backupexcludetables_desc'] = 'Vault will back up all tables that start with the prefix \'{$a->prefix}\' even if they are not listed in xmldb schemas of the core or installed plugins.<br>Here you can list extra tables that should not be backed up. Use an asterisk (\'*\') to exclude all extra tables.<br>You must include the table prefix when excluding tables.';
 $string['settings_clionly'] = 'Allow to perform site backup and restore from CLI only';
-$string['settings_clionly_desc'] = 'Checking this will hide the "Vault - Site migration" from the site administration and prevent access to backup and restore. ';
+$string['settings_clionly_desc'] = 'Checking this will hide the "Vault - Site backup and migration" from the site administration and prevent access to backup and restore. ';
 $string['settings_desc'] = "Vault plugin settings where you can configure what to exclude during backup or preserve during restore.";
 $string['settings_forcedebug'] = 'Force debugging during backup and restore';
 $string['settings_forcedebug_desc'] = 'Regardless of the site configuration, developer debugging and debug display will be enabled during backup and restore. This will affect the tool vault logs only, and will not change the values for these settings that are included in the backup.';
-$string['settings_header'] = 'Vault - Site migration settings';
+$string['settings_header'] = 'Vault - Site backup and migration settings';
 $string['settings_headerbackup'] = 'Backup settings';
 $string['settings_headerrestore'] = 'Restore settings';
 $string['settings_restorepreservedataroot'] = 'Preserve paths in dataroot';

tests/behat/extended_free.feature

@@ -10,7 +10,7 @@ Feature: Performing full site backup and restore with a free account in Vault
     And the following config values are set as admin:
       | allowrestore | 1 | tool_vault |
     When I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site backup" "link" in the "region-main" "region"
     And I press "Start backup"
     And I wait until "Automatically expire backup after" "field" exists
@@ -26,7 +26,7 @@ Feature: Performing full site backup and restore with a free account in Vault
     And I should see "Backup finished"
     # Restore pre-check
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Refresh" "link" in the "region-main" "region"
     And I click on "Run pre-check" "button" in the row of my vault backup
@@ -39,18 +39,18 @@ Feature: Performing full site backup and restore with a free account in Vault
     And I log out
     # Restore
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Restore this backup" "button" in the row of my vault backup
     And I click on "Restore this backup" "button" in the "Restore this backup" "dialogue"
     And I should see "[info] Restore scheduled"
     And I wait "2" seconds
     And I run the scheduled task "tool_vault\task\cron_task"
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I should see "Restore completed"
-    And I follow "Vault - Site migration"
+    And I follow "Vault - Site backup and migration"
     And I click on "History" "link" in the "region-main" "region"
     And I click on "View details" "link" in the "Past backups on this site" "table"
     And the following should exist in the "Backup details" table:
@@ -61,7 +61,7 @@ Feature: Performing full site backup and restore with a free account in Vault
     And I follow "Expand logs"
     And I should not see "Expand logs"
     And I should see "Collapse logs"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "History" "link" in the "region-main" "region"
     And I click on "View details" "link" in the "Past restores on this site" "table"
     And the following should exist in the "Restore details" table:

tests/behat/extended_light.feature

@@ -10,7 +10,7 @@ Feature: Performing full site backup and restore with a light account in Vault
     And the following config values are set as admin:
       | allowrestore | 1 | tool_vault |
     When I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site backup" "link" in the "region-main" "region"
     And I press "Start backup"
     And I wait until "Automatically expire backup after" "field" exists
@@ -26,7 +26,7 @@ Feature: Performing full site backup and restore with a light account in Vault
     And I should see "Backup finished"
     # Restore pre-check
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Refresh" "link" in the "region-main" "region"
     And I click on "Run pre-check" "button" in the row of my vault backup
@@ -39,18 +39,18 @@ Feature: Performing full site backup and restore with a light account in Vault
     And I log out
     # Restore
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Restore this backup" "button" in the row of my vault backup
     And I click on "Restore this backup" "button" in the "Restore this backup" "dialogue"
     And I should see "[info] Restore scheduled"
     And I wait "2" seconds
     And I run the scheduled task "tool_vault\task\cron_task"
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I should see "Restore completed"
-    And I follow "Vault - Site migration"
+    And I follow "Vault - Site backup and migration"
     And I click on "History" "link" in the "region-main" "region"
     And I click on "View details" "link" in the "Past backups on this site" "table"
     And the following should exist in the "Backup details" table:
@@ -61,7 +61,7 @@ Feature: Performing full site backup and restore with a light account in Vault
     And I follow "Expand logs"
     And I should not see "Expand logs"
     And I should see "Collapse logs"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "History" "link" in the "region-main" "region"
     And I click on "View details" "link" in the "Past restores on this site" "table"
     And the following should exist in the "Restore details" table:
@@ -89,7 +89,7 @@ Feature: Performing full site backup and restore with a light account in Vault
       | restorepreservepasswords | admin | tool_vault |
     # Restore pre-check
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Refresh" "link" in the "region-main" "region"
     And I click on "Run pre-check" "button" in the row of my vault backup
@@ -100,7 +100,7 @@ Feature: Performing full site backup and restore with a light account in Vault
     And I log out
     # Restore
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I click on "Restore this backup" "button" in the row of my vault backup
     And I click on "Restore this backup" "button" in the "Restore this backup" "dialogue"
@@ -110,10 +110,10 @@ Feature: Performing full site backup and restore with a light account in Vault
     And I reload the page
     And I should see "Completed" in the "Status" "table_row"
     And I log in as "admin"
-    And I navigate to "Server > Vault - Site migration" in site administration
+    And I navigate to "Server > Vault - Site backup and migration" in site administration
     And I click on "Site restore" "link" in the "region-main" "region"
     And I should see "Restore completed"
-    And I follow "Vault - Site migration"
+    And I follow "Vault - Site backup and migration"
     And I click on "History" "link" in the "region-main" "region"
     And I click on "View details" "link" in the "Past restores on this site" "table"
     And the following should exist in the "Restore details" table: