\r
### Tools\r
\r
-- *Gitblit API* - a JSON RPC client library for integrating Gitblit into your systems\r
+- *Gitblit API* - an RSS/JSON RPC client library for integrating Gitblit into your systems\r
- *Gitblit Manager* - a Java/Swing application for remote administration of a Gitblit server which uses the Gitblit API library\r
- *Gitblit Federation Client* - a command line tool to clone/pull groups of repositories and optionally users and settings\r
\r
**New:** *web.enableRpcServlet = true* \r
**New:** *web.enableRpcManagement = false* \r
**New:** *web.enableRpcAdministration = false*\r
-- added: Gitblit API JSON RPC library\r
+- added: Gitblit API RSS/JSON RPC library\r
- added: Gitblit Manager (Java/Swing Application) for remote administration of a Gitblit server.\r
- added: per-repository setting to skip size calculation (faster repositories page loading)\r
- added: per-repository setting to skip summary metrics calculation (faster summary page loading)\r
- fixed: Gitblit now runs on Servlet 3.0 webservers (e.g. Tomcat 7, Jetty 8) (issue 23)\r
- fixed: Set the RSS content type of syndication feeds for Firefox 4 (issue 22)\r
- fixed: RSS feeds are now properly encoded to UTF-8\r
-- fixed: RSS feeds now properly generated parameterized links if *web.mountParameters=false*\r
+- fixed: RSS feeds now properly generate parameterized links if *web.mountParameters=false*\r
- fixed: Null pointer exception if did not set federation strategy (issue 20)\r
- fixed: Gitblit GO allows SSL renegotiation if running on Java 1.6.0_22 or later\r
-- updated: MarkdownPapers 1.2.4\r
+- updated: MarkdownPapers 1.2.5\r
\r
issues, binaries, and sources @ [Google Code][googlecode]<br/>\r
sources @ [Github][gitbltsrc]\r
-## JSON Remote Procedure Call (RPC) Interface\r
+## Remote Management, Administration and Integration\r
\r
*SINCE 0.7.0*\r
\r
\r
**https** is strongly recommended because passwords are insecurely transmitted form your browser/rpc client using Basic authentication!\r
\r
-The Gitblit RPC mechanism, like the Gitblit JGit servlet, syndication/feed servlet, etc, supports request-based authentication. Making an *admin* request will trigger Gitblit's basic authentication mechanism. Listing of repositories, generally, will not trigger this authentication mechanism unless *web.authenticateViewPages=true*. That means its possible to allow anonymous enumeration of repositories that are not *view restricted* or *clone restricted*. Of course, if credentials are provided then all private repositories that are available to the user account will be enumerated in the JSON response.\r
+The Gitblit JSON RPC mechanism, like the Gitblit JGit servlet, syndication/feed servlet, etc, supports request-based authentication. Making an *admin* request will trigger Gitblit's basic authentication mechanism. Listing of repositories, generally, will not trigger this authentication mechanism unless *web.authenticateViewPages=true*. That means its possible to allow anonymous enumeration of repositories that are not *view restricted* or *clone restricted*. Of course, if credentials are provided then all private repositories that are available to the user account will be enumerated in the JSON response.\r
+\r
+### Gitblit Manager\r
+\r
+[Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) is an example Java/Swing application that allows remote management (repository and user objects) and administration (server settings) of a Gitblit server.\r
+ \r
+This application uses a combination of RSS feeds and the JSON RPC interface, both of which are part of the [Gitblit API](http://code.google.com/p/gitblit/downloads/detail?name=%API%) library. Some JSON RPC methods from the utility class `com.gitblit.utils.RpcUtils` are not currently used by the Gitblit Manager.\r
+\r
+**NOTE:** \r
+Gitblit Manager stores your login credentials **INSECURELY** in homedir/.gitblit/config.\r
+\r
+### EGit "Import from Gitblit" Feature (Planning)\r
+\r
+One obvious goal of a Gitblit RPC mechanism would be to have an EGit Feature that allows authentication and enumeration of Gitblit repositories from the Eclipse *Import...* menu. Cloning (hopefully batch) would be delegated to EGit.\r
+\r
+This particular project should not be difficult as the only external dependency for `com.gitblit.utils.RpcUtils` is [google-gson](http://google-gson.googlecode.com) which is already a dependency of the EGit/GitHub Mylyn feature.\r
+\r
+One proposal from the EGit team is to define a common JSON RPC method for enumeration of repositories which can be implemented by Git hosts. The EGit team would then implement the UI and the client-side enumeration code. This idea was raised as part of this [feature request for EGit](https://bugs.eclipse.org/bugs/show_bug.cgi?id=361251).\r
+\r
+Currently this project is in the planning stage.\r
+\r
+## RSS Query Interface\r
+\r
+At present, Gitblit does not yet support retrieving Git objects (commits, etc) via the JSON RPC mechanism. However, the repository/branch RSS feeds can be used to extract log/history information from a repository branch.\r
+\r
+The Gitblit API includes methods for retrieving and interpreting RSS feeds. The Gitblit Manager uses these methods to allow branch activity monitoring and repository searching.\r
+\r
+<table>\r
+<tr><th>url parameter</th><th>default</th><th>description</th></tr>\r
+<tr><td colspan='3'><b>standard query</b></td></tr>\r
+<tr><td><em>repository</em></td><td><em>required</em></td><td>repository name is part of the url (see examples below)</td></tr>\r
+<tr><td>h=</td><td><em>optional</em><br/>default: HEAD</td><td>starting branch, ref, or commit id</td></tr>\r
+<tr><td>l=</td><td><em>optional</em><br/>default: web.syndicationEntries</td><td>maximum return count</td></tr>\r
+<tr><td colspan='3'><b>search query</b></td></tr>\r
+<tr><td>s=</td><td><em>required</em></td><td>search string</td></tr>\r
+<tr><td>st=</td><td><em>optional</em><br/>default: COMMIT</td><td>search type</td></tr>\r
+</table>\r
+\r
+### Example RSS Queries\r
\r
-### RPC Requests\r
+ https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master\r
+ https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master&s=documentation\r
+ https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master&s=james&st=author\r
+\r
+## JSON Remote Procedure Call (RPC) Interface\r
\r
<table>\r
<tr><th colspan='2'>url parameters</th><th rowspan='2'>required<br/>user<br/>permission</th><th colspan='2'>json</th></tr>\r
<tr><td>501</td><td>unknown request</td><td>Gitblit does not recognize the RPC request type</td></tr>\r
</table>\r
\r
-### Gitblit Manager\r
-\r
-[Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) is an example Java/Swing application that allows remote administration of a Gitblit server. \r
-This application exercises many, but not all, methods from the utility class `com.gitblit.utils.RpcUtils`.\r
-\r
-**NOTE:** \r
-Gitblit Manager stores your login credentials **INSECURELY** in homedir/.gitblit/config.\r
-\r
-### EGit "Import from Gitblit" Feature (Planning)\r
-\r
-One obvious goal of a Gitblit RPC mechanism would be to have an EGit Feature that allows authentication and enumeration of Gitblit repositories from the Eclipse *Import...* menu. Cloning (hopefully batch) would be delegated to EGit.\r
-\r
-This particular project should not be difficult as the only external dependency for `com.gitblit.utils.RpcUtils` is [google-gson](http://google-gson.googlecode.com) which is already a dependency of the EGit/GitHub Mylyn feature.\r
-\r
-One proposal from the EGit team is to define a common JSON RPC method for enumeration of repositories which can be implemented by Git hosts. The EGit team would then implement the UI and the client-side enumeration code. This idea was raised as part of this [feature request for EGit](https://bugs.eclipse.org/bugs/show_bug.cgi?id=361251).\r
-\r
-Currently this project is in the planning stage.\r
-\r
### Example: LIST_REPOSITORIES\r
\r
**url**: https://localhost/rpc?req=LIST_REPOSITORIES \r
**New:** *web.enableRpcServlet = true* \r
**New:** *web.enableRpcManagement = false* \r
**New:** *web.enableRpcAdministration = false*\r
-- added: Gitblit API JSON RPC library\r
+- added: Gitblit API RSS/JSON RPC library\r
- added: Gitblit Manager (Java/Swing Application) for remote administration of a Gitblit server.\r
- added: per-repository setting to skip size calculation (faster repositories page loading)\r
- added: per-repository setting to skip summary metrics calculation (faster summary page loading)\r
- fixed: Gitblit now runs on Servlet 3.0 webservers (e.g. Tomcat 7, Jetty 8) (issue 23)\r
- fixed: Set the RSS content type of syndication feeds for Firefox 4 (issue 22)\r
- fixed: RSS feeds are now properly encoded to UTF-8\r
-- fixed: RSS feeds now properly generated parameterized links if *web.mountParameters=false*\r
+- fixed: RSS feeds now properly generate parameterized links if *web.mountParameters=false*\r
- fixed: Null pointer exception if did not set federation strategy (issue 20)\r
- fixed: Gitblit GO allows SSL renegotiation if running on Java 1.6.0_22 or later\r
-- updated: MarkdownPapers 1.2.4\r
+- updated: MarkdownPapers 1.2.5\r
\r
### Older Releases\r
\r
projects / gitblit.git / commitdiff