summaryrefslogtreecommitdiffstats
path: root/docs/_old_mediawiki/Data-migration-tool.mediawiki
diff options
context:
space:
mode:
authorLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 14:10:24 +0100
committerLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-06 14:11:42 +0100
commit0aac85ff5c27e98564243a9f43ae58685bd18ff2 (patch)
tree1146693fe615b85be35447cd9fd2457ce1f3d180 /docs/_old_mediawiki/Data-migration-tool.mediawiki
parent4c9a7d83a19828e64ea7f90ddf69f9212bb7a7d9 (diff)
Migrate docs to GitHub pages
Diffstat (limited to 'docs/_old_mediawiki/Data-migration-tool.mediawiki')
-rw-r--r--docs/_old_mediawiki/Data-migration-tool.mediawiki13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/_old_mediawiki/Data-migration-tool.mediawiki b/docs/_old_mediawiki/Data-migration-tool.mediawiki
new file mode 100644
index 00000000..909e29ef
--- /dev/null
+++ b/docs/_old_mediawiki/Data-migration-tool.mediawiki
@@ -0,0 +1,13 @@
+The '''data migration tool''' is a tool that allows you to migrate your data from one [[Storage providers|storage provider]] to another. This can also be used as a backup tool. The tool can be accessed using <code>/quests admin migratedata</code>, which will generate a file [https://github.com/LMBishop/Quests/blob/master/bukkit/src/main/resources/resources/bukkit/migrate_data.yml migrate_data.yml], where you must configure both providers.
+
+The <code>from</code> section is the configuration for the storage provider you are migrating from. The <code>to</code> section is the configuration for the storage provider you are migrating to. Both sections are required.
+
+When you have entered the information for both systems, you must set the <code>ready</code> flag to '''true''' at the end of the file. Then, to execute the migration, run the following command:
+
+```
+ /quests admin migratedata execute
+```
+
+: ⚠️ '''It is advised that you do this process on a server with no players online.''' You should set a whitelist, or turn on maintenence mode, before migrating data, and these commands should be done through your server console. Trying this process with players online may result in unexpected behaviour, or worse, potential data corruption!
+
+Once the migration has finished, you can safely delete migrate_data.yml. You may also want to manually update your main configuration to point to the new data provider. \ No newline at end of file