Repository files navigation

This plugin enhancesGitBucket by offering a way to backup/dump the entire H2 database of GitBucket.

It originates frompull request #845 and can be used to address database backup described inGitBucket Backup Documentation

This plugin allows you to backup the underlying H2 database used by default by GitBucket.

The plugin provides two ways to backup the H2 database:

• via an administration page and a backup button
• via an HTTP call tohttp://YOUR_GITBUCKET/api/v3/plugins/database/backup

The default backup file points toGITBUCKET_DATA/backup/gitbucket-db-YYYY-MM-DD-hhmm.zip where:

• GITBUCKET_DATA is the standard GitBucket data directory. If not specified, default it's~/.gitbucket
• YYYY-MM-DD-hhmm represents a date with hour and minutes

• goto theSystem Administration menu, sectionH2 Backup
• modify the file path if the default one doesn't fit your needs
• hit theExport database button

Using your preferred tool (curl, wget, ...) it is possible start a backup of the H2 database.

The URL to call looks likehttp://YOUR_GITBUCKET/api/v3/plugins/database/backup

You can pass an optional argumentdest that references the destination file path where the backup will be done on the server.For example callinghttp://YOUR_GITBUCKET/api/v3/plugins/database/backup?dest=/var/backups/gitbucket.zip will do an H2 backup of the gitbucket database into the file/var/backups/gitbucket.zip.Since1.3.0, thedest parameter can denote a relative file path, in this case the file will be created relatively toGITBUCKET_DATA.

On success, you will receive aHTTP 200 answer with atext/plain body containing the name of the backup file, without a path component. The file is in theGITBUCKET_DATA/backup folder.

The api uses token authentication. To generate a token:

1. Login to Gitbucket with an administrative account

2. In the top-right corner, click the user menu

3. ClickAccount Settings

4. On the left, clickApplications

5. InGenerate new token enter a description and clickGenerate token

6. Add the token to your http call, such as withcurl:

   curl --silent --show-error --fail -X POST -H 'Authorization: token your_token_value' http://YOUR_GITBUCKET/api/v3/plugins/database/backup

sbt clean assembly

• copygitbucket-h2-backup.jar into GITBUCKET_HOME/plugins
• restart GitBucket

• remove backup api at GET /database/backup
• change method from GET to POST on /api/v3/plugins/database/backup
• backup endpoint is secure by default, and requires an api token for a user with admin rights

• compatibility with GitBucket 4.35.x

• compatibility with GitBucket 4.32.x and Scala 2.13

• Bump sbt-gitbucket-plugin to 1.3.0 to be hosted by theplugin registry

• compatibility with GitBucket 4.21.x

• compatibility with GitBucket 4.16.0 and Scala 2.12

• compatibility with GitBucket 4.10, scala 2.12#20
• allow to securedatabase/backup endpoint#1,#19

• compatibility with GitBucket 4.3.0
• fix version order in GitBucket Plugins panel
• default backup file contains date with timestamp#12

• binary compatibility with GitBucket 4.x

• recompilation to ensure binary compatibility with GitBucket 3.11

• introduce gitbucket-h2-backup-plugin
• allows to backup h2 database via a live dump