Backup and restore

Download everything in your company, what a backup holds, and bring a deleted company back.

A backup is one ZIP file with everything in your company. With it you can delete the company knowing you can bring it back exactly as it was — and without it, nobody can.

Download a backup

An admin downloads it under Settings → Backup:

  1. Choose Prepare a backup. Coready gathers everything in the background and shows its progress; you can leave the page meanwhile.
  2. When it is ready, choose Download backup. Your browser saves one ZIP file, named after your company and the time it was made.

A prepared backup can be downloaded for 24 hours. Preparing a new one replaces it. Coready keeps no copy: the file you download is the backup.

The backup is one moment of your company: every record is read at the same instant, even while your team keeps working.

What a backup holds

Everything needed to restore the company and its websites:

  • Catalog: products, variants, categories, manufacturers, options and their values, prices and price types, quantity prices, custom fields, product lists, currencies.
  • Sales: customers and orders.
  • Websites: their settings, design and languages, pages, documents with their history, blogs and articles, their addresses, and which products and categories each one shows.
  • Files: every uploaded file — product pictures, documents and the websites' files.
  • The company: its name and settings, its team and their roles, the modules it uses and their settings, and its activity log.
  • Billing: the balance and its full history, invoices, the plan and until when it is paid, purchases, the payment card's details (never its number), billing details, and access to paid modules.
  • Coready AI: every member's conversations, with their pictures — encrypted (see below).

What a backup leaves out

Only what would let someone into your company or into a person's account:

  • Passwords and keys of connected services (an inventory system's password, an import's API key, a mail server's password). After a restore, enter them again in the module's or the mail settings.
  • API keys. Create new ones after a restore.
  • Invitations not yet accepted. Invite those people again.
  • People's sign-in. Everyone signs in with their own account, which is never part of a company.

Keep it safe

The backup holds your customers' details, your orders and your billing details: keep it where only you can reach it.

Your team's Coready AI conversations are encrypted inside the file. Whoever has the file cannot read them — not even the admin who downloaded it. Only Coready reads them, when it restores the company.

Every backup is signed by Coready, and the signature covers every byte of the archive: each table, each picture, the list of files, the README. A backup with anything changed, added or removed — one letter in a record, one picture swapped, one file more — is refused as a whole, so nobody can use a backup to slip in data, set a balance or reach someone else's company.

Restore a company

A backup restores a company that was deleted:

  1. Sign in with the account that owned the company.
  2. Open Restore a company from a backup — from the company picker, or from Settings → Backup in any company you still have.
  3. Choose the backup file and Restore company. The file is uploaded (with its progress), checked, and restored in the background; you can leave the page.
  4. When it is done, Open the company.

The company comes back as it was when the backup was made: the same records, websites and their addresses, files, team and roles, invoices and Coready AI conversations. Members find it in their company list again. Then enter the passwords and keys of connected services again — Coready lists which ones.

Your balance, plan and its end date, paid modules and included Coready AI come back as they were when you deleted the company, not as the backup says — Coready knows them. Restoring an older backup brings back its records, never money or time already used.

What a restore cannot do:

  • Restore over a company that still exists. Delete it first; a backup brings back a deleted company, it does not undo changes.
  • Use a changed backup, or one made by another Coready installation.
  • Bring back a person who no longer has an account. Their membership, their Coready AI conversations and their usage records are left out; everything else comes back. Coready says what it left out.
  • Reopen top-up invoices. Invoices still open when the company was deleted are cancelled then; ask for a new top-up after the restore.

If Coready refunded your balance after the deletion, the refund is taken off the restored balance. If Coready has no record of the company being deleted (more than 3 years have passed), the company comes back with an empty balance on the default plan; contact support.

What deleting leaves behind

Deleting a company removes everything in it. Coready keeps only what the law or a refund needs:

  • your invoices, which Coready must keep for 8 years;
  • the company's name, the owner's email address and its account as it was — balance, plan, paid modules — so support can refund the balance if you ask and a restore gets it right; for 3 years.

Inside the file

For your own tools, or to check a backup:

In the ZIPWhat it is
manifest.jsonWhat is inside: the format's version, when and by which version of Coready it was made, every table with its number of records, column types, size and checksum, what was left out and why, and the files.
signature.jsonCoready's signature of the manifest — and through its checksums, of everything else.
README.mdThis layout, in short.
data/company/The company, its team, settings, currencies, custom fields and activity log.
data/catalog/Products, categories, manufacturers, options, prices, product lists, and the files' records.
data/sales/Customers and orders.
data/websites/Websites: settings, design, pages, documents and their history, blogs, addresses.
data/billing/Your account: balance and its history, invoices, plan, purchases, card, billing details.
data/ai/Coready AI conversations, encrypted.
data/modules/<module>/A module's own records, for each module that has any.
data/shared/People, countries and plans the records point to, so a restore can match them.
files.sha256The checksum of every file below. In files/, sha256sum -c ../files.sha256 checks them.
files/products/<product id>/Each product's pictures and files, in a folder named by the product's id, which never changes.
files/categories/<category id>/Each category's files.
files/other/Your websites' files: logos, page pictures, documents.

Each table is one file, one record per line (JSON), with the records' own names and identifiers, so relationships hold. A very large table continues in Product.2.ndjson, Product.3.ndjson, … Tables without records are left out. Dates are in UTC (ISO 8601), and values plain JSON cannot hold are written as {"$date": …}, {"$decimal": …}, {"$bigint": …} or {"$bytes": …} (base64).

Your company's files are kept the same way in Coready: every product's files in its own folder. A picture used by two products is in both folders.

The format has a version. Newer versions of Coready restore backups made by older ones; a backup made by a newer version is refused until this one is updated.