Skip to content

Commit eb28b9f

Browse files
committed
update docs
1 parent 115fe09 commit eb28b9f

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.MD

+20-16
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# gitbucket-h2-backup-plugin
1+
# gitbucket-h2-backup-plugin [![Gitter](https://img.shields.io/gitter/room/gitbucket/gitbucket.js.svg?style=flat-square)](https://gitter.im/gitbucket/gitbucket) [![Travis](https://img.shields.io/travis/gitbucket-plugins/gitbucket-h2-backup-plugin.svg?style=flat-square)](https://travis-ci.org/gitbucket-plugins/gitbucket-h2-backup-plugin)
22

3-
This plugin enhances [GitBucket](https://github.com/gitbucket/gitbucket) by offering a way to backup/dump the H2 database of GitBucket.
3+
This plugin enhances [GitBucket](https://github.com/gitbucket/gitbucket) by offering a way to backup/dump the entire H2 database of GitBucket.
44

5-
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/takezoe/gitbucket/wiki/Backup)
5+
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)
66

77
## Features
88

@@ -45,6 +45,7 @@ On success, you will receive a `HTTP 200` answer with a body containing `done: F
4545

4646
Plugin version | GitBucket version
4747
:--------------|:-----------------
48+
1.6.x | >= 4.21.y |
4849
1.5.x | >= 4.16.y
4950
1.4.x | >= 4.10.y
5051
1.3.x | >= 4.3.y
@@ -60,33 +61,36 @@ sbt clean package
6061

6162
## Installation
6263

63-
- copy gitbucket-h2-backup.jar into GITBUCKET_HOME/plugins
64-
- restart gitbucket
64+
- copy `gitbucket-h2-backup.jar` into GITBUCKET_HOME/plugins
65+
- restart GitBucket
6566

6667
## Release Notes
6768

69+
### 1.6.0
70+
- compatibility with GitBucket 4.21.x
71+
6872
### 1.5.1
69-
- compatibility with gitbucket 4.16.0 and scala 2.12
73+
- compatibility with GitBucket 4.16.0 and Scala 2.12
7074

7175
### 1.4.0
7276

73-
- compatibility with gitbucket 4.10, scala 2.12 [#20](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/20)
77+
- compatibility with GitBucket 4.10, scala 2.12 [#20](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/20)
7478
- 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)
7579
see [Securing backup endpoint](#securing-backup-endpoint) paragraph
7680

7781
### 1.3.0
7882

79-
- compatibility with gitbucket 4.3.0
80-
- fix version order in gitbucket Plugins panel
83+
- compatibility with GitBucket 4.3.0
84+
- fix version order in GitBucket Plugins panel
8185
- default backup file contains date with timestamp [#12](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/12)
8286

8387
### 1.2.0
8488

85-
- binary compatibility with gitbucket 4.x
89+
- binary compatibility with GitBucket 4.x
8690

8791
### 1.1
8892

89-
- recompilation to ensure binary compatibility with gitbucket 3.11
93+
- recompilation to ensure binary compatibility with GitBucket 3.11
9094

9195
### 1.0
9296

@@ -97,10 +101,10 @@ sbt clean package
97101

98102
In version 1.4.0, it is possible to secure the `database/backup` endpoint:
99103

100-
- launch gitbucket with System property _secure.backup_ set to true (for example `-Dsecure.backup=true` on the command line)
101-
- due to actual limitations of gitbucket & plugins security, once the previous setting is activated,
102-
a call to `http://YOUR_GITBUCKET/database/backup` will be temporary redirected `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`.
104+
- launch GitBucket with System property _secure.backup_ set to true (for example `-Dsecure.backup=true` on the command line)
105+
- due to actual limitations of GitBucket & plugins security, once the previous setting is activated,
106+
a call to `http://YOUR_GITBUCKET/database/backup` will be temporary redirected `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`.
103107
You have to follow this temporary redirection.
104108
- if you call the endpoint using _httpie_, use the `--follow` parameter
105-
- this secured endpoint route is TEMPORARY you should not call it directly.
106-
If you do think that it will change in the future when gitbucket will support secured routes for plugins.
109+
- this secured endpoint route is TEMPORARY you should not call it directly.
110+
If you do think that it will change in the future when GitBucket will support secured routes for plugins.

0 commit comments

Comments
 (0)