Gitbucket-Pages-Plugin

This plugin provides Project Pages functionality for GitBucket based repositories.

User guide

This plugin can serve static files from a special orphan branch called gb-pages under <base url>/<user>/<project>/pages/. (fallback to gh-pages if it exists)

Quick start

• create an orphan branch called gb-pages using git checkout --orphan gb-pages && git rm -f $(git ls-files)
• create a static site under this branch. E.g. echo '<h1>hello, world</h1>' > index.html to create a simple file.
• commit && push to gitbucket this orphan branch
• open the browser and point to <your repo url>/pages

Note: This plugin won't render markdown content. To render markdown content, use the wiki or one of the many static site generators (jekyll, hugo, etc)

Installation

• download from releases
• copy the jar file to <GITBUCKET_HOME>/plugins/ (Note that GITBUCKET_HOME defaults to ~/.gitbucket)
• restart gitbucket and enjoy

Versions

pages version	gitbucket version
1.0	4.11
0.9	4.9, 4.10
0.8	4.6
0.7	4.3 ~ 4.6
0.6	4.2.x
0.5	4.0, 4.1
0.4	3.13
0.3	3.12
0.2	3.11
0.1	3.9, 3.10

Security (panic mode)

To prevent XSS, one must use two different domains to host the pages and Gitbucket itself. Below is a working example of nginx configuration to achieve that.

server {
    listen 80;
    server_name git.local;

    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {
        rewrite  ^/([^/]+)/([^/]+)/pages/(.*)$  http://doc.local/$1/$2/pages/$3  redirect;
    }

    location / {
        proxy_pass 127.0.0.1:8080;
    }
}

server {
    listen 80;
    server_name doc.local;

    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {
        proxy_pass 127.0.0.1:8080;
    }

    location / {
        return 403;
    }
}

CI

• build by travis-ci