Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitbucket/gitbucket-pages-plugin
https://github.com/gitbucket/gitbucket-pages-plugin
gitbucket gitbucket-plugin scala
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gitbucket/gitbucket-pages-plugin
- Owner: gitbucket
- License: other
- Created: 2015-12-21T08:23:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T00:22:35.000Z (16 days ago)
- Last Synced: 2024-10-29T01:23:50.116Z (16 days ago)
- Topics: gitbucket, gitbucket-plugin, scala
- Language: Scala
- Homepage:
- Size: 113 KB
- Stars: 41
- Watchers: 7
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Gitbucket-Pages-Plugin [](https://gitter.im/gitbucket/gitbucket) [](https://github.com/gitbucket/gitbucket-pages-plugin/actions?query=workflow%3Abuild+branch%3Amaster)
This plugin provides *Project Pages* functionality for
[GitBucket](https://github.com/gitbucket/gitbucket) based repositories.
## User guide
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
### Quick start
- 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 '
hello, world
' > index.html` to create a simple file.
- commit && push to gitbucket this orphan branch
- open the browser and point to `/pages`
**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/))
## Installation
**This plugin is bundled with newer version of GitBucket, for older
version please follow the instruction below**
### Install manually
- download from [releases](https://github.com/gitbucket/gitbucket-pages-plugin/releases)
- copy the jar file to `/plugins/` (`GITBUCKET_HOME` defaults to `~/.gitbucket`)
- enable it in plugin settings (you may need to restart gitbucket)
## Versions
| pages version | gitbucket version |
| :---: | :---: |
| 1.10.0 | 4.36.0 |
| 1.9.0 | 4.35.0 |
| 1.8.0 | 4.32.0 |
| 1.7.0 | 4.23.0 |
| 1.6.0 | 4.19.0 |
| 1.5.0 | 4.15.0 |
| 1.3 | 4.14.1 |
| 1.2 | 4.13 |
| 1.1 | 4.11 |
| 1.0 | 4.10 |
| 0.9 | 4.9 |
| 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 http://127.0.0.1:8080;
}
}
server {
listen 80;
server_name doc.local;
location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {
proxy_pass http://127.0.0.1:8080;
}
location / {
return 403;
}
}
```
## CI
- build by [GitHub Actions](https://github.com/gitbucket/gitbucket-pages-plugin/actions)