Administration /

Backup Data Directory

Bytebase manages its own data under the --data directory. The data includes:

  • Metadata when --pg is not specified.
  • Database Backup.

You should periodically backup the entire --data directory.

If Bytebase is running and not in the readonly mode, and you want to take the backup, then the underlying data volume must support snapshot feature where the entire directory can take a snapshot at the same time, otherwise it may produce a corrupted backup bundle.


If --pg is specified, the metadata will be stored in that external postgres database. Otherwise, Bytebase will store the metadata inside its internal postgres instance. The pgdata directory will be put under the --data directory.

Database Backup

Bytebase allows users to take database backups. The backup directory will be put under the --data directory.