Resonance Docs

Getting started with the Resonance deployment bundle.

Follow the exact requirements, directory prep, configuration, and boot steps from the packaged README so your storefront can go online without touching the source code.

Bundle contents

  • docker-compose.yml
  • .env.example
  • README-INSTALL.md (deployment guide)

The app is delivered as an optimized Docker image—treat this bundle as the single source of truth for every deployment.

Required before you begin

  • Ubuntu 22.04 / 24.04 (or equivalent Linux)
  • Docker + Docker Compose plugin
  • Domain pointed at the target server
  • License Key & Activation Code from your Obsidian email

Install Docker 

curl -fsSL https://get.docker.com | sh
sudo apt-get install -y docker-compose-plugin

1. Prepare the deployment directory

Work inside /opt/resonance (or any secure directory) then upload and extract the bundle. 

mkdir -p /opt/resonance
cd /opt/resonance

# upload, extract, then duplicate the environment file
cp .env.example .env

2. Configure your .env

Licensing & Admin

  • LICENSE_KEY
  • LICENSE_ACTIVATION_CODE
  • ADMIN_PASSWORD for the first login

Secrets & domain

Generate a 32-byte encryption key and set the public site URL for your domain. 

openssl rand -base64 32
  • ENCRYPTION_MASTER_KEY
  • NEXT_PUBLIC_SITE_URL=https://yourdomain.com

Email + optional payments

Provide SMTP host, port, user, password, and sender via EMAIL_FROM. If you plan to charge customers from day one, also drop in your Stripe / PayPal keys.

3. Start the stack

Boot the containers and keep an eye on the logs until Postgres and resonance-next report healthy. 

docker compose up -d
docker compose logs -f resonance-next

Once the health check passes you're ready to continue with DNS, SSL, and the in-browser setup wizard documented in the next guides.