Skip to main content

Getting started

This page takes you from your first login to your first stored backup. The order is always the same: organization, project, region, token, client.

1. Sign in to the portal​

You sign in to the customer portal via single sign-on with multi-factor authentication (TOTP). On your first login you set up your second factor.

2. Create an organization​

An organization is the top-level management unit — typically your company. Members, roles and billing are managed under it. Read more under Portal.

3. Create a project and choose a region​

Within the organization you create a project. When creating it you choose the region or storage zone in which this project's data will live. For projects with compliance requirements you enable immutable, write-protected storage (WORN) here and set the retention period.

4. Generate an access token​

For automated access through the client software you generate a project-scoped access token. A token always belongs to exactly one project and should only be used there — the anomaly detection reports use outside the intended project.

Keep the token safe

The token is shown in full only once. Store it in a secrets manager and do not share it.

5. Install the client​

Download the open-source lionbackup client for Linux or Windows. Store the access token and — if you use client-side encryption — your key material in the local configuration.

6. Start your first backup run​

The client compresses and encrypts the selected data and transfers it to an available Citadel of the chosen storage zone. If an endpoint fails during the transfer, the client automatically switches to another available Citadel.

Once finished, the backup appears in the portal with status stored. The Lifecycle of a backup describes what happens next.

Checklist​

  • Signed in to the portal, second factor set up
  • Organization created
  • Project created, region/zone chosen
  • WORN and retention period configured if needed
  • Access token generated and stored securely
  • Client installed and configured
  • First backup run successful (stored)