| | |
|---|
| | | |
|---|
| | | The existing plugin mechanism is based on [pf4j](https://github.com/decebals/pf4j). Plugins are distributed as zip files and may include their runtime dependencies or may rely on the bundled dependencies of other plugins and/or Gitblit core. |
|---|
| | | |
|---|
| | | The zip plugins are stored in `${baseFolder}/plugins` and are unpacked on startup into folders of the same name. |
|---|
| | | The plugin zip files are stored in `${baseFolder}/plugins` and are unpacked on startup into folders of the same name. |
|---|
| | | |
|---|
| | | A plugin defines it's metadata in the META-INF/MANIFEST.MF file: |
|---|
| | | |
|---|
| | | Plugin-Id: powertools |
|---|
| | | Plugin-Description: Command and control Gitblit over SSH |
|---|
| | | Plugin-Class: com.gitblit.plugin.powertools.Powertools |
|---|
| | | Plugin-Class: com.gitblit.plugin.powertools.Plugin |
|---|
| | | Plugin-Version: 1.2.0 |
|---|
| | | Plugin-Requires: 1.5.0 |
|---|
| | | Plugin-Provider: gitblit.com |
|---|
| | | |
|---|
| | | In addition to extending Gitblit core, plugins can also define extension points that may be implemented by other plugins. Therefore a plugin may depend on other plugins. |
|---|
| | |
|---|
| | | **NOTE:** |
|---|
| | | The pf4j plugin framework relies on a javac apt processor to generate compile-time extension information, so be sure to enable apt processing in your build process. |
|---|
| | | |
|---|
| | | #### Limitations of Dependencies & Requires |
|---|
| | | #### Limitations of Plugin Dependencies |
|---|
| | | |
|---|
| | | Plugins may specify dependencies by ID, but may not specify specific versions of a dependency. The plugin registry allows you to specify a *requires* version of Gitblit, but this is not currently enforced. |
|---|
| | | Plugins may specify plugin dependencies by their ID, but they may not specify dependency versions. |
|---|
| | | |
|---|
| | | ### Managing Plugins |
|---|
| | | |
|---|
| | | Administrators may manage plugins through the `plugin` SSH dispatch command: |
|---|
| | | |
|---|
| | | ssh host plugin |
|---|
| | | ssh host -l username -p 29418 plugin |
|---|
| | | |
|---|
| | | Through this command interface plugins can be started, stopped, disabled, enabled, installed, uninstalled, listed, etc. |
|---|
| | | Through this command interface plugins can be started, stopped, disabled, enabled, installed, uninstalled, listed, etc. Each command is supports the `--help` argument which will guide you in understanding the options and usage of the command. |
|---|
| | | |
|---|
| | | You may watch an Asciinema screencast of how to use the SSH transport and the plugin manager [here](https://asciinema.org/a/9342). |
|---|
| | | |
|---|
| | | ### Default Plugin Registry |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | plugins.registry = http://plugins.gitblit.com/plugins.json |
|---|
| | | |
|---|
| | | The [registry](http://plugins.gitblit.com/plugins.json) is currently hosted in a [Git repository on Github](https://github.com/gitblit/gitblit-registry). This git repository is also a [Maven-compatible repository](http://plugins.gitblit.com), which hosts some plugin binaries. |
|---|
| | | The [default plugins registry](http://plugins.gitblit.com) is currently hosted in a [Git repository on Github](https://github.com/gitblit/gitblit-registry). You can view the default registry file [here](http://plugins.gitblit.com/plugins.json). The default plugin registry is also a Maven-2 compatible repository. |
|---|
| | | |
|---|
| | | ### Contributing Plugins to the Default Registry |
|---|
| | | |
|---|
| | | If you develop your own plugins that you want hosted by or linked in the default registry, open pull request for the registry repository. Any contributed binaries hosted in this repository must have Maven metadata and the SHA-1 & MD5 checksums. By default, Gitblit enforces checksum validation on all downloads. |
|---|
| | | If you develop your own plugins that you want hosted by or linked in the default registry, open a pull request for the registry repository. Any contributed binaries hosted in this repository must have Maven metadata and the SHA-1 & MD5 checksums. By default, Gitblit enforces checksum validation on all downloads. |
|---|
| | | |
|---|
| | | ### Hosting your Own Registry / Allowing Multiple Registries |
|---|
| | | |
|---|
| | | The `plugins.json` file is parameterized with the `${self}` placeholder. This parameter is substituted on download with with the source URL of the registry file. This allows you to clone and serve your own copy of this git repository or just server your own `plugins.json` on your own network. |
|---|
| | | The `plugins.json` file is parameterized with the `${self}` placeholder. This parameter is substituted on download with with the source URL of the registry file. This allows you to clone and serve your own copy of this git repository or just serve your own `plugins.json` on your own network. |
|---|
| | | |
|---|
| | | Gitblit also supports loading multiple plugin registries. Just place another **properly formatted** `.json` file in `${baseFolder}/plugins` and Gitblit will load that as an additional registry. |
|---|
| | | |
|---|
| | | ### Mac OSX Fonts |
|---|
| | | |
|---|
| | | Gitblit's core SSH commands and those in the *powertools* plugin rely on ANSI border characters to provide a pretty presentation of data. Unfortunately, the fonts provided by Apple - while very nice - don't work well with ANSI border characters. The following public domain fixed-width, fixed-point, bitmapped fonts work very nicely. I find the 6x12 font with a line spacing of ~0.8 to be quite acceptable. |
|---|
| | | |
|---|
| | | [6x12.dfont](6x12.dfont) |
|---|
| | | [6x13.dfont](6x13.dfont) |
|---|
| | | [7x13.dfont](7x13.dfont) |
|---|
| | | [7x14.dfont](7x14.dfont) |
|---|
| | | |
|---|
