https://github.com/portabase/portabase

Portabase - Database backup & restore tool for PostgreSQL, MySQL, MsSQL, MariaDB, Firebird SQL, SQLite, MongoDB, Redis and Valkey
https://github.com/portabase/portabase

backup backup-tool better-auth database devops docker drizzle-orm firebirdsql mariadb mongodb mssql-database mysql nextjs postgresql redis selfhosted sqlite-database sqlite3 valkey

Last synced: 3 days ago
JSON representation

Portabase - Database backup & restore tool for PostgreSQL, MySQL, MsSQL, MariaDB, Firebird SQL, SQLite, MongoDB, Redis and Valkey

• Host: GitHub
• URL: https://github.com/portabase/portabase
• Owner: Portabase
• License: apache-2.0
• Created: 2024-10-19T08:04:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-06-04T07:09:55.000Z (8 days ago)
• Last Synced: 2026-06-04T09:22:13.159Z (8 days ago)
• Topics: backup, backup-tool, better-auth, database, devops, docker, drizzle-orm, firebirdsql, mariadb, mongodb, mssql-database, mysql, nextjs, postgresql, redis, selfhosted, sqlite-database, sqlite3, valkey
• Language: TypeScript
• Homepage: https://portabase.io
• Size: 32.4 MB
• Stars: 946
• Watchers: 5
• Forks: 53
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          





  

    

  


Portabase


  


  Portabase is a tool designed to simplify the backup and restoration of your database instances. It integrates seamlessly with Portabase agents for managing operations securely and efficiently.

  


[![License: Apache](https://img.shields.io/badge/License-apache-yellow.svg)](LICENSE)

[![Docker Pulls](https://img.shields.io/docker/pulls/portabase/portabase?color=brightgreen)](https://hub.docker.com/r/portabase/portabase)

[![Helm Chart](https://img.shields.io/badge/Helm-Kubernetes-326ce5?logo=helm&logoColor=white)](https://github.com/Portabase/portabase/pkgs/container/charts%2Fportabase)

[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey)](https://github.com/Portabase/portabase)

[![Support Portabase](https://img.shields.io/badge/Support-Portabase-orange)](https://www.buymeacoffee.com/portabase)

[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?logo=postgresql&logoColor=white)](https://www.postgresql.org/)

[![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white)](https://www.mysql.com/)

[![MariaDB](https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white)](https://mariadb.org/)

[![SQLite](https://img.shields.io/badge/-SQLite-blue?logo=sqlite&logoColor=white)](https://sqlite.org/)

[![Redis](https://img.shields.io/badge/Redis-DC382D?style=flat&logo=Redis&logoColor=white)](https://redis.io/)

[![MongoDB](https://img.shields.io/badge/-MongoDB-13aa52?logo=mongodb&logoColor=white)](https://www.mongodb.com/)

[![Valkey](https://img.shields.io/badge/Valkey-6284fc?style=flat&logo=Valkey&logoColor=white)](https://valkey.io/)

[![Firebird](https://img.shields.io/badge/Firebird-f55b14?style=flat&logo=Firebird&logoColor=white)](https://firebirdsql.org/)

[![Microsoft SQL Server](https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=flat&logo=microsoftsqlserver&logoColor=white)](https://www.microsoft.com/en-us/sql-server)

[![Self Hosted](https://img.shields.io/badge/self--hosted-yes-brightgreen)](https://github.com/Portabase/portabase)

[![Open Source](https://img.shields.io/badge/open%20source-❤️-red)](https://github.com/Portabase/portabase)

[![NextJS][NextJS]][NextJS-url]

[![BetterAuth][BetterAuth]][BetterAuth-url]

[![Drizzle][Drizzle]][Drizzle-url]

[![ShadcnUI][ShadcnUI]][ShadcnUI-url]

[![Docker][Docker]][Docker-url]

  


    

        Website •

        Documentation •

        Demo •

        Installation •

        Report Bug •

        Request Feature

    

  


![portabase-dashboard](https://github.com/user-attachments/assets/8f2c69d6-f1f9-4b80-b51c-01f6f13b9b62)



## Installation

You have 4 ways to install Portabase:

- Automated CLI (recommended) - [details](https://portabase.io/docs/dashboard/setup#cli)

- Docker Run - [details](https://portabase.io/docs/dashboard/setup#docker)

- Docker Compose setup - [details](https://portabase.io/docs/dashboard/setup#docker-compose)

- Kubernetes with Helm [details](https://portabase.io/docs/dashboard/setup#helm)

- Development setup - [details](https://portabase.io/docs/dashboard/setup#development)

**Ensure Docker is installed on your machine before getting started.**

## Supported databases

| Engine             | Support   | Supported Versions            | Restore |

|:-------------------|:----------|:------------------------------|:--------|

| **PostgreSQL**     | ✅ Stable  | 12, 13, 14, 15, 16, 17 and 18 | Yes     |

| **MySQL**          | ✅ Stable  | 5.7, 8 and 9                  | Yes     |

| **MariaDB**        | ✅ Stable  | 10 and 11                     | Yes     |

| **MongoDB**        | ✅ Stable  | 4, 5, 6, 7 and 8              | Yes     |

| **SQLite**         | ✅ Stable  | 3.x                           | Yes     |

| **Redis**          | ✅ Stable  | 2.8+                          | No      |

| **Valkey**         | ✅ Stable  | 7.2+                          | No      |

| **Firebird**       | ✅ Stable  | 3.0, 4.0, 5.0                 | Yes     |

| **MSSQL Server**   | ✅ Stable  | 2017, 2019, 2022, Azure SQL         | Yes     |

See the [Database Servers documentation](https://portabase.io/docs/agent/db) for version-specific backup and restore details.

## Contributors

[![Contributors](https://contrib.rocks/image?repo=Portabase/portabase)](https://github.com/Portabase/portabase/graphs/contributors)

[!["Support Portabase"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/portabase)

## License

Distributed under the Apache License. See `LICENSE.txt` for more details.

[Docker]: https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=for-the-badge

[NextJS]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white

[BetterAuth]: https://img.shields.io/badge/Better%20Auth-FFF?logo=betterauth&logoColor=000&style=for-the-badge

[Drizzle]: https://img.shields.io/badge/Drizzle-111?style=for-the-badge&logo=Drizzle&logoColor=c5f74f

[ShadcnUI]: https://img.shields.io/badge/shadcn/ui-000000?style=for-the-badge&logo=shadcn/ui&logoColor=white

[NextJS-url]: https://nextjs.org/

[BetterAuth-url]: https://www.better-auth.com/

[Drizzle-url]: https://orm.drizzle.team/

[ShadcnUI-url]: https://ui.shadcn.com/

[Docker-url]: https://www.docker.com/