Data backup with your own storage (BYOS)

When a Workspace uses your own storage (BYOS), the originals are located on your server or NAS. You are therefore responsible for the backup yourself. This article shows what is stored where and which backup covers what.

What is stored where

  • On your NAS: the original files of the Workspaces as .pod files in the folder of the Storage Mounts, distributed across subfolders. The file names are technical identifiers, not the original file names.
  • Encryption: Each .pod file is encrypted with your encryption password (AES-256). The .pod files are 7z archives. They can also be opened independently of PaperOffice using 7-Zip and your password.
  • In PaperOffice AI: everything the app knows about a document, for example title, document type, data fields, and recognized text. This information is not contained in the .pod files.

Securing the encryption password

When creating a BYOS storage, you set the encryption password. The mount can only be saved once you have secured the MasterKey with Download as .txt.

  • Keep this file separate from the NAS, for example in a password manager.
  • Without the password, the .pod files cannot be opened outside of PaperOffice. The app will no longer display the password later, and it cannot be changed after creation. If it is lost, there is no recovery.
  • If you re-mount a folder that already contains encrypted PaperOffice files, the dialog reports Existing BYOS-Storage detected. Then enter the original password or use Upload MasterKey file.

Replication: a second storage as a mirror

A replication target is another BYOS-Storage Mount. Every file operation (upload, delete, copy) is transferred in the background to all active replication targets. If a transfer fails, it is retried later.

Requirements:

  • Primary storage and replication target are BYOS-Storage Mounts with SFTP and both are active.
  • Replication is not possible with Reverse SSH, neither as primary storage nor as a target. There is no replication for import sources.
  • A replication target cannot have its own replication targets.
  • How many Storage Mounts you can create depends on your plan.

How to set up a replication target:

  1. Create the second target under Document AI → Storage Mounts as BYOS storage with SFTP.
  2. Click the name of the main mount.
  3. Open the Replication tab.
  4. Click on Add replication target, select the target, and confirm with Add.

Good to know:

  • The target receives the same encrypted files. Therefore, the same encryption password applies.
  • When adding a target, existing files are not automatically copied over. File operations will be transferred afterward.
  • New documents are always written to the primary storage first. If it is unreachable, saving will fail.
  • A replication target is a second copy of your files. Do not expect to continue working via the replication target in case of primary storage failure: once the primary storage is detected as unreachable, opening originals and saving new documents will fail until it becomes reachable again.
  • Removing a replication target leaves the files intact on that target.

What a NAS backup does and does not do

Backing up the folder on your NAS, for example using the NAS backup app or to a second device, copies the encrypted .pod files.

  • It protects the originals against failure or defect of the NAS.
  • It is only useful in conjunction with the encryption password.
  • It does not contain metadata, data fields, or folder structure from PaperOffice AI. The names of the .pod files are technical identifiers.
  • Replication also transfers deletions. Therefore, it does not protect against accidental deletion. For that, you need a backup with older version states.

Recommendation

  1. Store the MasterKey file in a second, secure location.
  2. Regularly back up the folder of the Storage Mounts with version states.
  3. Set up replication if your storage is connected via SFTP.
  4. Regularly export using Export data in Data + Originals mode. This allows you to obtain originals with readable names and a table of your metadata. The help article "Export documents from PaperOffice AI" describes the steps.

Further reading