{"id":47620521,"url":"https://github.com/gitbucket/gitbucket-h2-backup-plugin","last_synced_at":"2026-04-01T22:02:56.566Z","repository":{"id":52430165,"uuid":"41728008","full_name":"gitbucket/gitbucket-h2-backup-plugin","owner":"gitbucket","description":"GitBucket H2 Database Backup Plugin","archived":false,"fork":false,"pushed_at":"2026-03-07T17:46:05.000Z","size":2093,"stargazers_count":22,"open_issues_count":5,"forks_count":7,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-03-07T23:22:21.712Z","etag":null,"topics":["gitbucket","gitbucket-plugin"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitbucket.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-09-01T08:57:59.000Z","updated_at":"2026-03-07T19:40:29.000Z","dependencies_parsed_at":"2022-08-18T09:41:38.115Z","dependency_job_id":null,"html_url":"https://github.com/gitbucket/gitbucket-h2-backup-plugin","commit_stats":null,"previous_names":["gitbucket/gitbucket-h2-backup-plugin"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/gitbucket/gitbucket-h2-backup-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-h2-backup-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-h2-backup-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-h2-backup-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-h2-backup-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitbucket","download_url":"https://codeload.github.com/gitbucket/gitbucket-h2-backup-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-h2-backup-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31292631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitbucket","gitbucket-plugin"],"created_at":"2026-04-01T22:01:34.171Z","updated_at":"2026-04-01T22:02:56.550Z","avatar_url":"https://github.com/gitbucket.png","language":"Scala","readme":"# gitbucket-h2-backup-plugin\n\nThis plugin enhances [GitBucket](https://github.com/gitbucket/gitbucket) by offering a way to backup/dump the entire H2 database of GitBucket.\n\nIt 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)\n\n## Features\n\n### H2 Backup\n\nThis plugin allows you to backup the underlying H2 database used by default by GitBucket.\n\n## Usage\n\nThe plugin provides two ways to backup the H2 database:\n\n- via an administration page and a backup button\n- via an HTTP call to `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`\n\nThe default backup file points to `GITBUCKET_DATA/backup/gitbucket-db-YYYY-MM-DD-hhmm.zip` where:\n\n- _GITBUCKET_DATA_ is the standard GitBucket data directory. If not specified, default it's `~/.gitbucket`\n- _YYYY-MM-DD-hhmm_ represents a date with hour and minutes\n\n### UI usage\n\n- goto the `System Administration` menu, section `H2 Backup`\n- modify the file path if the default one doesn't fit your needs\n- hit the `Export database` button\n\n![backup ui](https://cloud.githubusercontent.com/assets/1119660/9659908/3d0afcd4-5253-11e5-8124-39f8a538f6c3.png)\n\n### HTTP call usage\n\nUsing your preferred tool (curl, wget, ...) it is possible start a backup of the H2 database.\n\nThe URL to call looks like `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`\n\nYou can pass an optional argument `dest` that references the destination file path where the backup will be done on the server.\nFor 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`.\nSince `1.3.0`, the _dest_ parameter can denote a relative file path, in this case the file will be created relatively to `GITBUCKET_DATA`.\n\nOn 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.\n\n### HTTP API Authorization\n\nThe api uses token authentication. To generate a token:\n\n1. Login to Gitbucket with an administrative account\n2. In the top-right corner, click the user menu\n3. Click `Account Settings`\n4. On the left, click `Applications`\n5. In `Generate new token` enter a description and click `Generate token`\n6. Add the token to your http call, such as with `curl`:\n\n    `curl --silent --show-error --fail -X POST -H 'Authorization: token your_token_value' http://YOUR_GITBUCKET/api/v3/plugins/database/backup`\n\n## Compatibility\n\nPlugin version | GitBucket version\n:--------------|:-----------------\n1.9.x          | \u003e= 4.35.y\n1.8.x          | \u003e= 4.32.y\n1.7.x          | \u003e= 4.26.y\n1.6.x          | \u003e= 4.21.y\n1.5.x          | \u003e= 4.16.y\n1.4.x          | \u003e= 4.10.y\n1.3.x          | \u003e= 4.3.y\n1.2.x          | 4.x.y\n1.1.x          | 3.11.x\n1.0.x          | 3.6.x, 3.7.x, 3.8.x,, 3.9.x, 3.10.x\n\n## Build\n\n```\nsbt clean assembly\n```\n\n## Installation\n\n- copy `gitbucket-h2-backup.jar` into GITBUCKET_HOME/plugins\n- restart GitBucket\n\n## Release Notes\n\n### 1.9.1\n- remove backup api at GET /database/backup\n- change method from GET to POST on /api/v3/plugins/database/backup\n- backup endpoint is secure by default, and requires an api token for a user with admin rights\n\n### 1.9.0\n- compatibility with GitBucket 4.35.x\n\n### 1.8.0\n- compatibility with GitBucket 4.32.x and Scala 2.13\n\n### 1.7.0\n- Bump sbt-gitbucket-plugin to 1.3.0 to be hosted by the [plugin registry](https://plugins.gitbucket-community.org/)\n\n### 1.6.0\n- compatibility with GitBucket 4.21.x\n\n### 1.5.1\n- compatibility with GitBucket 4.16.0 and Scala 2.12\n\n### 1.4.0\n\n- compatibility with GitBucket 4.10, scala 2.12 [#20](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/20)\n- 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)  \n\n### 1.3.0\n\n- compatibility with GitBucket 4.3.0\n- fix version order in GitBucket Plugins panel\n- default backup file contains date with timestamp [#12](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/12)\n\n### 1.2.0\n\n- binary compatibility with GitBucket 4.x\n\n### 1.1\n\n- recompilation to ensure binary compatibility with GitBucket 3.11\n\n### 1.0\n\n- introduce gitbucket-h2-backup-plugin\n- allows to backup h2 database via a live dump\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbucket%2Fgitbucket-h2-backup-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitbucket%2Fgitbucket-h2-backup-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbucket%2Fgitbucket-h2-backup-plugin/lists"}