BAPBA Protocol
Getting Started

Quickstart Guide

Get Burning Ash Protocol up and running in 5 minutes with this quickstart guide.

Quickstart Guide

This guide walks you through setting up BAP in about 5 minutes. We'll cover creating your account, configuring your first connector, adding survivors, and uploading your first will.

Prerequisites

  • BAP installed (see Installation Guide)
  • Access to the web dashboard at http://localhost:3000
  • At least one notification method (email, SMS, WhatsApp, or Telegram)
  • At least one storage backend (Google Drive, Dropbox, S3, or FTP/SFTP)

Step 1: Create Your Account

  1. Open the BAP dashboard in your browser
  2. Click "Create Account"
  3. Enter your details:
    • Email — Your email address (this is your login)
    • Password — Minimum 12 characters with complexity requirements
    • Display Name — How you'll appear in the system
  4. Click "Create Account"
  5. Check your email and click the verification link

Your account is now created and you're ready to set up your will.

Step 2: Configure a Connector

Connectors send notifications and OTPs to you and your survivors.

  1. After email verification, log in to your dashboard
  2. Navigate to SettingsConnectors
  3. Click "Add Connector"
  4. Choose your connector type:

Email (SMTP)

  • Provider: Any SMTP provider (SendGrid, Resend, Postmark, Mailgun, etc.)
  • SMTP Host: e.g., smtp.example.com
  • SMTP Port: e.g., 587
  • Username: Your SMTP username
  • Password: Your SMTP password
  • From Address: Verified sender email

SMS (Twilio)

  • Provider: Twilio
  • API Key SID and API Key Secret: From Twilio Console → API keys (create a key; use SID and Secret)
  • From Number: Your Twilio phone number (e.g., +1234567890)

WhatsApp (Meta Cloud API)

  • Provider: WhatsApp (Meta Cloud API)
  • Access Token: From Meta Developer Portal
  • Phone Number ID: From WhatsApp Business API
  • Business Account ID: From Meta Business Manager

Telegram

  • Provider: Telegram
  • Bot Token: From @BotFather on Telegram
  1. Click "Test Connector" to verify it works
  2. Click "Save Connector"

Recommendation: Add at least two connectors for redundancy.

Step 3: Configure Storage

Storage backends hold your encrypted will documents.

  1. Navigate to SettingsStorage
  2. Click "Add Storage"
  3. Choose your storage type:

Google Drive or Dropbox

  • Click "Connect with [Provider]"
  • You'll be redirected to the provider's OAuth login
  • Authorize BAP to access your files
  • Select a folder for will documents

AWS S3

  • Access Key ID: From IAM user
  • Secret Access Key: From IAM user
  • Bucket Name: Your S3 bucket
  • Region: e.g., us-east-1
  • Path: Folder path (e.g., /wills)

FTP/SFTP

  • Host: Your server hostname
  • Port: 21 (FTP) or 22 (SFTP)
  • Username: FTP/SFTP username
  • Password: FTP/SFTP password (or SSH key)
  • Path: Directory for will files
  1. Click "Test Connection" to verify
  2. Click "Save Storage"

Step 4: Add Survivors

Survivors are the people who will receive your will after you're gone.

  1. Navigate to SurvivorsAdd Survivor
  2. Enter the Survivor's details:
    • Name: Their full name
    • Relationship: e.g., spouse, child, sibling
    • Contact Methods: At least one (email, phone, WhatsApp, or Telegram)
  3. Set the connector priority (order to try when sending OTPs):
    • Example: ["email", "sms", "whatsapp", "telegram"]
  4. Optionally add a personal message that they'll see when they access your will
  5. Click "Add Survivor"

Important: You must add at least 2 survivors. Record the backup codes shown — they can only be displayed once!

Setting the Threshold

The threshold determines how many survivors must authenticate to access the will.

  • If you have 3 survivors, you can set threshold 2-of-3 or 3-of-3
  • We recommend 2-of-3 — one survivor can get access, but two provides safety

Step 5: Configure Liveness Settings

Liveness checks verify you're still alive. If you don't respond, the will transfer begins.

  1. Navigate to SettingsLiveness
  2. Configure the timing:
SettingDescriptionOptions
HCITHow often to check7, 14, 30, 60, 90 days
HCRTTime to respond24, 48, 72 hours
HCRACMissed attempts before activation1-5

Example: HCIT=30 days, HCRT=48 hours, HCRAC=3

  • Check every 30 days
  • You have 48 hours to respond to each check
  • After 3 missed checks (~10 days), survivors are notified

The dashboard shows your "Time to Activation" — how long until the will could be released if you don't respond.

Warning: Too aggressive (e.g., 7-day checks, 24-hour response, 1 attempt) means only 8 days before activation!

Step 6: Upload Your Will

  1. Navigate to WillUpload Documents
  2. Click "Select Files" or drag and drop
  3. Choose your documents:
    • Supported: PDF, DOCX, TXT, images
    • Maximum: 50MB per file, 500MB total
  4. Click "Upload"
  5. Wait for encryption to complete

Step 7: Seal Your Will

Once documents are uploaded, seal the will to activate it:

  1. Click "Seal Will"
  2. Review the summary:
    • Number of documents
    • Total size
    • Number of survivors and threshold
    • Storage location
  3. Click "Seal Will" to encrypt and distribute shares

Your will is now active! The system will begin periodic liveness checks.

What Happens Next

During Liveness Checks

  • You'll receive a notification (via your primary connector)
  • Click the link and confirm "I'm Alive"
  • That's it — you're confirmed until the next check

If You Don't Respond

  • After HCRT passes, another check is sent (up to HCRAC times)
  • If all attempts fail, survivors are notified
  • They can then initiate the will transfer

When Survivors Access

  1. Survivors receive notification that transfer is initiated
  2. Each survivor logs in and verifies via OTP
  3. Once the threshold is met, documents are decrypted
  4. All authenticated survivors can access the documents

Distributing Backup Codes

Each survivor receives 5 backup codes. These are crucial — if they can't receive OTPs, backup codes are their only way in.

Print the codes and give them to survivors in sealed envelopes. Store them securely.

Next Steps

On this page