# DBDock

> DBDock is a database toolkit for backups, restores, database copies, and cross-database migrations — as an open-source CLI and a managed cloud dashboard, kept in sync.

## Docs

- [DBDock Documentation](https://docs.dbdock.xyz/index.md): DBDock is a database toolkit for PostgreSQL and MongoDB — backups, restores, database copies, and cross-database migrations. Use the open-source CLI, the managed cloud dashboard, or both, kept in sync.
- [What is DBDock?](https://docs.dbdock.xyz/get-started/what-is-dbdock.md): An overview of DBDock — the open-source CLI, the managed cloud dashboard, supported databases, and how the two surfaces stay in sync.
- [Cloud Quickstart](https://docs.dbdock.xyz/get-started/quickstart-cloud.md): Connect a database and take your first encrypted backup in DBDock Cloud in under five minutes — no installation, no infrastructure.
- [CLI Quickstart](https://docs.dbdock.xyz/get-started/quickstart.md): Go from zero to your first backup with the DBDock CLI in under 5 minutes — install, initialize, back up, and restore from your terminal.
- [Installation](https://docs.dbdock.xyz/get-started/installation.md): Install DBDock globally, use with npx, or add it as a library dependency.
- [Concepts](https://docs.dbdock.xyz/core/concepts.md): How DBDock thinks about backups, compression, encryption, and storage.
- [Configuration](https://docs.dbdock.xyz/core/configuration.md): Complete reference for dbdock.config.json and environment variables.
- [DBDock Cloud](https://docs.dbdock.xyz/cloud/overview.md): DBDock Cloud is the managed dashboard at dbdock.xyz — connections, encrypted backups, scheduling, storage, migrations, analytics, alerts, teams, and admin panels, with nothing to self-host.
- [Connections](https://docs.dbdock.xyz/cloud/connections.md): Add and manage database connections in DBDock Cloud — nine supported engines, connection testing, encrypted credentials, and database size tracking.
- [Backups & Restore](https://docs.dbdock.xyz/cloud/backups.md): Create encrypted, compressed database backups in DBDock Cloud, restore them, retry failures, download files, and apply retention — on demand or on a schedule.
- [Storage](https://docs.dbdock.xyz/cloud/storage.md): Store DBDock Cloud backups in included managed storage or bring your own bucket — AWS S3, Cloudflare R2, or Cloudinary — with per-plan quotas and usage tracking.
- [Schedules](https://docs.dbdock.xyz/cloud/schedules.md): Automate backups in DBDock Cloud with cron-based schedules that run for you — with retries, per-schedule run history, and skip controls.
- [Team](https://docs.dbdock.xyz/cloud/teams.md): Invite people into a shared DBDock Cloud workspace so they can manage connections, backups, and schedules alongside you, acting on the owner's resources.
- [MCP Server](https://docs.dbdock.xyz/cloud/mcp.md): Connect AI assistants like Claude and Cursor to DBDock Cloud over the Model Context Protocol — run backups, restores, copies, migrations, and schedules from your editor with secure OAuth sign-in.
- [Plans & Billing](https://docs.dbdock.xyz/cloud/billing.md): DBDock Cloud plans — Free, Pro, and Business. What each unlocks: connections, scheduled backups, managed storage, encryption, team seats, alerts, and admin panels.
- [Cloud Sync](https://docs.dbdock.xyz/cloud-sync/overview.md): Link a local DBDock CLI project to your DBDock Cloud dashboard. Automate from the terminal, monitor from the browser — and keep secrets on your machine, because only metadata syncs.
- [Authentication](https://docs.dbdock.xyz/cloud-sync/authentication.md): Sign in to DBDock Cloud from the CLI with browser OAuth, check your identity with whoami, use tokens for CI, and manage multiple accounts with profiles.
- [Syncing a Project](https://docs.dbdock.xyz/cloud-sync/sync.md): Push local DBDock config to the cloud, check sync status, pull the cloud baseline, and resolve conflicts with dbdock sync — plus opening the linked project in the dashboard.
- [Data Handling](https://docs.dbdock.xyz/cloud-sync/data-handling.md): Exactly what DBDock Cloud Sync uploads and what it never touches. Secrets — passwords, keys, webhook URLs — stay on your machine; only non-sensitive metadata syncs.
- [Security Overview](https://docs.dbdock.xyz/security/overview.md): How DBDock protects your databases, credentials, and backups — encryption by default, secrets kept out of config, tenant isolation in the cloud, and metadata-only sync.
- [Encryption](https://docs.dbdock.xyz/security/encryption.md): DBDock encrypts backups with AES-256-GCM and PBKDF2 key derivation. How to generate a key, where to store it, credential masking, and PostgreSQL .pgpass support.
- [Cloud Security](https://docs.dbdock.xyz/security/cloud.md): How DBDock Cloud secures your data — OAuth sign-in, credentials encrypted at rest, per-account isolation, encrypted backups, scoped MCP access, and metadata-only CLI sync.
- [Key Management](https://docs.dbdock.xyz/security/key-management.md): Where DBDock secrets should live — environment variables, secret vaults, and CI secret stores — plus strict mode, least-privilege storage credentials, and key rotation.
- [Refresh staging from production](https://docs.dbdock.xyz/guides/staging-refresh.md): Keep staging databases current with production data using dbdock copydb.
- [Encryption key rotation](https://docs.dbdock.xyz/guides/key-rotation.md): Safely rotate DBDock encryption keys without losing access to old backups.
- [Retention strategies](https://docs.dbdock.xyz/guides/retention-strategies.md): Recommended backup retention policies for different workloads.
- [Production deployment checklist](https://docs.dbdock.xyz/guides/production-checklist.md): Everything to verify before relying on DBDock in production.
- [Troubleshooting](https://docs.dbdock.xyz/help/troubleshooting.md): Common DBDock issues and how to fix them.
- [FAQ](https://docs.dbdock.xyz/help/faq.md): Quick answers to common questions.
- [Changelog](https://docs.dbdock.xyz/help/changelog.md): What's new in each DBDock release.
- [CLI Overview](https://docs.dbdock.xyz/cli/overview.md): Every DBDock CLI command at a glance — setup, backups, restores, database copies, cross-database migration, schedules, and Cloud Sync (login, sync, open).
- [dbdock init](https://docs.dbdock.xyz/cli/init.md): Interactive setup wizard — run once per project.
- [dbdock backup](https://docs.dbdock.xyz/cli/backup.md): Create a database backup with compression and encryption.
- [dbdock restore](https://docs.dbdock.xyz/cli/restore.md): Interactive restore with smart filtering and migration support.
- [dbdock copydb](https://docs.dbdock.xyz/cli/copydb.md): Copy a PostgreSQL database between two URLs — no config, no backup file.
- [dbdock list](https://docs.dbdock.xyz/cli/list.md): List all available backups with filtering.
- [dbdock delete](https://docs.dbdock.xyz/cli/delete.md): Delete specific backups or all backups.
- [dbdock cleanup](https://docs.dbdock.xyz/cli/cleanup.md): Apply your retention policy to remove old backups.
- [dbdock schedule](https://docs.dbdock.xyz/cli/schedule.md): Manage backup schedules stored in your config file.
- [dbdock status](https://docs.dbdock.xyz/cli/status.md): View configured schedules and service health.
- [dbdock test](https://docs.dbdock.xyz/cli/test.md): Validate your database, storage, and alert configuration.
- [dbdock migrate-config](https://docs.dbdock.xyz/cli/migrate-config.md): Move legacy secrets from the config file to environment variables.
- [dbdock login](https://docs.dbdock.xyz/cli/login.md): Sign in to DBDock Cloud from the CLI with browser OAuth. Includes logout, whoami, and switch-org, plus token-based sign-in for CI and profiles for multiple accounts.
- [dbdock sync](https://docs.dbdock.xyz/cli/sync.md): Synchronize a local DBDock project with DBDock Cloud — push local config metadata, check status, pull the cloud baseline, and resolve conflicts. Secrets never sync.
- [dbdock open](https://docs.dbdock.xyz/cli/open.md): Open the linked DBDock project in the cloud dashboard from your terminal, or print the URL for use over SSH.
- [dbdock account](https://docs.dbdock.xyz/cli/account.md): Show your DBDock plan and the limits that apply to your account — connections, backups, schedules, storage, alerts, and team size.
- [dbdock storage](https://docs.dbdock.xyz/cli/storage.md): Show how much DBDock managed storage you've used against your plan's quota.
- [dbdock alert](https://docs.dbdock.xyz/cli/alert.md): Manage DBDock Cloud notification channels and alert rules from the CLI — the same alerts you'd configure in the dashboard.
- [Storage overview](https://docs.dbdock.xyz/storage/overview.md): Choose where DBDock puts your backups.
- [DBDock Storage](https://docs.dbdock.xyz/storage/managed.md): Managed backup storage included with your plan — no bucket, no keys.
- [Local storage](https://docs.dbdock.xyz/storage/local.md): Store backups on the local filesystem.
- [AWS S3](https://docs.dbdock.xyz/storage/s3.md): Store backups in Amazon S3 or any S3-compatible service.
- [Cloudflare R2](https://docs.dbdock.xyz/storage/r2.md): S3-compatible storage with zero egress fees.
- [Cloudinary](https://docs.dbdock.xyz/storage/cloudinary.md): Media-platform storage with a generous free tier.
- [Deletion safety](https://docs.dbdock.xyz/storage/deletion-safety.md): How DBDock protects backups in object storage from accidental or runaway deletion.
- [Migration overview](https://docs.dbdock.xyz/migration/overview.md): Cross-database migration between MongoDB and PostgreSQL.
- [dbdock analyze](https://docs.dbdock.xyz/migration/analyze.md): Scan a database and print its shape, types, and inconsistencies.
- [dbdock migrate](https://docs.dbdock.xyz/migration/migrate.md): Migrate data between MongoDB and PostgreSQL in either direction.
- [Schema mapping](https://docs.dbdock.xyz/migration/schema-mapping.md): How DBDock translates types between MongoDB and PostgreSQL.
- [Dry runs & validation](https://docs.dbdock.xyz/migration/dry-run.md): Validate a migration plan against a temporary schema before committing.
- [Incremental migration](https://docs.dbdock.xyz/migration/incremental.md): Pull only new or changed data after an initial migration.
- [Alerts overview](https://docs.dbdock.xyz/alerts/overview.md): Get notified when backups succeed or fail.
- [Scheduling backups](https://docs.dbdock.xyz/alerts/scheduling.md): Run automated backups on a cron schedule.
- [Email alerts (SMTP)](https://docs.dbdock.xyz/alerts/email.md): Send backup notifications via any SMTP provider.
- [Slack alerts](https://docs.dbdock.xyz/alerts/slack.md): Send backup notifications to Slack via incoming webhooks.
- [Custom webhooks](https://docs.dbdock.xyz/alerts/webhooks.md): Send alerts to Discord, Teams, WhatsApp, or any HTTP endpoint.
- [SDK overview](https://docs.dbdock.xyz/sdk/overview.md): Use DBDock programmatically in your Node.js app.
- [Creating backups](https://docs.dbdock.xyz/sdk/creating-backups.md): Create database backups programmatically with BackupService.
- [Listing backups](https://docs.dbdock.xyz/sdk/listing-backups.md): Query backup history programmatically.
- [Scheduling backups (SDK)](https://docs.dbdock.xyz/sdk/scheduling.md): Build a scheduled backup runner with node-cron.
- [Alerts (SDK)](https://docs.dbdock.xyz/sdk/alerts.md): Send backup notifications programmatically.

## OpenAPI Specs

- [openapi](https://docs.dbdock.xyz/api-reference/openapi.json)

## Optional

- [Dashboard](https://dbdock.xyz)
- [NPM](https://www.npmjs.com/package/dbdock)
- [GitHub](https://github.com/dbdock/dbdock)