diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 14:10:24 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-06 14:11:42 +0100 |
| commit | 0aac85ff5c27e98564243a9f43ae58685bd18ff2 (patch) | |
| tree | 1146693fe615b85be35447cd9fd2457ce1f3d180 /docs/tools/data-migration-tool.md | |
| parent | 4c9a7d83a19828e64ea7f90ddf69f9212bb7a7d9 (diff) | |
Migrate docs to GitHub pages
Diffstat (limited to 'docs/tools/data-migration-tool.md')
| -rw-r--r-- | docs/tools/data-migration-tool.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/tools/data-migration-tool.md b/docs/tools/data-migration-tool.md new file mode 100644 index 00000000..7c456f8e --- /dev/null +++ b/docs/tools/data-migration-tool.md @@ -0,0 +1,35 @@ +--- +title: Data migration tool +parent: Tools +--- + +# Data migration tool + +The **data migration tool** is a tool that allows you to migrate your +data from one [storage provider](../configuration/storage-providers) to +another. This can also be used as a backup tool. The tool can be +accessed using `/quests admin migratedata`, which will generate a file +[migrate_data.yml](https://github.com/LMBishop/Quests/blob/master/bukkit/src/main/resources/resources/bukkit/migrate_data.yml), +where you must configure both providers. + +The `from` section is the configuration for the storage provider you are +migrating from. The `to` 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 +`ready` flag to **true** at the end of the file. Then, to execute the +migration, run the following command: + + /quests admin migratedata execute + + +{: .warning } +**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. |
