Skip to content

πŸ“š The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.

2.8 KB
Raw Blame

title: Imports, exports, and backups description: Migrate, restore, and preserve an Alexandrie instance safely. navigation: icon: i-lucide-arrow-left-right

Exporting content

::warning Export service is only available if S3-storage is enabled on the instance. ::

At any time you can export a full backup of your instance or select content to export. The exported file is a compressed archive that contains:

  • a file named manifest.json that describes the structure of the archive;
  • a file named document.json that contains all of the teams, workspaces, categories, documents and resources (uploads metadata);
  • a file named file_index.json that contains a list of all the uploaded files and their metadata;
  • a fine named user_settings.json that contains the user preferences and settings;
  • a folder named files that contains all of the uploaded files.

All data are not systematically exported. That depend of the type of export you choose.

When export is completed, a secure download link is provided to retrieve the archive. You can use it or store it but your export is only available for 24 hours.

export modal

Importing content

There are two ways to import content into an Alexandrie instance:

  • Backup import: restore a full backup and let you select items to import. This is useful for migrating an instance or restoring a backup.
  • Files import: upload markdown files and media in bulk. This is useful if you have a collection of files to import into an instance.

Backup import

To restore a backup, you have to go to the import center (accessible from the sidebar or the top bar) and select the backup import option. You will be prompted to upload a backup archive.

Once uploaded, the system will read the archive and display a list of items that can be imported. You can select which teams, workspaces, categories, documents, and files you want to import or update. The system will then process the import and try to keep the tree hierarchy and metadata intact.

At this moment you can also choose to restore the user settings from the backup. This will overwrite the current user preferences and settings. Preferences include the theme, the settings, and all snippets.

import modal

Files import

To import files in bulk, you have to go to the import center (accessible from the sidebar or the top bar) and select the files import option. You will be prompted to upload files or a folder (archives are not supported here). The system will read the files and display a list of items that can be imported. You can select which files you want to import.

::note The number of files that can be imported at once can be limited. If you have a large number of files to import, you may need to split them into smaller batches. ::