https://github.com/gitbucket/gitbucket-h2-backup-plugin
GitBucket H2 Database Backup Plugin
https://github.com/gitbucket/gitbucket-h2-backup-plugin
gitbucket gitbucket-plugin
Last synced: 25 days ago
JSON representation
GitBucket H2 Database Backup Plugin
- Host: GitHub
- URL: https://github.com/gitbucket/gitbucket-h2-backup-plugin
- Owner: gitbucket
- Created: 2015-09-01T08:57:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2026-03-07T17:46:05.000Z (about 2 months ago)
- Last Synced: 2026-03-07T23:22:21.712Z (about 2 months ago)
- Topics: gitbucket, gitbucket-plugin
- Language: Scala
- Homepage:
- Size: 2 MB
- Stars: 22
- Watchers: 9
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.MD
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gitbucket-h2-backup-plugin
This plugin enhances [GitBucket](https://github.com/gitbucket/gitbucket) by offering a way to backup/dump the entire H2 database of GitBucket.
It originates from [pull request #845](takezoe/gitbucket#845) and can be used to address database backup described in [GitBucket Backup Documentation](https://github.com/gitbucket/gitbucket/wiki/Backup)
## Features
### H2 Backup
This plugin allows you to backup the underlying H2 database used by default by GitBucket.
## Usage
The plugin provides two ways to backup the H2 database:
- via an administration page and a backup button
- via an HTTP call to `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`
The default backup file points to `GITBUCKET_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
### UI usage
- goto the `System Administration` menu, section `H2 Backup`
- modify the file path if the default one doesn't fit your needs
- hit the `Export database` button
### HTTP call usage
Using your preferred tool (curl, wget, ...) it is possible start a backup of the H2 database.
The URL to call looks like `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`
You can pass an optional argument `dest` that references the destination file path where the backup will be done on the server.
For example calling `http://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`.
Since `1.3.0`, the _dest_ parameter can denote a relative file path, in this case the file will be created relatively to `GITBUCKET_DATA`.
On success, you will receive a `HTTP 200` answer with a `text/plain` body containing the name of the backup file, without a path component. The file is in the `GITBUCKET_DATA/backup` folder.
### HTTP API Authorization
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. Click `Account Settings`
4. On the left, click `Applications`
5. In `Generate new token` enter a description and click `Generate token`
6. Add the token to your http call, such as with `curl`:
`curl --silent --show-error --fail -X POST -H 'Authorization: token your_token_value' http://YOUR_GITBUCKET/api/v3/plugins/database/backup`
## Compatibility
Plugin version | GitBucket version
:--------------|:-----------------
1.9.x | >= 4.35.y
1.8.x | >= 4.32.y
1.7.x | >= 4.26.y
1.6.x | >= 4.21.y
1.5.x | >= 4.16.y
1.4.x | >= 4.10.y
1.3.x | >= 4.3.y
1.2.x | 4.x.y
1.1.x | 3.11.x
1.0.x | 3.6.x, 3.7.x, 3.8.x,, 3.9.x, 3.10.x
## Build
```
sbt clean assembly
```
## Installation
- copy `gitbucket-h2-backup.jar` into GITBUCKET_HOME/plugins
- restart GitBucket
## Release Notes
### 1.9.1
- 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
### 1.9.0
- compatibility with GitBucket 4.35.x
### 1.8.0
- compatibility with GitBucket 4.32.x and Scala 2.13
### 1.7.0
- Bump sbt-gitbucket-plugin to 1.3.0 to be hosted by the [plugin registry](https://plugins.gitbucket-community.org/)
### 1.6.0
- compatibility with GitBucket 4.21.x
### 1.5.1
- compatibility with GitBucket 4.16.0 and Scala 2.12
### 1.4.0
- compatibility with GitBucket 4.10, scala 2.12 [#20](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/20)
- allow to secure `database/backup` endpoint [#1](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/1),[#19](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/19)
### 1.3.0
- compatibility with GitBucket 4.3.0
- fix version order in GitBucket Plugins panel
- default backup file contains date with timestamp [#12](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/12)
### 1.2.0
- binary compatibility with GitBucket 4.x
### 1.1
- recompilation to ensure binary compatibility with GitBucket 3.11
### 1.0
- introduce gitbucket-h2-backup-plugin
- allows to backup h2 database via a live dump