From install
to your first clone.

Before you start.

• An Ubuntu VM with administrator (sudo) access. Ubuntu 24.04 LTS is the oldest supported version; Ubuntu 26.04 has also been tested.
• A dedicated, empty data disk. Setup formats this disk, so it must contain nothing you need.
• Enough host capacity for your running clones. Each clone defaults to 2 CPUs and 4 GB of memory; leave room for the host as well.
• The release version, download token, and expected checksum supplied by your eddb contact, plus an eddb license.

eddb is for development and testing. Keep clone connections restricted to approved networks. You manage your VM, firewall, backups, and database licensing.

1. Download and install eddb.

Run these commands on your VM. Your eddb contact provides the release version and download token. Replace both placeholders below with those values; enter the version without a leading v.

export EDDB_VERSION="YOUR_RELEASE_VERSION"
export EDDB_TOKEN="YOUR_DOWNLOAD_TOKEN"

curl -fL -o eddb \
  "https://roxeeaniprod.blob.core.windows.net/eddb/releases/v${EDDB_VERSION}/eddb-linux-x86_64-v${EDDB_VERSION}?${EDDB_TOKEN}"

Wait for the download to finish successfully. If it fails with an authorization error, ask your contact for a fresh download token.

Verify the download.

Download the matching checksum and check the file before installing:

curl -fL -o eddb.sha256 \
  "https://roxeeaniprod.blob.core.windows.net/eddb/releases/v${EDDB_VERSION}/eddb-linux-x86_64-v${EDDB_VERSION}.sha256?${EDDB_TOKEN}"

echo "$(cut -d' ' -f1 eddb.sha256)  eddb" | sha256sum -c -
unset EDDB_TOKEN

You should see eddb: OK. Also compare the checksum with the expected value supplied separately by your eddb contact. If either check fails, stop and contact support.

Review the terms and install.

chmod +x ./eddb
./eddb license terms

After reviewing the terms, install eddb:

sudo ./eddb install --yes

The installer prepares the required software and installs the command at /usr/local/bin/eddb. You do not need to install its prerequisites separately. Log out and back in once so your operator permissions take effect.

2. Activate your license.

Generate your VM’s machine code and send it to your eddb contact:

eddb license machine-code

Send the full code beginning with EDDB-MC-v1- to your license issuer. They will return an activation code beginning with EDDB-LIC-v1-. Review the terms, then replace the example activation code below with the full code you received:

eddb license terms
sudo eddb license activate --accept-eula --code 'EDDB-LIC-v1-...'
eddb license status

The activation command records your acceptance of the license terms. Confirm that the status is active. Alternatively, run sudo eddb and choose license-management for guided activation.

Activate before initializing storage. If the license is not active, resolve that first.

3. Prepare your data disk.

Identify your dedicated empty disk:

eddb storage devices
lsblk

Compare the disk’s full device path and size with your VM’s disk settings. Use a disk marked available. The next command erases the selected disk. Do not select your operating-system disk or a disk containing data you need.

Replace /dev/sdX below with the full path of your empty disk, such as /dev/sdb or /dev/nvme0n2. Keep the /dev/ prefix:

sudo eddb storage init \
  --device /dev/sdX \
  --vg vg0 \
  --thinpool thinpool \
  --dangerously-format-device \
  --yes

Prefer guided setup? Run sudo eddb, choose storage-init, and select the same dedicated empty disk. Use either method once.

Normal setup also prepares the default-2022 and default-2025 bases. Allow a few minutes for them to finish, then check readiness:

sudo eddb doctor
eddb bases

Continue when the checks pass and your chosen base is listed. If a check fails, follow its guidance; diagnostic reports are saved under /opt/eddb/reports/.

4. Create and connect.

Start with a ready-to-use base; no backup is needed:

sudo eddb create dev --base default-2022
sudo eddb check-connection dev
eddb info dev

Use default-2025 instead for SQL Server 2025. In your usual database client, enter the server address, port, username, and password shown by eddb info dev. Keep that output private.

If the VM connection check passes but your workstation cannot connect, check your VPN, routing, and firewall access to that clone’s port.

Start from your own data.

Copy your development database’s .bak file to the VM. This example restores a SQL Server 2022 backup once, then creates two independent environments:

sudo eddb build-base team-base --bak ./seed.bak --db-version 2022 --size 200G
sudo eddb create appdev --base team-base
sudo eddb create qa --base team-base

Choose the database version that matches your backup. The database keeps its original name. The 200G value is a growth limit, not 200 GB of space reserved immediately. A large restore can take time.

Your everyday commands.

eddb list             # View clones and their status
eddb usage            # Check available storage
eddb info dev         # Retrieve connection details
sudo eddb stop dev    # Stop; keep the clone’s data
sudo eddb start dev   # Start it again

To return QA to its original base:

sudo eddb refresh qa

Refresh discards changes in that clone. Back up anything you need before confirming. The clone keeps its port and password.

Prefer a guided workflow? Run sudo eddb to manage your environments in the console.

When something needs attention.

• Setup or readiness issue: run sudo eddb doctor and follow the failed check’s guidance.
• Permission denied after installation: log out and back in, then check eddb access status.
• Clone will not connect: run sudo eddb check-connection dev. Review recent output with sudo eddb logs dev --tail 80 --no-follow.
• New clones or refresh are blocked: check eddb license status and eddb usage.

If you need help, send your eddb contact the command that failed, its error, and the diagnostic report produced by eddb doctor. Review diagnostic files before sharing and omit credentials and customer data.