| commit | author | age | ||
| 48fe87 | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| M | 2 | <html> |
| 3 | <head> | |
| 4 | <!-- Begin Header --> | |
| 5 | <title>Gitblit</title> | |
| 6 | <meta charset="utf-8"> | |
| 7 | <meta name="ROBOTS" content="INDEX"> | |
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| 9 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| 10 | ||
| 11 | <link rel="stylesheet" href="./bootstrap/css/bootstrap.css"> | |
| 12 | <link rel='shortcut icon' type='image/png' href='./gitblt-favicon.png' /> | |
| 13 | <link rel="stylesheet" href="./prettify/prettify.css" /> | |
| 14 | <!-- Google Plus Profile Page --> | |
| 15 | <link rel="publisher" href="https://plus.google.com/114464678392593421684" /> | |
| 16 | <style type="text/css"> a.gpluspage { margin-top:3px;text-decoration: none; } </style> | |
| 17 | ||
| 18 | <!-- Google Plus One --> | |
| 19 | <link rel="canonical" href="http://gitblit.com" /> | |
| 20 | <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script> | |
| 21 | <style type="text/css"> div.gplusone { margin-top:12px; } </style> | |
| 22 | ||
| 23 | <script src="./prettify/prettify.js"></script> | |
| 24 | <script src="./bootstrap/js/jquery.js"></script> | |
| 25 | <script src="./bootstrap/js/bootstrap.min.js"></script> | |
| 26 | </head> | |
| 27 | <body onload='prettyPrint()'> <!-- Navigation Bar --> | |
| 28 | <div class="navbar navbar-fixed-top"> | |
| 29 | <div class="navbar-inner"> | |
| 30 | <div class="container"> | |
| 31 | <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> | |
| 32 | <span class="icon-bar"></span> | |
| 33 | <span class="icon-bar"></span> | |
| 34 | <span class="icon-bar"></span> | |
| 35 | </a> | |
| 36 | <a class="brand" href="./"><img src="./gitblt_25_white.png" alt="Gitblit"></img></a> | |
| 37 | <div class="nav-collapse"> | |
| 38 | <ul class="nav"> | |
| 39 | <li class='dropdown'> <!-- Menu --> | |
| 40 | <a class='dropdown-toggle' href='#' data-toggle='dropdown'>about<b class='caret'></b></a> | |
| 41 | <ul class='dropdown-menu'> | |
| 42 | <li><a href='index.html'>overview</a></li> | |
| 43 | <li><a href='features.html'>features</a></li> | |
| 44 | <li><a href='screenshots.html'>screenshots</a></li> | |
| 45 | </ul></li> <!-- End Menu --> | |
| 46 | <li class='dropdown'> <!-- Menu --> | |
| 47 | <a class='dropdown-toggle' href='#' data-toggle='dropdown'>documentation<b class='caret'></b></a> | |
| 48 | <ul class='dropdown-menu'> | |
| 49 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 50 | <a tabindex='-1' href='#'>Gitblit GO</a> | |
| 51 | <ul class='dropdown-menu'> | |
| 52 | <li><a href='setup_go.html'>setup GO</a></li> | |
| 53 | <li><a href='upgrade_go.html'>upgrade GO</a></li> | |
| 54 | </ul></li> <!-- End Submenu --> | |
| 55 | <li class='divider'></li> | |
| 56 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 57 | <a tabindex='-1' href='#'>Gitblit WAR</a> | |
| 58 | <ul class='dropdown-menu'> | |
| 59 | <li><a href='setup_war.html'>setup WAR</a></li> | |
| 60 | <li><a href='upgrade_war.html'>upgrade WAR</a></li> | |
| 61 | </ul></li> <!-- End Submenu --> | |
| 62 | <li class='divider'></li> | |
| 63 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 64 | <a tabindex='-1' href='#'>Server Configuration</a> | |
| 65 | <ul class='dropdown-menu'> | |
| 66 | <li><a href='administration.html'>administration</a></li> | |
| 67 | <li><a href='setup_authentication.html'>authentication</a></li> | |
| 68 | <li><a href='setup_hooks.html'>push hooks</a></li> | |
| 69 | <li><a href='setup_lucene.html'>lucene indexing</a></li> | |
| 70 | <li><a href='setup_proxy.html'>reverse proxies</a></li> | |
| 71 | <li><a href='setup_clientmenus.html'>client app menus</a></li> | |
| 72 | <li><a href='setup_bugtraq.html'>bugtraq</a></li> | |
| 73 | <li><a href='setup_mirrors.html'>mirrors</a></li> | |
| 74 | <li><a href='setup_scaling.html'>scaling</a></li> | |
| 75 | <li class='divider'></li> | |
| 76 | <li><a href='setup_viewer.html'>Gitblit as a viewer</a></li> | |
| 77 | </ul></li> <!-- End Submenu --> | |
| 78 | <li class='divider'></li> | |
| 79 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 80 | <a tabindex='-1' href='#'>Client Usage</a> | |
| 81 | <ul class='dropdown-menu'> | |
| 82 | <li><a href='setup_transport_http.html'>using HTTP/HTTPS</a></li> | |
| 83 | <li><a href='setup_transport_ssh.html'>using SSH</a></li> | |
| 84 | <li><a href='eclipse_plugin.html'>using the Eclipse plugin</a></li> | |
| 85 | </ul></li> <!-- End Submenu --> | |
| 86 | <li class='divider'></li> | |
| 87 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 88 | <a tabindex='-1' href='#'>Tickets</a> | |
| 89 | <ul class='dropdown-menu'> | |
| 90 | <li><a href='tickets_overview.html'>overview</a></li> | |
| 91 | <li><a href='tickets_using.html'>using</a></li> | |
| 92 | <li><a href='tickets_barnum.html'>barnum</a></li> | |
| 93 | <li><a href='tickets_setup.html'>setup</a></li> | |
| 94 | <li><a href='tickets_replication.html'>replication & advanced administration</a></li> | |
| 95 | </ul></li> <!-- End Submenu --> | |
| 96 | <li class='divider'></li> | |
| 97 | <li class='dropdown-submenu'> <!-- Submenu --> | |
| 98 | <a tabindex='-1' href='#'>Plugins</a> | |
| 99 | <ul class='dropdown-menu'> | |
| 100 | <li><a href='plugins_overview.html'>overview</a></li> | |
| 101 | <li><a href='plugins_extensions.html'>extension points</a></li> | |
| 102 | </ul></li> <!-- End Submenu --> | |
| 103 | <li class='divider'></li> | |
| 104 | <li><a href='federation.html'>federation</a></li> | |
| 105 | <li class='divider'></li> | |
| 106 | <li><a href='properties.html'>settings</a></li> | |
| 107 | <li><a href='faq.html'>faq</a></li> | |
| 108 | <li class='divider'></li> | |
| 109 | <li><a href='design.html'>design</a></li> | |
| 110 | <li><a href='rpc.html'>rpc</a></li> | |
| 111 | </ul></li> <!-- End Menu --> | |
| 112 | <li class='dropdown'> <!-- Menu --> | |
| 113 | <a class='dropdown-toggle' href='#' data-toggle='dropdown'>releases<b class='caret'></b></a> | |
| 114 | <ul class='dropdown-menu'> | |
| 115 | <li><a href='releasenotes.html'>release notes</a></li> | |
| 116 | <li><a href='releases.html'>release history</a></li> | |
| 117 | <li class='divider'></li> | |
| 118 | <li><a href='roadmap.html'>roadmap</a></li> | |
| 119 | </ul></li> <!-- End Menu --> | |
| 120 | <li class='dropdown'> <!-- Menu --> | |
| 121 | <a class='dropdown-toggle' href='#' data-toggle='dropdown'>downloads<b class='caret'></b></a> | |
| 122 | <ul class='dropdown-menu'> | |
| 123 | <li><a href='http://dl.bintray.com/gitblit/releases/gitblit-1.6.0.zip'>Gitblit GO (Windows)</a></li> | |
| 124 | <li><a href='http://dl.bintray.com/gitblit/releases/gitblit-1.6.0.tar.gz'>Gitblit GO (Linux/OSX)</a></li> | |
| 125 | <li><a href='http://dl.bintray.com/gitblit/releases/gitblit-1.6.0.war'>Gitblit WAR</a></li> | |
| 126 | <li class='divider'></li> | |
| 127 | <li><a href='https://registry.hub.docker.com/u/jmoger/gitblit/'>Gitblit GO (Docker)</a></li> | |
| 128 | <li class='divider'></li> | |
| 129 | <li><a href='http://plugins.gitblit.com'>Plugins Registry</a></li> | |
| 130 | <li class='divider'></li> | |
| 131 | <li><a href='http://dl.bintray.com/gitblit/releases/manager-1.6.0.zip'>Gitblit Manager</a></li> | |
| 132 | <li><a href='http://dl.bintray.com/gitblit/releases/fedclient-1.6.0.zip'>Federation Client</a></li> | |
| 133 | <li class='divider'></li> | |
| 134 | <li><a href='http://dl.bintray.com/gitblit/releases/gbapi-1.6.0.zip'>API Library</a></li> | |
| 135 | <li class='divider'></li> | |
| 136 | <li><a href='https://bintray.com/gitblit/releases/gitblit'>Bintray (1.4.0+)</a></li> | |
| 137 | <li><a href='https://code.google.com/p/gitblit/downloads/list?can=1'>GoogleCode (pre-1.4.0)</a></li> | |
| 138 | <li class='divider'></li> | |
| 139 | <li><a href='http://gitblit.github.io/gitblit-maven'>Maven Repository</a></li> | |
| 140 | </ul></li> <!-- End Menu --> | |
| 141 | <li class='dropdown'> <!-- Menu --> | |
| 142 | <a class='dropdown-toggle' href='#' data-toggle='dropdown'>links<b class='caret'></b></a> | |
| 143 | <ul class='dropdown-menu'> | |
| 144 | <li><a href='https://dev.gitblit.com'>dev.gitblit.com (self-hosted)</a></li> | |
| 145 | <li class='divider'></li> | |
| 146 | <li><a href='http://plugins.gitblit.com'>Plugins Registry</a></li> | |
| 147 | <li class='divider'></li> | |
| 148 | <li><a href='https://github.com/gitblit/gitblit'>Github</a></li> | |
| 149 | <li><a href='http://code.google.com/p/gitblit/issues/list'>Issues</a></li> | |
| 150 | <li><a href='http://groups.google.com/group/gitblit'>Discussion</a></li> | |
| 151 | <li><a href='https://plus.google.com/114464678392593421684'>Google+</a></li> | |
| 152 | <li><a href='https://twitter.com/gitblit'>Twitter</a></li> | |
| 153 | <li><a href='http://www.ohloh.net/p/gitblit'>Ohloh</a></li> | |
| 154 | <li class='divider'></li> | |
| 155 | <li><a href='https://plus.google.com/+JamesMoger'>+JamesMoger</a></li> | |
| 156 | <li><a href='https://twitter.com/JamesMoger'>@JamesMoger</a></li> | |
| 157 | </ul></li> <!-- End Menu --> | |
| 158 | <li class='divider-vertical'></li> | |
| 159 | <li><a href='https://plus.google.com/114464678392593421684?prsrc=3' class='gpluspage'><img src='https://ssl.gstatic.com/images/icons/gplus-16.png' width='16' height='16 style='order: 0;'/></a></li><li><div class='gplusone'><g:plusone size='small' href='http://gitblit.com'></g:plusone></div></li> | |
| 160 | </ul> | |
| 161 | </div><!--/.nav-collapse --> | |
| 162 | </div> | |
| 163 | </div> | |
| 164 | </div><!-- end Navigation Bar --> | |
| 165 | <div class='container'> | |
| 166 | <!-- Begin Markdown --> | |
| 167 | <h2 class="section" id='H1'><a href="#H1" class="sectionlink"><i class="icon-share-alt"> </i></a>Remote Management, Administration and Integration</h2><p><em>SINCE 0.7.0</em></p><p>Gitblit optionally allows a remote client to administer the Gitblit server. This client could be a Java-based tool or perhaps a tool written in another language.</p> | |
| 168 | <pre><code>web.enableRpcServlet=true | |
| 169 | web.enableRpcManagement=false | |
| 170 | web.enableRpcAdministration=false | |
| 171 | </code></pre><p><strong>https</strong> is strongly recommended because passwords are insecurely transmitted form your browser/rpc client using Basic authentication!</p><p>The Gitblit JSON RPC mechanism, like the Gitblit JGit servlet, syndication/feed servlet, etc, supports request-based authentication. Making an <em>admin</em> request will trigger Gitblit's basic authentication mechanism. Listing of repositories, generally, will not trigger this authentication mechanism unless <em>web.authenticateViewPages=true</em>. That means its possible to allow anonymous enumeration of repositories that are not <em>view restricted</em> or <em>clone restricted</em>. Of course, if credentials are provided then all private repositories that are available to the user account will be enumerated in the JSON response.</p> | |
| 172 | <h3 class="section" id='H2'><a href="#H2" class="sectionlink"><i class="icon-share-alt"> </i></a>Gitblit Manager</h3><p><a href="http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%">Gitblit Manager</a> is an example Java/Swing application that allows remote management (repository and user objects) and administration (server settings) of a Gitblit server.</p><p>This application uses a combination of RSS feeds and the JSON RPC interface, both of which are part of the <a href="http://code.google.com/p/gitblit/downloads/detail?name=%API%">Gitblit API</a> library, to present live information from a Gitblit server. Some JSON RPC methods from the utility class <code>com.gitblit.utils.RpcUtils</code> are not currently used by the Gitblit Manager.</p><p><strong>NOTE:</strong><br/>Gitblit Manager stores your login credentials <strong>INSECURELY</strong> in homedir/.gitblit/config.</p> | |
| 173 | <h2 class="section" id='H3'><a href="#H3" class="sectionlink"><i class="icon-share-alt"> </i></a>RSS Query Interface</h2><p>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.</p><p>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.</p> | |
| 174 | <table class="table"> | |
| 175 | <tr><th>url parameter</th><th>default</th><th>description</th></tr> | |
| 176 | <tr><td colspan='3'><b>standard query</b></td></tr> | |
| 177 | <tr><td><em>repository</em></td><td><em>required</em></td><td>repository name is part of the url (see examples below)</td></tr> | |
| 178 | <tr><td>ot=</td><td><em>optional</em><br/>default: COMMIT</td><td>object type to return in results. COMMIT or TAG</td></tr> | |
| 179 | <tr><td>h=</td><td><em>optional</em><br/>default: HEAD</td><td>starting branch, ref, or commit id</td></tr> | |
| 180 | <tr><td>l=</td><td><em>optional</em><br/>default: web.syndicationEntries</td><td>maximum return count</td></tr> | |
| 181 | <tr><td>pg=</td><td><em>optional</em><br/>default: 0</td><td>page number for paging<br/>(offset into history = pagenumber*maximum return count)</td></tr> | |
| 182 | <tr><td colspan='3'><b>search query</b></td></tr> | |
| 183 | <tr><td>s=</td><td><em>required</em></td><td>search string</td></tr> | |
| 184 | <tr><td>st=</td><td><em>optional</em><br/>default: COMMIT</td><td>search type</td></tr> | |
| 185 | </table> | |
| 186 | <h3 class="section" id='H4'><a href="#H4" class="sectionlink"><i class="icon-share-alt"> </i></a>Example RSS Queries</h3> | |
| 187 | <pre><code>https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master | |
| 188 | https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master&s=documentation | |
| 189 | https://localhost:8443/feed/gitblit.git?l=50&h=refs/heads/master&s=james&st=author&pg=2 | |
| 190 | </code></pre> | |
| 191 | <h2 class="section" id='H5'><a href="#H5" class="sectionlink"><i class="icon-share-alt"> </i></a>JSON Remote Procedure Call (RPC) Interface</h2> | |
| 192 | <h3 class="section" id='H6'><a href="#H6" class="sectionlink"><i class="icon-share-alt"> </i></a>RPC Protocol Versions</h3> | |
| 193 | <table class="table"> | |
| 194 | <tbody> | |
| 195 | <tr><th>Release</th><th>Protocol Version</th></tr> | |
| 196 | <tr><td>Gitblit v0.7.0</td><td>1 (inferred version)</td></tr> | |
| 197 | <tr><td>Gitblit v0.8.0</td><td>2</td></tr> | |
| 198 | <tr><td>Gitblit v0.9.0 - v1.0.0</td><td>3</td></tr> | |
| 199 | <tr><td>Gitblit v1.1.0</td><td>4</td></tr> | |
| 200 | <tr><td>Gitblit v1.2.0</td><td>5</td></tr> | |
| 201 | <tr><td>Gitblit v1.3.1</td><td>6</td></tr> | |
| 202 | <tr><td>Gitblit v1.4.0</td><td>7</td></tr> | |
| 203 | <tr><td>Gitblit v1.6.0</td><td>8</td></tr> | |
| 204 | </tbody> | |
| 205 | </table> | |
| 206 | <h4 class="section" id='H7'><a href="#H7" class="sectionlink"><i class="icon-share-alt"> </i></a>Protocol Version 5</h4> | |
| 207 | <ul> | |
| 208 | <li><em>SET_REPOSITORY_MEMBERS</em> will reject all calls because this would elevate all discrete permissions to RW+<br/>Use <em>SET_REPOSITORY_MEMBER_PERMISSIONS</em> instead.</li> | |
| 209 | <li><em>SET_REPOSITORY_TEAMS</em> will reject all calls because this would elevate all discrete permissions to RW+<br/>Use <em>SET_REPOSITORY_TEAM_PERMISSIONS</em> instead.</li> | |
| 210 | </ul> | |
| 211 | <h3 class="section" id='H8'><a href="#H8" class="sectionlink"><i class="icon-share-alt"> </i></a>RPC Request and Response Types</h3> | |
| 212 | <table class="table"> | |
| 213 | <tr><th colspan='2'>url parameters</th><th rowspan='2'>required<br/>user<br/>permission</th><th rowspan='2'>protocol<br/>version</th><th colspan='2'>json</th></tr> | |
| 214 | <tr><th>req=</th><th>name=</th><th>post body</th><th>response body</th></tr> | |
| 215 | <tr><td colspan='6'><em>web.enableRpcServlet=true</em></td></tr> | |
| 216 | <tr><td>GET_PROTOCOL</td><td>-</td><td>-</td><td>2</td><td>-</td><td>Integer</td></tr> | |
| 217 | <tr><td>LIST_REPOSITORIES</td><td>-</td><td>-</td><td>1</td><td>-</td><td>Map<String, RepositoryModel></td></tr> | |
| 218 | <tr><td>LIST_BRANCHES</td><td>-</td><td>-</td><td>1</td><td>-</td><td>Map<String, List<String>></td></tr> | |
| 219 | <tr><td>LIST_SETTINGS</td><td>-</td><td><em>-</em></td><td>1</td><td>-</td><td>ServerSettings (basic keys)</td></tr> | |
| 220 | <tr><td>GET_USER</td><td>user name</td><td>-</td><td>6</td><td>-</td><td>UserModel</td></tr> | |
| 221 | <tr><td>FORK_REPOSITORY</td><td>repository name</td><td><em>-</em></td><td>8</td><td>-</td><td>-</td></tr> | |
| 222 | <tr><td colspan='6'><em>web.enableRpcManagement=true</em></td></tr> | |
| 223 | <tr><td>CREATE_REPOSITORY</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>RepositoryModel</td><td>-</td></tr> | |
| 224 | <tr><td>EDIT_REPOSITORY</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>RepositoryModel</td><td>-</td></tr> | |
| 225 | <tr><td>DELETE_REPOSITORY</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>RepositoryModel</td><td>-</td></tr> | |
| 226 | <tr><td>LIST_USERS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<UserModel></td></tr> | |
| 227 | <tr><td>CREATE_USER</td><td>user name</td><td><em>admin</em></td><td>1</td><td>UserModel</td><td>-</td></tr> | |
| 228 | <tr><td>EDIT_USER</td><td>user name</td><td><em>admin</em></td><td>1</td><td>UserModel</td><td>-</td></tr> | |
| 229 | <tr><td>DELETE_USER</td><td>user name</td><td><em>admin</em></td><td>1</td><td>UserModel</td><td>-</td></tr> | |
| 230 | <tr><td>LIST_TEAMS</td><td>-</td><td><em>admin</em></td><td>2</td><td>-</td><td>List<TeamModel></td></tr> | |
| 231 | <tr><td>CREATE_TEAM</td><td>team name</td><td><em>admin</em></td><td>2</td><td>TeamModel</td><td>-</td></tr> | |
| 232 | <tr><td>EDIT_TEAM</td><td>team name</td><td><em>admin</em></td><td>2</td><td>TeamModel</td><td>-</td></tr> | |
| 233 | <tr><td>DELETE_TEAM</td><td>team name</td><td><em>admin</em></td><td>2</td><td>TeamModel</td><td>-</td></tr> | |
| 234 | <tr><td>LIST_REPOSITORY_MEMBERS</td><td>repository name</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<String></td></tr> | |
| 235 | <tr><td><s>SET_REPOSITORY_MEMBERS</s></td><td><s>repository name</s></td><td><em><s>admin</s></em></td><td><s>1</s></td><td><s>List<String></s></td><td>-</td></tr> | |
| 236 | <tr><td>LIST_REPOSITORY_MEMBER_PERMISSIONS</td><td>repository name</td><td><em>admin</em></td><td>5</td><td>-</td><td>List<String></td></tr> | |
| 237 | <tr><td>SET_REPOSITORY_MEMBER_PERMISSIONS</td><td>repository name</td><td><em>admin</em></td><td>5</td><td>List<String></td><td>-</td></tr> | |
| 238 | <tr><td>LIST_REPOSITORY_TEAMS</td><td>repository name</td><td><em>admin</em></td><td>2</td><td>-</td><td>List<String></td></tr> | |
| 239 | <tr><td><s>SET_REPOSITORY_TEAMS</s></td><td><s>repository name</s></td><td><em><s>admin</s></em></td><td><s>2</s></td><td><s>List<String></s></td><td>-</td></tr> | |
| 240 | <tr><td>LIST_REPOSITORY_TEAM_PERMISSIONS</td><td>repository name</td><td><em>admin</em></td><td>5</td><td>-</td><td>List<String></td></tr> | |
| 241 | <tr><td>SET_REPOSITORY_TEAM_PERMISSIONS</td><td>repository name</td><td><em>admin</em></td><td>5</td><td>List<String></td><td>-</td></tr> | |
| 242 | <tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>ServerSettings (management keys)</td></tr> | |
| 243 | <tr><td>CLEAR_REPOSITORY_CACHE</td><td>-</td><td><em>-</em></td><td>4</td><td>-</td><td>-</td></tr> | |
| 244 | <tr><td>REINDEX_TICKETS</td><td>repository name</td><td><em>-</em></td><td>7</td><td>-</td><td>-</td></tr> | |
| 245 | <tr><td colspan='6'><em>web.enableRpcAdministration=true</em></td></tr> | |
| 246 | <tr><td>LIST_FEDERATION_REGISTRATIONS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationModel></td></tr> | |
| 247 | <tr><td>LIST_FEDERATION_RESULTS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationModel></td></tr> | |
| 248 | <tr><td>LIST_FEDERATION_PROPOSALS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationProposal></td></tr> | |
| 249 | <tr><td>LIST_FEDERATION_SETS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>List<FederationSet></td></tr> | |
| 250 | <tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>ServerSettings (all keys)</td></tr> | |
| 251 | <tr><td>EDIT_SETTINGS</td><td>-</td><td><em>admin</em></td><td>1</td><td>Map<String, String></td><td>-</td></tr> | |
| 252 | <tr><td>LIST_STATUS</td><td>-</td><td><em>admin</em></td><td>1</td><td>-</td><td>ServerStatus (see example below)</td></tr> | |
| 253 | </table> | |
| 254 | <h3 class="section" id='H9'><a href="#H9" class="sectionlink"><i class="icon-share-alt"> </i></a>RPC/HTTP Response Codes</h3> | |
| 255 | <table class="table"> | |
| 256 | <tr><th>code</th><th>name</th><th>description</th></tr> | |
| 257 | <tr><td>200</td><td>success</td><td>Gitblit processed the request successfully</td></tr> | |
| 258 | <tr><td>401</td><td>unauthorized</td><td>Gitblit requires user credentials to process the request</td></tr> | |
| 259 | <tr><td>403</td><td>forbidden</td><td>Gitblit can not process the request for the supplied credentials</td></tr> | |
| 260 | <tr><td>405</td><td>method not allowed</td><td>Gitblit has disallowed the processing the specified request</td></tr> | |
| 261 | <tr><td>500</td><td>server error</td><td>Gitblit failed to process the request likely because the input object created a conflict</td></tr> | |
| 262 | <tr><td>501</td><td>unknown request</td><td>Gitblit does not recognize the RPC request type</td></tr> | |
| 263 | </table> | |
| 264 | <h3 class="section" id='H10'><a href="#H10" class="sectionlink"><i class="icon-share-alt"> </i></a>Example: LIST_REPOSITORIES</h3><p><strong>url</strong>: <a href="https://localhost/rpc?req=LIST_REPOSITORIES">https://localhost/rpc?req=LIST_REPOSITORIES</a><br/><strong>response body</strong>: Map<String, RepositoryModel> where the map key is the clone url of the repository</p><p><pre>{ | |
| 265 | "https://localhost/git/libraries/xmlapache.git": { | |
| 266 | "name": "libraries/xmlapache.git", | |
| 267 | "description": "apache xmlrpc client and server", | |
| 268 | "owner": "admin", | |
| 269 | "lastChange": "2010-01-28T22:12:06Z", | |
| 270 | "hasCommits": true, | |
| 271 | "showRemoteBranches": false, | |
| 272 | "useTickets": false, | |
| 273 | "useDocs": false, | |
| 274 | "accessRestriction": "VIEW", | |
| 275 | "isFrozen": false, | |
| 276 | "showReadme": false, | |
| 277 | "federationStrategy": "FEDERATE_THIS", | |
| 278 | "federationSets": [ | |
| 279 | "libraries" | |
| 280 | ], | |
| 281 | "isFederated": false, | |
| 282 | "skipSizeCalculation": false, | |
| 283 | "skipSummaryMetrics": false, | |
| 284 | "size": "102 KB" | |
| 285 | }, | |
| 286 | "https://localhost/git/libraries/smack.git": { | |
| 287 | "name": "libraries/smack.git", | |
| 288 | "description": "smack xmpp client", | |
| 289 | "owner": "admin", | |
| 290 | "lastChange": "2009-01-28T18:38:14Z", | |
| 291 | "hasCommits": true, | |
| 292 | "showRemoteBranches": false, | |
| 293 | "useTickets": false, | |
| 294 | "useDocs": false, | |
| 295 | "accessRestriction": "VIEW", | |
| 296 | "isFrozen": false, | |
| 297 | "showReadme": false, | |
| 298 | "federationStrategy": "FEDERATE_THIS", | |
| 299 | "federationSets": [], | |
| 300 | "isFederated": false, | |
| 301 | "skipSizeCalculation": false, | |
| 302 | "skipSummaryMetrics": false, | |
| 303 | "size": "4.8 MB" | |
| 304 | } | |
| 305 | } | |
| 306 | </pre></p> | |
| 307 | <h3 class="section" id='H11'><a href="#H11" class="sectionlink"><i class="icon-share-alt"> </i></a>Example: EDIT_REPOSITORY (rename)</h3><p>The original repository name is specified in the <em>name</em> url parameter. The new name is set within the JSON object.</p><p><strong>url</strong>: <a href="https://localhost/rpc?req=EDIT_REPOSITORY&name=libraries/xmlapache.git">https://localhost/rpc?req=EDIT_REPOSITORY&name=libraries/xmlapache.git</a><br/><strong>post body</strong>: RepositoryModel</p><p><pre>{ | |
| 308 | "name": "libraries/xmlapache-renamed.git", | |
| 309 | "description": "apache xmlrpc client and server", | |
| 310 | "owner": "admin", | |
| 311 | "lastChange": "2010-01-28T22:12:06Z", | |
| 312 | "hasCommits": true, | |
| 313 | "showRemoteBranches": false, | |
| 314 | "useTickets": false, | |
| 315 | "useDocs": false, | |
| 316 | "accessRestriction": "VIEW", | |
| 317 | "isFrozen": false, | |
| 318 | "showReadme": false, | |
| 319 | "federationStrategy": "FEDERATE_THIS", | |
| 320 | "federationSets": [ | |
| 321 | "libraries" | |
| 322 | ], | |
| 323 | "isFederated": false, | |
| 324 | "skipSizeCalculation": false, | |
| 325 | "skipSummaryMetrics": false, | |
| 326 | "size": "102 KB" | |
| 327 | } | |
| 328 | </pre></p> | |
| 329 | <h3 class="section" id='H12'><a href="#H12" class="sectionlink"><i class="icon-share-alt"> </i></a>Example: LIST_USERS</h3><p><strong>url</strong>: <a href="https://localhost/rpc?req=LIST_USERS">https://localhost/rpc?req=LIST_USERS</a><br/><strong>response body</strong>: List<UserModel></p><p><pre>[ | |
| 330 | { | |
| 331 | "username": "admin", | |
| 332 | "password": "admin", | |
| 333 | "canAdmin": true, | |
| 334 | "excludeFromFederation": true, | |
| 335 | "repositories": [] | |
| 336 | }, | |
| 337 | { | |
| 338 | "username": "test", | |
| 339 | "password": "test", | |
| 340 | "canAdmin": false, | |
| 341 | "excludeFromFederation": false, | |
| 342 | "repositories": [ | |
| 343 | "libraries/xmlapache.git", | |
| 344 | "libraries/smack.git" | |
| 345 | ] | |
| 346 | } | |
| 347 | ] | |
| 348 | </pre></p> | |
| 349 | <h3 class="section" id='H13'><a href="#H13" class="sectionlink"><i class="icon-share-alt"> </i></a>Example: LIST_SETTINGS</h3><p><strong>url</strong>: <a href="https://localhost/rpc?req=LIST_SETTINGS">https://localhost/rpc?req=LIST_SETTINGS</a><br/><strong>response body</strong>: ServerSettings</p><p><pre>{ | |
| 350 | "settings": { | |
| 351 | "web.siteName": { | |
| 352 | "name": "web.siteName", | |
| 353 | "currentValue": "", | |
| 354 | "defaultValue": "", | |
| 355 | "description": "Gitblit Web Settings\nIf blank Gitblit is displayed.", | |
| 356 | "since": "0.5.0", | |
| 357 | "caseSensitive": false, | |
| 358 | "restartRequired": false, | |
| 359 | "spaceDelimited": false | |
| 360 | }, | |
| 361 | "web.summaryCommitCount": { | |
| 362 | "name": "web.summaryCommitCount", | |
| 363 | "currentValue": "16", | |
| 364 | "defaultValue": "16", | |
| 365 | "description": "The number of commits to display on the summary page\nValue must exceed 0 else default of 16 is used", | |
| 366 | "since": "0.5.0", | |
| 367 | "caseSensitive": false, | |
| 368 | "restartRequired": false, | |
| 369 | "spaceDelimited": false | |
| 370 | } | |
| 371 | } | |
| 372 | } | |
| 373 | </pre></p> | |
| 374 | <h3 class="section" id='H14'><a href="#H14" class="sectionlink"><i class="icon-share-alt"> </i></a>Example: LIST_STATUS</h3><p><strong>url</strong>: <a href="https://localhost/rpc?req=LIST_STATUS">https://localhost/rpc?req=LIST_STATUS</a><br/><strong>response body</strong>: ServerStatus</p><p><pre>{ | |
| 375 | "bootDate": "2011-10-22T12:13:00Z", | |
| 376 | "version": "0.7.0-SNAPSHOT", | |
| 377 | "releaseDate": "PENDING", | |
| 378 | "isGO": true, | |
| 379 | "systemProperties": { | |
| 380 | "file.encoding": "Cp1252", | |
| 381 | "java.home": "C:\\Program Files\\Java\\jdk1.6.0_26\\jre", | |
| 382 | "java.io.tmpdir": "C:\\Users\\JAMESM~1\\AppData\\Local\\Temp\\", | |
| 383 | "java.runtime.name": "Java(TM) SE Runtime Environment", | |
| 384 | "java.runtime.version": "1.6.0_26-b03", | |
| 385 | "java.vendor": "Sun Microsystems Inc.", | |
| 386 | "java.version": "1.6.0_26", | |
| 387 | "java.vm.info": "mixed mode", | |
| 388 | "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM", | |
| 389 | "java.vm.vendor": "Sun Microsystems Inc.", | |
| 390 | "java.vm.version": "20.1-b02", | |
| 391 | "os.arch": "amd64", | |
| 392 | "os.name": "Windows 7", | |
| 393 | "os.version": "6.1" | |
| 394 | }, | |
| 395 | "heapAllocated": 128057344, | |
| 396 | "heapFree": 120399168, | |
| 397 | "heapSize": 1899560960, | |
| 398 | "servletContainer": "jetty/7.4.3.v20110701" | |
| 399 | } | |
| 400 | </pre> | |
| 401 | <!-- End Markdown --> | |
| 402 | <div ><ul class="pager"><li class="previous"><a href="design.html">← design</a></li> </ul></div><footer class="footer"><p class="pull-right">generated 2014-06-16</p> | |
| 403 | <p>The content of this page is licensed under the <a href="http://creativecommons.org/licenses/by/3.0">Creative Commons Attribution 3.0 License</a>.</p> | |
| 404 | </footer> | |
| 405 | </div> | |
| 406 | <!-- Google Analytics --> | |
| 407 | <script type="text/javascript"> | |
| 408 | var _gaq = _gaq || []; | |
| 409 | _gaq.push(['_setAccount', 'UA-24377072-1']); | |
| 410 | _gaq.push(['_trackPageview']); | |
| 411 | ||
| 412 | (function() { | |
| 413 | var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; | |
| 414 | ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; | |
| 415 | var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); | |
| 416 | })(); | |
| 417 | </script> | |
| 418 | ||
| 419 | </body> | |
| 420 | </html> | |
