From bcc616b8e425f73e7abc6799f23445c1e411463d Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Fri, 14 Oct 2011 17:05:23 -0400 Subject: [PATCH] Rpc Client create/edit user and repository now fully functional. --- docs/00_index.mkd | 163 ++++++++++++++++------------------------------------- 1 files changed, 50 insertions(+), 113 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index 703d8eb..943dd0e 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -1,123 +1,60 @@ ## Overview -Gitblit is an open-source, integrated pure Java stack for managing, viewing, and serving [Git][git] repositories. -Its designed primarily as a tool for small workgroups who want to host [Git][git] repositories on a Windows machine. Having said that, it works equally well on any standard Linux distribution. - +<a href="screenshots.html" title="Screenshots"><img class="overview" src="thumbs/00.png" alt="Screenshots" /></a> + +Gitblit is an open-source, pure Java stack for managing, viewing, and serving [Git][git] repositories.<br/> +Its designed primarily as a tool for small workgroups who want to host centralized repositories. + +Gitblit is available in two variations: + +1. *Gitblit GO* - a complete & integrated pure Java stack + + This is what you should download if you want to go from zero to Git in less than 5 mins. + Gitblit GO is like a mashup of Apache httpd, [Git][git], and Gitweb with simplified configuration and maintenance. + All dependencies are downloaded on first execution. +2. *Gitblit WAR* - a traditional WAR distribution + + This is what you should download if you want to deploy Gitblit into your own servlet container (e.g. Tomcat, Jetty, etc). + All dependencies are bundled. + +### Tools + +- *Gitblit RPC Client* - a Java Swing tool to clone repositories and remotely administer a Gitblit server +- *Gitblit Federation Client* - a command line tool to clone/pull groups of repositories and optionally users and settings + +### Java Runtime Requirement + +Gitblit requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK). + ### Current Release -[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit] (*%BUILDDATE%*) +**%VERSION%** ([go](http://code.google.com/p/gitblit/downloads/detail?name=%GO%)|[war](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%)|[fedclient](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%)|[rpcclient](http://code.google.com/p/gitblit/downloads/detail?name=%RPCCLIENT%)) based on [%JGIT%][jgit] *released %BUILDDATE%* +- improved: updated ui with Twitter's Bootstrap CSS toolkit + **New:** *web.loginMessage = gitblit* +- added: authenticated JSON RPC mechanism + **New:** *web.enableRpcServlet = true* + **New:** *web.enableRpcAdministration = false* +- added: reusable JSON RPC client class +- added: Swing RPC Client application for cloning and administration of repositories, users, & federation proposals. +- fixed: federation protocol timestamps. dates are now serialized to the [iso8601](http://en.wikipedia.org/wiki/ISO_8601) standard. + **This breaks 0.6.0 federation clients/servers.** +- fixed: Gitblit now runs on Servlet 3.0 webservers (e.g. Tomcat 7, Jetty 8) +- fixed: Set the RSS content type for Firefox 4 (issue 22) +- fixed: Null pointer exception if did not set federation strategy (issue 20) +- fixed: Gitblit GO allows SSL renegotiation if running on Java 1.6.0_22 or later +- added: IUserService.setup(IStoredSettings) for custom user service implementations +- added: setting to control Gitblit GO context path for proxy setups + **New:** *server.contextPath = /* +- updated: MarkdownPapers 1.2.3 + +issues, binaries, and sources @ [Google Code][googlecode]<br/> sources @ [Github][gitbltsrc] -### Design Principles -1. [Keep It Simple, Stupid](http://en.wikipedia.org/wiki/KISS_principle) -2. Offer useful features for serving Git repositories. If feature is complex, refer to #1. -3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies and to keep the Gitblit distribution svelte. - -### Features -- Out-of-the-box integrated stack requiring minimal configuration -- JGit SmartHTTP servlet -- Browser and git client authentication -- Four repository access control configurations and a Read-Only flag - <ul class='noBullets'> - <li> *Anonymous View, Clone & Push*</li> - <li> *Authenticated Push*</li> - <li> *Authenticated Clone & Push*</li> - <li> *Authenticated View, Clone & Push*</li> - <li> Freeze repository (i.e. deny push, make read-only) - </ul> -- Gitweb inspired UI -- Administrators may create, edit, rename, or delete repositories through the web UI -- Administrators may create, edit, rename, or delete users through the web UI -- Repository Owners may edit repositories through the web UI -- Automatically generates a self-signed certificate for https communications -- Dates can optionally be displayed using the browser's reported timezone -- Author and Committer email address display can be controlled -- Dynamic zip downloads feature -- Markdown view support -- Syntax highlighting -- Customizable regular expression handling for commit messages -- Single text file for server configuration -- Single text file for users configuration -- Simple repository stats and activity graph (uses Google Charts) -- Optional utility pages - <ul class='noBullets'> - <li> Docs page which enumerates all Markdown files within a repository</li> - <li> Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li> - </ul> - -### Limitations -- HTTP/HTTPS are the only supported protocols -- Access controls are not path-based, they are repository-based -- Only Administrators can create, rename or delete repositories -- Gitblit is an integrated, full-stack solution. There is no WAR build at this time. - -### Todo List -- Review spots where Gitblit can cache data instead of abusing the disk - - stats - - users.properties access - - available repositories - - etc -- Code documentation -- Unit testing - -### Idea List -- Ticgit activity/timeline -- Ticgit query feature with paging support -- Ticgit ticket change history -- View images on Blob page -- View other binary files on Blob page -- Markdown editing feature -- Blame (waiting for the [JGit][jgit] team to do the hard part) - ### License -Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) - -### Inspirations -- [Gitweb](http://www.git-scm.com) -- [Fossil](http://www.fossil-scm.org) - -## Architecture - - - -### Bundled Dependencies -The following dependencies are bundled with the Gitblit zip distribution file. - -- [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0) -- [JavaService](http://forge.ow2.org/projects/javaservice) (BSD and LGPL) -- magnifying glass search icon courtesy of [Gnome](http://gnome.org) (Creative Commons CC-BY) -- modified Git logo originally designed by [Henrik Nyh](http://henrik.nyh.se/2007/06/alternative-git-logo-and-favicon) -- other icons courtesy of [FatCow Hosting](http://www.fatcow.com/free-icons) (Creative Commons CC-BY) - -### Downloaded Dependencies -The following dependencies are automatically downloaded from the Apache Maven repository and from the Eclipse Maven repository when Gitblit is launched for the first time. - -- [JGit][jgit] (EDL 1.0) -- [Wicket](http://wicket.apache.org) (Apache 2.0) -- [WicketStuff GoogleCharts](https://github.com/wicketstuff/core/wiki/GoogleCharts) (Apache 2.0) -- [MarkdownPapers](http://markdown.tautua.org) (Apache 2.0) -- [Jetty](http://eclipse.org/jetty) (Apache 2.0, EPL 1.0) -- [SLF4J](http://www.slf4j.org) (MIT/X11) -- [Log4j](http://logging.apache.org/log4j) (Apache 2.0) -- [JCommander](http://jcommander.org) (Apache 2.0) -- [BouncyCastle](http://www.bouncycastle.org) (MIT/X11) - -### Other Build Dependencies -- [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed) - -## Building -[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured. - -1. Clone the git repository from [Github][gitbltsrc]. -2. Import the gitblit project into your Eclipse workspace.<br/> -*There will be lots of build errors.* -3. Using Ant, execute the `build.xml` script in the project root.<br/> -*This will download all necessary build dependencies and will also generate the Keys class for accessing settings.* -4. Select your gitblit project root and **Refresh** the project, this should correct all build problems. -5. Review the settings in `gitblit.properties` in your project root.<br/> -Make sure you set an appropriate value for *git.repositoriesFolder*. -6. Execute the *com.gitblit.Launcher* class to start Gitblit. +Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense] [jgit]: http://eclipse.org/jgit "Eclipse JGit Site" [git]: http://git-scm.com "Official Git Site" -[gitbltsrc]: http://somewhere.com "gitblit git repository" \ No newline at end of file +[gitbltsrc]: http://github.com/gitblit "gitblit git repository" +[googlecode]: http://code.google.com/p/gitblit "gitblit project management" +[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" -- Gitblit v1.9.1