> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dbdock.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to DBdock

> The open-source database toolkit for backups, restores, and cross-database migrations.

DBdock is an open-source CLI for PostgreSQL backups, restores, database copies, and cross-database migrations between MongoDB and PostgreSQL — with encryption, compression, and multi-cloud storage built in.

Stop writing throwaway backup scripts. Stop maintaining migration code. One command, one tool.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/get-started/quickstart">
    Run your first backup in under 5 minutes.
  </Card>

  <Card title="Installation" icon="download" href="/get-started/installation">
    Install globally or run with npx.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/cli/overview">
    Every command, every flag, every example.
  </Card>

  <Card title="Cross-database migration" icon="arrows-left-right" href="/migration/overview">
    MongoDB ↔ PostgreSQL with schema mapping.
  </Card>
</CardGroup>

## What you can do

```bash theme={null}
npx dbdock init                              # One-time setup
npx dbdock backup                            # Backup with encryption + compression
npx dbdock restore                           # Interactive restore
npx dbdock copydb "src_url" "dst_url"        # Copy a database, zero config
npx dbdock migrate "mongo_url" "postgres_url" # Cross-database migration
```

## Features at a glance

<CardGroup cols={2}>
  <Card title="Beautiful CLI" icon="sparkles">
    Real-time progress bars, speed tracking, smart filtering for 100+ backups.
  </Card>

  <Card title="Multiple storage" icon="cloud">
    Local disk, AWS S3, Cloudflare R2, Cloudinary — swap with one line.
  </Card>

  <Card title="Security-first" icon="lock">
    AES-256-GCM encryption, env-var secrets, credential masking, `.pgpass` support.
  </Card>

  <Card title="Retention policies" icon="broom">
    Auto-clean by count or age. Safety net prevents accidental wipes.
  </Card>

  <Card title="Alerts" icon="bell">
    Email (SMTP) and Slack for backup success and failure.
  </Card>

  <Card title="Cross-database" icon="arrows-left-right">
    MongoDB ↔ PostgreSQL with schema mapping and dry runs.
  </Card>

  <Card title="TypeScript SDK" icon="code">
    Use DBdock programmatically in any Node.js app.
  </Card>

  <Card title="MIT licensed" icon="scale-balanced">
    Free forever. Self-hosted. No vendor lock-in.
  </Card>
</CardGroup>

## Who it's for

DBdock is built for developers and teams who:

* Need reliable PostgreSQL backups without setting up a cloud service
* Want to copy a database between environments (prod → staging, staging → local)
* Are migrating from MongoDB to PostgreSQL (or the other way)
* Prefer a single CLI over stitching together `pg_dump`, cron, and upload scripts
* Don't want to send their database dumps to a third-party SaaS

## Get help

* [GitHub Discussions](https://github.com/dbdock/dbdock/discussions) — ask questions, share ideas
* [Issue tracker](https://github.com/dbdock/dbdock/issues) — report bugs, request features
* [Troubleshooting guide](/help/troubleshooting) — common issues and fixes
* [FAQ](/help/faq) — quick answers

Ready? [Install DBdock →](/get-started/installation)