{"id":19428471,"url":"https://github.com/gitbucket/gitbucket-pages-plugin","last_synced_at":"2025-04-24T18:30:53.339Z","repository":{"id":42382127,"uuid":"48359835","full_name":"gitbucket/gitbucket-pages-plugin","owner":"gitbucket","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T00:22:35.000Z","size":116,"stargazers_count":41,"open_issues_count":0,"forks_count":11,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-29T01:23:50.116Z","etag":null,"topics":["gitbucket","gitbucket-plugin","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","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":"LICENSE","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}},"created_at":"2015-12-21T08:23:55.000Z","updated_at":"2024-10-29T00:22:39.000Z","dependencies_parsed_at":"2022-09-05T14:40:13.338Z","dependency_job_id":"e53a0876-c305-497f-bcf0-729c6903d669","html_url":"https://github.com/gitbucket/gitbucket-pages-plugin","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-pages-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-pages-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-pages-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitbucket%2Fgitbucket-pages-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitbucket","download_url":"https://codeload.github.com/gitbucket/gitbucket-pages-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223961157,"owners_count":17232251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","scala"],"created_at":"2024-11-10T14:15:21.398Z","updated_at":"2024-11-10T14:15:21.994Z","avatar_url":"https://github.com/gitbucket.png","language":"Scala","readme":"\n# Gitbucket-Pages-Plugin [![Gitter](https://img.shields.io/gitter/room/gitbucket/gitbucket.js.svg)](https://gitter.im/gitbucket/gitbucket) [![build](https://github.com/gitbucket/gitbucket-pages-plugin/workflows/build/badge.svg?branch=master)](https://github.com/gitbucket/gitbucket-pages-plugin/actions?query=workflow%3Abuild+branch%3Amaster)\n\nThis plugin provides *Project Pages* functionality for\n[GitBucket](https://github.com/gitbucket/gitbucket) based repositories.\n\n## User guide\n\nThis plugin serves static files directly from one of the following\nplaces:\n\n- `gb-pages` branch (with fallback to `gh-pages` to be compatible with\n  github, this is the default)\n- `master` branch\n- `docs` folder under `master` branch\n\n### Quick start\n\n- create a directory or branch if necessary (eg. create an orphan branch called `gb-pages`: `git checkout --orphan gb-pages \u0026\u0026 git rm -f $(git ls-files)`)\n- create a static site under this branch. E.g. `echo '\u003ch1\u003ehello, world\u003c/h1\u003e' \u003e index.html` to create a simple file.\n- commit \u0026\u0026 push to gitbucket this orphan branch\n- open the browser and point to `\u003cyour repo url\u003e/pages`\n\n**Note**: This plugin won't render markdown content. To render markdown content, use the GitBucket Wiki functionality, or use one of the many static site generators (e.g. [jekyll](http://jekyllrb.com/), [hugo](https://gohugo.io/))\n\n## Installation\n\n**This plugin is bundled with newer version of GitBucket, for older\nversion please follow the instruction below**\n\n### Install manually\n\n- download from [releases](https://github.com/gitbucket/gitbucket-pages-plugin/releases)\n- copy the jar file to `\u003cGITBUCKET_HOME\u003e/plugins/` (`GITBUCKET_HOME` defaults to `~/.gitbucket`)\n- enable it in plugin settings (you may need to restart gitbucket)\n\n## Versions\n\n| pages version | gitbucket version |\n|     :---:     |       :---:       |\n| 1.10.0        | 4.36.0            |\n| 1.9.0         | 4.35.0            |\n| 1.8.0         | 4.32.0            |\n| 1.7.0         | 4.23.0            |\n| 1.6.0         | 4.19.0            |\n| 1.5.0         | 4.15.0            |\n| 1.3           | 4.14.1            |\n| 1.2           | 4.13              |\n| 1.1           | 4.11              |\n| 1.0           | 4.10              |\n| 0.9           | 4.9               |\n| 0.8           | 4.6               |\n| 0.7           | 4.3 ~ 4.6         |\n| 0.6           | 4.2.x             |\n| 0.5           | 4.0, 4.1          |\n| 0.4           | 3.13              |\n| 0.3           | 3.12              |\n| 0.2           | 3.11              |\n| 0.1           | 3.9, 3.10         |\n\n\n## Security (panic mode)\n\nTo prevent XSS, one must use two different domains to host the pages and\nGitbucket itself. Below is a working example of nginx configuration to achieve that.\n\n```\nserver {\n    listen 80;\n    server_name git.local;\n\n    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {\n        rewrite  ^/([^/]+)/([^/]+)/pages/(.*)$  http://doc.local/$1/$2/pages/$3  redirect;\n    }\n\n    location / {\n        proxy_pass http://127.0.0.1:8080;\n    }\n}\n\nserver {\n    listen 80;\n    server_name doc.local;\n\n    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {\n        proxy_pass http://127.0.0.1:8080;\n    }\n\n    location / {\n        return 403;\n    }\n}\n```\n\n## CI\n\n- build by [GitHub Actions](https://github.com/gitbucket/gitbucket-pages-plugin/actions)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbucket%2Fgitbucket-pages-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitbucket%2Fgitbucket-pages-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbucket%2Fgitbucket-pages-plugin/lists"}