This plugin provides Project Pages functionality for GitBucket based repositories.

This plugin serves static files directly from one of the following places:

• gb-pages branch (with fallback to gh-pages to be compatible with github, this is the default)
• master branch
• docs folder under master branch

• create a directory or branch if necessary (eg. create an orphan branch called gb-pages: 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 GitBucket Wiki functionality, or just one of the many static site generators (jekyll, hugo, etc)

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

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;
    }
}

• build by travis-ci