Database Options

BlackBook supports two database types. Choose based on your needs.

📋 Quick Decision Guide

  • Single computer, simple setup? → SQLite
  • Access from multiple locations? → PostgreSQL + Tailscale
  • No hardware to manage? → PostgreSQL on cloud (Supabase/Neon)

Option 1: SQLite (Recommended for Most Users)

📁

Local SQLite Database

Your data stored in a single file on this computer.

✓ Pros
  • • Zero configuration
  • • No additional software
  • • Easy backup (copy one file)
  • • Works completely offline
✗ Cons
  • • Single computer only
  • • Not ideal for 10,000+ contacts

Option 2: PostgreSQL

PostgreSQL is a powerful database that can be hosted locally, on your own server, or in the cloud.

Self-Hosted PostgreSQL

Run PostgreSQL on your own hardware for full control and privacy.

Popular options:

  • Synology NAS - Great for home/office
  • QNAP NAS - Similar to Synology
  • Raspberry Pi - Low-cost option
  • Home server - Any Linux/Windows machine
  • Local installation - PostgreSQL on this computer

💡 Use Tailscale VPN to access your database securely from anywhere.

Cloud PostgreSQL

Use a managed database service - no hardware to maintain.

Provider Free Tier Notes
Supabase ✓ 500MB Easy setup, recommended for beginners
Neon ✓ 512MB Serverless, auto-suspends when idle
Railway $5 credit Simple, developer-friendly
AWS RDS 12mo trial Enterprise-grade, complex setup
Azure 12mo trial Microsoft cloud
Google Cloud SQL $300 credit Google infrastructure

Connection Settings

When using PostgreSQL, you'll need these connection details:

Host: localhost, your-nas.local, or db.supabase.co

Port: 5432 (default)

Database: blackbook

Username: your_username

Password: your_password

SSL: Enable for cloud providers

⚠️ SSL Required: Cloud providers (Supabase, Neon, AWS, etc.) require SSL connections. Make sure to enable "Require SSL" in the setup wizard.

Supabase Setup (Free)

  1. Create account at supabase.com
  2. Click "New Project" and choose a name
  3. Set a strong database password (save this!)
  4. Select region closest to you
  5. Wait ~2 minutes for provisioning
  6. Go to Settings → Database
  7. Find "Connection string" section and copy:
    • Host: db.xxxxx.supabase.co
    • Port: 5432
    • Database: postgres
    • User: postgres
  8. Enter these in BlackBook setup wizard
  9. Enable SSL (required)

Neon Setup (Free)

  1. Create account at neon.tech
  2. Create a new project
  3. Copy connection details from dashboard:
    • Host: ep-xxxxx.us-east-2.aws.neon.tech
    • Database: neondb (or create "blackbook")
  4. Enter these in BlackBook setup wizard
  5. Enable SSL (required)

Note: Neon auto-suspends after 5 minutes of inactivity. First connection may take a few seconds while database "wakes up".

Next Steps