Installation

PulseDB can be deployed using Docker or run locally with Node.js.

Docker (recommended)

Docker is the recommended way to run PulseDB. It handles all dependencies and provides persistent storage.

Docker Compose

Create a docker-compose.yml file:

yaml
services:
  pulsedb:
    build: .
    ports:
      - "5433:3000"
    volumes:
      - pulsedb-data:/data
    restart: always

volumes:
  pulsedb-data:

Then start the service:

bash
docker compose up -d

Port configuration

The default port is 5433 (a nod to PostgreSQL's 5432). Change it in your docker-compose.yml:

yaml
ports:
  - "8080:3000"

Volumes

PulseDB stores encrypted connection configs and the encryption key in a Docker volume:

/data
├── connections.json      # Encrypted connection configurations
└── encryption.key        # Auto-generated AES-256 key

Local development

Prerequisites

Node.js 20+
npm

Setup

bash
git clone https://github.com/elmoziml/pulsedb.git
cd pulsedb
npm install
npm run dev

Available commands

Command	Description
`npm run dev`	Start development server
`npm run build`	Build for production
`npm start`	Start production server
`npm run lint`	Run ESLint

Production deployment

For production, build and start:

bash
npm run build
npm start

Or use the Docker setup:

bash
docker compose up -d --build