diff --git a/blog/2024/09-23-version-1.0/index.mdx b/blog/2024/09-23-version-1.0/index.mdx index d0f32168..d02a58c2 100644 --- a/blog/2024/09-23-version-1.0/index.mdx +++ b/blog/2024/09-23-version-1.0/index.mdx @@ -13,6 +13,8 @@ This will be a one time occurrence and version > ``1.0`` will have less breaking This time more important than every; **read the breaking changes** list and **create a backup** before updating. Some third party installation methods may take multiple days or weeks to update to the new version. +See [this guide on how to import your previous Homarr dashboard](/docs/getting-started/after-the-installation#importing-a-zip-from-version-before-100) + ## Changes at a glance - **Asynchronous integrations system**: In versions prior to ``1.0``, we fetched data upon each request synchronously. This means that the user had to wait for the requests to finish so any data would appear. diff --git a/docs/getting-started/after-the-installation.mdx b/docs/getting-started/after-the-installation.mdx index e4ae6723..baf55b42 100644 --- a/docs/getting-started/after-the-installation.mdx +++ b/docs/getting-started/after-the-installation.mdx @@ -14,6 +14,10 @@ import manageBoardHeaderEditMode from "./img/manage-board-header-edit-mode.png"; import manageBoardHeaderAddItem from "./img/manage-board-header-add-item-menu.png"; import manageBoardHeaderChooseItem from "./img/manage-board-header-choose-item.png"; import manageBoardNoApp from "./img/manage-board-no-app.png"; +import manageExportOldHomarr from "./img/old-homarr-export-data.png"; +import manageImportOldHomarrDropzone from "./img/old-homarr-import-dropzone.png"; +import manageImportOldHomarrChooseData from "./img/old-homarr-import-choose-imported-data.png"; +import manageImportDecryptionToken from "./img/old-homarr-import-decryption-token.png"; :::tip @@ -73,7 +77,19 @@ We recommend you to continue with the section [creating your first board on this This is recommended when you used Homarr before and want to re-import your data. It is important that you first migrate correctly using [the list of breaking changes for 1.0](/blog/2024/09/23/version-1.0). -// TODO: Meierschlumpf +Export from old Homarr + +**How to export and import data** +1. Navigate to your old Homarr, open your management pages, open the tools submenu and open ``Migrate to 1.0``. +2. Check the contents that you want to export. We recommend you to export all data. +3. Click on the export data button +4. Save the ZIP file, that is being downloaded, on your device. If you selected "integrations" or "users", you also get an encryption / decryption key. +Copy it and do not loose it! +5. Go to your new >1.0.0 Homarr instance and start the onboarding. Choose ``Import from Homarr before 1.0`` +6. Drag and drop your previously downloaded ZIP archive into the file upload:
+7. Next, choose the data that you want to import and how to import it. Since screen sizes were removed in 1.0, we create a new board for every screen size by default. We recommend you to only keep the best layout and adjust it later in 1.0.0 - but you can also import all of them and pick later.
+8. If you previously exported integrations or users, you will be asked to decrypt the data safely using your obtained encryption token. Paste into the modal and confirm your action.
+9. Next, you can [follow the same setup as when starting from scratch](#starting-from-scratch). After you completed the onboarding, all of your data will be migrated and available. ## Creating your first board In Homarr, you organize your apps and widgets on boards. diff --git a/docs/getting-started/img/old-homarr-export-data.png b/docs/getting-started/img/old-homarr-export-data.png new file mode 100644 index 00000000..2cd32d95 Binary files /dev/null and b/docs/getting-started/img/old-homarr-export-data.png differ diff --git a/docs/getting-started/img/old-homarr-import-choose-imported-data.png b/docs/getting-started/img/old-homarr-import-choose-imported-data.png new file mode 100644 index 00000000..d0d2de39 Binary files /dev/null and b/docs/getting-started/img/old-homarr-import-choose-imported-data.png differ diff --git a/docs/getting-started/img/old-homarr-import-decryption-token.png b/docs/getting-started/img/old-homarr-import-decryption-token.png new file mode 100644 index 00000000..4ff3ecd3 Binary files /dev/null and b/docs/getting-started/img/old-homarr-import-decryption-token.png differ diff --git a/docs/getting-started/img/old-homarr-import-dropzone.png b/docs/getting-started/img/old-homarr-import-dropzone.png new file mode 100644 index 00000000..1c0c3da6 Binary files /dev/null and b/docs/getting-started/img/old-homarr-import-dropzone.png differ