Skip to content

Document api usage #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2021
Merged

Document api usage #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb4bc47
Change documentation to reference /api/v3 endpoint instead of /databa…
c0llab0rat0r Apr 4, 2021
01ca9d4
Ignore .bsp folder
c0llab0rat0r Apr 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
target/
.bsp
.idea/
.idea_modules/
project/project/
Expand Down
24 changes: 19 additions & 5 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ It originates from [pull request #845](takezoe/gitbucket#845) and can be used to

### H2 Backup

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

## Usage

The plugin provides 2 ways to backup the H2 database:
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/database/backup
- 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:

Expand All @@ -34,13 +34,27 @@ The default backup file points to `GITBUCKET_DATA/backup/gitbucket-db-YYYY-MM-DD

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/database/backup`.
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/database/backup?dest=/var/backups/gitbucket.zip` will do an H2 backup of the gitbucket database into the file `/var/backups/gitbucket.zip`.
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 body containing `done: FULL_PATH_OF_BACKUP_FILE`.

### 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 -i -H 'Authorization: token your_token_value' http://YOUR_GITBUCKET/api/v3/plugins/database/backup`

## Compatibility

Plugin version | GitBucket version
Expand Down