Documentation

diff --git a/NOTICE b/NOTICE
index 27c01e0e043ee554bd51c8f9538a67ef4790bb62..da61b2012ae824cd894efad2ed8d7d051107fd39 100644 (file)
--- a/NOTICE
+++ b/NOTICE
@@ -1,345 +1,360 @@
-Gitblit\r
-Copyright 2011 gitblit.com\r
-\r
-This product includes software developed at\r
-The Apache Software Foundation (http://www.apache.org/).\r
-\r
-This is an aggregated NOTICE file for the projects included\r
-in this distribution or linked to by this distribution.\r
-\r
----------------------------------------------------------------------------\r
-Bootstrap\r
----------------------------------------------------------------------------\r
-   Bootstrap, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://twitter.github.com/bootstrap\r
-\r
----------------------------------------------------------------------------\r
-google-code-prettify\r
----------------------------------------------------------------------------\r
-   google-code-prettify, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://code.google.com/p/google-code-prettify\r
-\r
----------------------------------------------------------------------------\r
-Commons Daemon\r
----------------------------------------------------------------------------\r
-   Commons Daemon, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://commons.apache.org/daemon\r
-   \r
----------------------------------------------------------------------------\r
-JGit\r
----------------------------------------------------------------------------\r
-   JGit, released under the\r
-   Eclipse Distribution License 1.0.\r
-\r
-   http://eclipse.org/jgit\r
-   \r
----------------------------------------------------------------------------\r
-Apache Wicket\r
----------------------------------------------------------------------------\r
-   Apache Wicket, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://wicket.apache.org\r
-   \r
----------------------------------------------------------------------------\r
-Jetty\r
----------------------------------------------------------------------------\r
-   Jetty, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://eclipse.org/jetty\r
-\r
----------------------------------------------------------------------------\r
-Apache Lucene\r
----------------------------------------------------------------------------\r
-   Apache Lucene, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://lucene.apache.org\r
-\r
----------------------------------------------------------------------------\r
-Groovy\r
----------------------------------------------------------------------------\r
-   Groovy, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://groovy.codehaus.org\r
-\r
----------------------------------------------------------------------------\r
-SLF4J\r
----------------------------------------------------------------------------\r
-   SLF4J, released under the\r
-   MIT/X11 License.\r
-\r
-   http://www.slf4j.org\r
-   \r
----------------------------------------------------------------------------\r
-Log4j\r
----------------------------------------------------------------------------\r
-   Log4j, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://logging.apache.org/log4j   \r
- \r
----------------------------------------------------------------------------\r
-BouncyCastle\r
----------------------------------------------------------------------------\r
-   BouncyCastle, released under the\r
-   MIT/X11 License.\r
-\r
-   http://www.bouncycastle.org\r
-   \r
----------------------------------------------------------------------------\r
-JSch\r
----------------------------------------------------------------------------\r
-   JSch - Java Secure Channel, released under the\r
-   BSD License.\r
-\r
-   http://www.jcraft.com/jsch\r
-\r
----------------------------------------------------------------------------\r
-Rome\r
----------------------------------------------------------------------------\r
-   Rome RSS and Atom Java Utilities, released under the\r
-   Apache Software License, Version 1.1.\r
-\r
-   http://rome.dev.java.net\r
-\r
----------------------------------------------------------------------------\r
-jdom\r
----------------------------------------------------------------------------\r
-   jdom xml library, released under the\r
-   Apache-style Software License.\r
-\r
-   http://www.jdom.org\r
-\r
----------------------------------------------------------------------------\r
-google-gson\r
----------------------------------------------------------------------------\r
-   google-gson, released under the\r
-   Apache-style Software License.\r
-\r
-   http://code.google.com/p/google-gson\r
-\r
----------------------------------------------------------------------------\r
-javamail\r
----------------------------------------------------------------------------\r
-   javamail, released under multiple licenses\r
-   CDDL-1.0, BSD, GPL-2.0, GNU-Classpath.\r
-\r
-   http://kenai.com/projects/javamail\r
-\r
----------------------------------------------------------------------------\r
-JUnit\r
----------------------------------------------------------------------------\r
-   JUnit, released under the\r
-   Common Public License.\r
-\r
-   http://junit.org\r
-\r
----------------------------------------------------------------------------\r
-Fancybox image viewer\r
----------------------------------------------------------------------------\r
-   Fancybox image viewer, released under the\r
-   MIT and GPL Licenses.\r
-\r
-   http://fancybox.net\r
-   \r
----------------------------------------------------------------------------\r
-FatCow Icons\r
----------------------------------------------------------------------------\r
-   FatCow Icons, released under the\r
-   Creative Commons CC-BY License.\r
-\r
-   http://www.fatcow.com/free-icons\r
-\r
----------------------------------------------------------------------------\r
-Git logo\r
----------------------------------------------------------------------------\r
-   Git logo, released under the\r
-   Creative Commons CC-BY License.\r
-\r
-   http://henrik.nyh.se/2007/06/alternative-git-logo-and-favicon\r
-\r
----------------------------------------------------------------------------\r
-Git logo\r
----------------------------------------------------------------------------\r
-   Git logo, released under the\r
-   Creative Commons Attribution 3.0 Unported License.\r
-\r
-   http://git-scm.com/downloads/logos\r
-   \r
----------------------------------------------------------------------------\r
-magnifying glass search icon\r
----------------------------------------------------------------------------\r
-   magnifying glass search icon, released under the\r
-   Creative Commons CC-BY License.\r
-\r
-   http://gnome.org\r
-\r
----------------------------------------------------------------------------\r
-GLYHPICONS\r
----------------------------------------------------------------------------\r
-   GLPYHICONS, released under the\r
-   Creative Commons CC-BY License.\r
-\r
-   http://glyphicons.com\r
-      \r
----------------------------------------------------------------------------\r
-UnboundID\r
----------------------------------------------------------------------------\r
-   UnboundID, released under the\r
-   GNU LESSER GENERAL PUBLIC LICENSE.\r
-\r
-   http://www.unboundid.com\r
-\r
----------------------------------------------------------------------------\r
-JCalendar\r
----------------------------------------------------------------------------\r
-   JCalendar, released under the\r
-   GNU LESSER GENERAL PUBLIC LICENSE.\r
-\r
-   http://www.toedter.com/en/jcalendar\r
-   \r
----------------------------------------------------------------------------\r
-Commons-Compress\r
----------------------------------------------------------------------------\r
-   Commons-Compress, released under the\r
-   Apache Software License, Version 2.0.\r
-\r
-   http://commons.apache.org/compress\r
-\r
----------------------------------------------------------------------------\r
-XZ for Java\r
----------------------------------------------------------------------------\r
-   XZ for Java, released under the\r
-   Public Domain\r
-\r
-   http://tukaani.org/xz/java.html\r
-\r
----------------------------------------------------------------------------\r
-Iconic\r
----------------------------------------------------------------------------\r
-   Iconic, release under the\r
-   Creative Commons Share Alike 3.0 License.\r
-   \r
-   http://somerandomdude.com/work/iconic\r
-   \r
----------------------------------------------------------------------------\r
-AngularJS\r
----------------------------------------------------------------------------\r
-   AngularJS, release under the\r
-   MIT License.\r
-   \r
-   http://angularjs.org/   \r
-   \r
----------------------------------------------------------------------------\r
-FreeMarker\r
----------------------------------------------------------------------------\r
-   FreeMarker, release under a\r
-   modified BSD License. (http://www.freemarker.org/docs/app_license.html)\r
-   \r
-   http://www.freemarker.org/\r
-\r
----------------------------------------------------------------------------\r
-Waffle\r
----------------------------------------------------------------------------\r
-   Waffle, release under the\r
-   Eclipse Public License, version 1.0\r
-   \r
-   http://dblock.github.io/waffle\r
-\r
----------------------------------------------------------------------------\r
-JNA\r
----------------------------------------------------------------------------\r
-   JNA, release under the\r
-   Lesser GNU Public License, version 2.1\r
-   \r
-   https://github.com/twall/jna\r
-   \r
----------------------------------------------------------------------------\r
-Guava\r
----------------------------------------------------------------------------\r
-   Guava, release under the\r
-   Apache License 2.0.\r
-   \r
-   https://code.google.com/p/guava-libraries\r
-\r
----------------------------------------------------------------------------\r
-libpam4j\r
----------------------------------------------------------------------------\r
-   libpam4j, release under the\r
-   MIT license.\r
-   \r
-   https://github.com/kohsuke/libpam4j\r
-\r
----------------------------------------------------------------------------\r
-commons-codec\r
----------------------------------------------------------------------------\r
-   commons-codec, release under the\r
-   Apache License 2.0.\r
-   \r
-   http://commons.apache.org/proper/commons-codec\r
-\r
----------------------------------------------------------------------------\r
-pegdown\r
----------------------------------------------------------------------------\r
-   pegdown, release under the\r
-   Apache License 2.0.\r
-   \r
-   https://github.com/sirthias/pegdown\r
-\r
----------------------------------------------------------------------------\r
-font-awesome\r
----------------------------------------------------------------------------\r
-   font-awesome, release under the\r
-   SIL OFL 1.1.\r
-   \r
-   https://github.com/FortAwesome/Font-Awesome\r
-\r
----------------------------------------------------------------------------\r
-AUI (excerpts)\r
----------------------------------------------------------------------------\r
-   AUI, release under the\r
-   Apache License 2.0\r
-   \r
-   https://bitbucket.org/atlassian/aui\r
-\r
----------------------------------------------------------------------------\r
-Jedis\r
----------------------------------------------------------------------------\r
-   Jedis, release under the\r
-   MIT license\r
-   \r
-   https://github.com/xetorthio/jedis\r
-\r
----------------------------------------------------------------------------\r
-args4j\r
----------------------------------------------------------------------------\r
-   args4j, release under the\r
-   Apache License 2.0\r
-   \r
-   http://args4j.kohsuke.org\r
-\r
----------------------------------------------------------------------------\r
-jQuery\r
----------------------------------------------------------------------------\r
-   jQuery, release under the\r
-   MIT License\r
-   \r
-   https://jquery.org\r
-\r
----------------------------------------------------------------------------\r
-flotr2\r
----------------------------------------------------------------------------\r
-   flotr2, release under the\r
-   BSD License\r
-   \r
-   http://humblesoftware.com/flotr2\r
-   
\ No newline at end of file
+Gitblit
+Copyright 2011 gitblit.com
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This is an aggregated NOTICE file for the projects included
+in this distribution or linked to by this distribution.
+
+---------------------------------------------------------------------------
+Bootstrap
+---------------------------------------------------------------------------
+   Bootstrap, released under the
+   Apache Software License, Version 2.0.
+
+   http://twitter.github.com/bootstrap
+
+---------------------------------------------------------------------------
+google-code-prettify
+---------------------------------------------------------------------------
+   google-code-prettify, released under the
+   Apache Software License, Version 2.0.
+
+   http://code.google.com/p/google-code-prettify
+
+---------------------------------------------------------------------------
+Commons Daemon
+---------------------------------------------------------------------------
+   Commons Daemon, released under the
+   Apache Software License, Version 2.0.
+
+   http://commons.apache.org/daemon
+   
+---------------------------------------------------------------------------
+JGit
+---------------------------------------------------------------------------
+   JGit, released under the
+   Eclipse Distribution License 1.0.
+
+   http://eclipse.org/jgit
+   
+---------------------------------------------------------------------------
+Apache Wicket
+---------------------------------------------------------------------------
+   Apache Wicket, released under the
+   Apache Software License, Version 2.0.
+
+   http://wicket.apache.org
+   
+---------------------------------------------------------------------------
+Jetty
+---------------------------------------------------------------------------
+   Jetty, released under the
+   Apache Software License, Version 2.0.
+
+   http://eclipse.org/jetty
+
+---------------------------------------------------------------------------
+Apache Lucene
+---------------------------------------------------------------------------
+   Apache Lucene, released under the
+   Apache Software License, Version 2.0.
+
+   http://lucene.apache.org
+
+---------------------------------------------------------------------------
+Groovy
+---------------------------------------------------------------------------
+   Groovy, released under the
+   Apache Software License, Version 2.0.
+
+   http://groovy.codehaus.org
+
+---------------------------------------------------------------------------
+SLF4J
+---------------------------------------------------------------------------
+   SLF4J, released under the
+   MIT/X11 License.
+
+   http://www.slf4j.org
+   
+---------------------------------------------------------------------------
+Log4j
+---------------------------------------------------------------------------
+   Log4j, released under the
+   Apache Software License, Version 2.0.
+
+   http://logging.apache.org/log4j   
+ 
+---------------------------------------------------------------------------
+BouncyCastle
+---------------------------------------------------------------------------
+   BouncyCastle, released under the
+   MIT/X11 License.
+
+   http://www.bouncycastle.org
+   
+---------------------------------------------------------------------------
+JSch
+---------------------------------------------------------------------------
+   JSch - Java Secure Channel, released under the
+   BSD License.
+
+   http://www.jcraft.com/jsch
+
+---------------------------------------------------------------------------
+Rome
+---------------------------------------------------------------------------
+   Rome RSS and Atom Java Utilities, released under the
+   Apache Software License, Version 1.1.
+
+   http://rome.dev.java.net
+
+---------------------------------------------------------------------------
+jdom
+---------------------------------------------------------------------------
+   jdom xml library, released under the
+   Apache-style Software License.
+
+   http://www.jdom.org
+
+---------------------------------------------------------------------------
+google-gson
+---------------------------------------------------------------------------
+   google-gson, released under the
+   Apache-style Software License.
+
+   http://code.google.com/p/google-gson
+
+---------------------------------------------------------------------------
+javamail
+---------------------------------------------------------------------------
+   javamail, released under multiple licenses
+   CDDL-1.0, BSD, GPL-2.0, GNU-Classpath.
+
+   http://kenai.com/projects/javamail
+
+---------------------------------------------------------------------------
+JUnit
+---------------------------------------------------------------------------
+   JUnit, released under the
+   Common Public License.
+
+   http://junit.org
+
+---------------------------------------------------------------------------
+Fancybox image viewer
+---------------------------------------------------------------------------
+   Fancybox image viewer, released under the
+   MIT and GPL Licenses.
+
+   http://fancybox.net
+   
+---------------------------------------------------------------------------
+FatCow Icons
+---------------------------------------------------------------------------
+   FatCow Icons, released under the
+   Creative Commons CC-BY License.
+
+   http://www.fatcow.com/free-icons
+
+---------------------------------------------------------------------------
+Git logo
+---------------------------------------------------------------------------
+   Git logo, released under the
+   Creative Commons CC-BY License.
+
+   http://henrik.nyh.se/2007/06/alternative-git-logo-and-favicon
+
+---------------------------------------------------------------------------
+Git logo
+---------------------------------------------------------------------------
+   Git logo, released under the
+   Creative Commons Attribution 3.0 Unported License.
+
+   http://git-scm.com/downloads/logos
+   
+---------------------------------------------------------------------------
+magnifying glass search icon
+---------------------------------------------------------------------------
+   magnifying glass search icon, released under the
+   Creative Commons CC-BY License.
+
+   http://gnome.org
+
+---------------------------------------------------------------------------
+GLYHPICONS
+---------------------------------------------------------------------------
+   GLPYHICONS, released under the
+   Creative Commons CC-BY License.
+
+   http://glyphicons.com
+      
+---------------------------------------------------------------------------
+UnboundID
+---------------------------------------------------------------------------
+   UnboundID, released under the
+   GNU LESSER GENERAL PUBLIC LICENSE.
+
+   http://www.unboundid.com
+
+---------------------------------------------------------------------------
+JCalendar
+---------------------------------------------------------------------------
+   JCalendar, released under the
+   GNU LESSER GENERAL PUBLIC LICENSE.
+
+   http://www.toedter.com/en/jcalendar
+   
+---------------------------------------------------------------------------
+Commons-Compress
+---------------------------------------------------------------------------
+   Commons-Compress, released under the
+   Apache Software License, Version 2.0.
+
+   http://commons.apache.org/compress
+
+---------------------------------------------------------------------------
+XZ for Java
+---------------------------------------------------------------------------
+   XZ for Java, released under the
+   Public Domain
+
+   http://tukaani.org/xz/java.html
+
+---------------------------------------------------------------------------
+Iconic
+---------------------------------------------------------------------------
+   Iconic, release under the
+   Creative Commons Share Alike 3.0 License.
+   
+   http://somerandomdude.com/work/iconic
+   
+---------------------------------------------------------------------------
+AngularJS
+---------------------------------------------------------------------------
+   AngularJS, release under the
+   MIT License.
+   
+   http://angularjs.org/   
+   
+---------------------------------------------------------------------------
+FreeMarker
+---------------------------------------------------------------------------
+   FreeMarker, release under a
+   modified BSD License. (http://www.freemarker.org/docs/app_license.html)
+   
+   http://www.freemarker.org/
+
+---------------------------------------------------------------------------
+Waffle
+---------------------------------------------------------------------------
+   Waffle, release under the
+   Eclipse Public License, version 1.0
+   
+   http://dblock.github.io/waffle
+
+---------------------------------------------------------------------------
+JNA
+---------------------------------------------------------------------------
+   JNA, release under the
+   Lesser GNU Public License, version 2.1
+   
+   https://github.com/twall/jna
+   
+---------------------------------------------------------------------------
+Guava
+---------------------------------------------------------------------------
+   Guava, release under the
+   Apache License 2.0.
+   
+   https://code.google.com/p/guava-libraries
+
+---------------------------------------------------------------------------
+libpam4j
+---------------------------------------------------------------------------
+   libpam4j, release under the
+   MIT license.
+   
+   https://github.com/kohsuke/libpam4j
+
+---------------------------------------------------------------------------
+commons-codec
+---------------------------------------------------------------------------
+   commons-codec, release under the
+   Apache License 2.0.
+   
+   http://commons.apache.org/proper/commons-codec
+
+---------------------------------------------------------------------------
+pegdown
+---------------------------------------------------------------------------
+   pegdown, release under the
+   Apache License 2.0.
+   
+   https://github.com/sirthias/pegdown
+
+---------------------------------------------------------------------------
+font-awesome
+---------------------------------------------------------------------------
+   font-awesome, release under the
+   SIL OFL 1.1.
+   
+   https://github.com/FortAwesome/Font-Awesome
+
+---------------------------------------------------------------------------
+AUI (excerpts)
+---------------------------------------------------------------------------
+   AUI, release under the
+   Apache License 2.0
+   
+   https://bitbucket.org/atlassian/aui
+
+---------------------------------------------------------------------------
+Jedis
+---------------------------------------------------------------------------
+   Jedis, release under the
+   MIT license
+   
+   https://github.com/xetorthio/jedis
+
+---------------------------------------------------------------------------
+args4j
+---------------------------------------------------------------------------
+   args4j, release under the
+   Apache License 2.0
+   
+   http://args4j.kohsuke.org
+
+---------------------------------------------------------------------------
+jQuery
+---------------------------------------------------------------------------
+   jQuery, release under the
+   MIT License
+   
+   https://jquery.org
+
+---------------------------------------------------------------------------
+flotr2
+---------------------------------------------------------------------------
+   flotr2, release under the
+   BSD License
+   
+   http://humblesoftware.com/flotr2
+
+---------------------------------------------------------------------------
+Mina SSHD
+---------------------------------------------------------------------------
+   Mina SSHD, release under the 
+   Apache License 2.0
+
+   https://mina.apache.org
+
+---------------------------------------------------------------------------
+pf4j
+---------------------------------------------------------------------------
+   pf4j, release under the 
+   Apache License 2.0
+
+   https://github.com/decebals/pf4j

diff --git a/releases.moxie b/releases.moxie
index 7f9106186ae10b2eb91035ffc8acada3c6449670..0f37bf2b03c172505128fcf246764aaf15bcb27c 100644 (file)
--- a/releases.moxie
+++ b/releases.moxie
@@ -30,6 +30,8 @@ r22: {
     dependencyChanges:
     - args4j 2.0.26
     - JGit 3.3.1
+    - Mina SSHD 0.10.1
+    - pf4j 0.6
     contributors:
     - James Moger
     - David Ostrovsky

diff --git a/src/site/design.mkd b/src/site/design.mkd
index 6d4b29cacde35e6a64610d354b212eaf3e674a32..cd4b1b712cb675debac54bcd0ab7a62afb8b9db7 100644 (file)
--- a/src/site/design.mkd
+++ b/src/site/design.mkd
@@ -55,6 +55,8 @@ The following dependencies are automatically downloaded by Gitblit GO (or alread
 - [commons-codec](http://commons.apache.org/proper/commons-codec) (Apache 2.0)\r
 - [pegdown](https://github.com/sirthias/pegdown) (Apache 2.0)\r
 - [jedis](https://github.com/xetorthio/jedis) (MIT)\r
+- [Mina SSHD](https://mina.apache.org) (Apache 2.0)\r
+- [pf4j](https://github.com/decebals/pf4j) (Apache 2.0)\r
 \r
 ### Other Build Dependencies\r
 - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed)\r

diff --git a/src/site/faq.mkd b/src/site/faq.mkd
index a631797a424c75a41567db392ca04c3fc9379a0a..1b522f8259428f84600053ceb45632a0bf545cc0 100644 (file)
--- a/src/site/faq.mkd
+++ b/src/site/faq.mkd
@@ -111,7 +111,7 @@ Yes.  You can manually manipulate all of them and (most) changes will be immedia
 Care must be taken to preserve the relationship between user roles and repository names.<br/>Please see the *User Roles* section of the [setup](/setup.html) page for details.\r
 \r
 ### Can I restrict access to branches or paths within a repository?\r
-No, not out-of-the-box.  Access restrictions apply to the repository as a whole.\r
+No, not yet.  Access restrictions apply to the repository as a whole.\r
 \r
 Gitblit's simple authentication and authorization mechanism can be used to facilitate one or more of the [workflows outlined here](http://progit.org/book/ch5-1.html).\r
 \r
@@ -122,10 +122,6 @@ Alternatively, you could use [gitolite](https://github.com/sitaramc/gitolite) an
 ### Can I authenticate users against XYZ?\r
 Yes.  The user service is pluggable.  You may write your own complete user service by implementing the *com.gitblit.IUserService* interface.  Or you may subclass *com.gitblit.GitblitUserService* and override just the authentication. Set the fully qualified classname as the *realm.userService* property.\r
 \r
-### Why doesn't Gitblit support SSH?\r
-\r
-It will.  This feature is in development and should land in the 1.5.0 release.\r
-\r
 ### What types of Search does Gitblit support?\r
 \r
 As of 0.9.0, Gitblit supports Lucene-based searching.\r

diff --git a/src/site/features.mkd b/src/site/features.mkd
index 2d3daa56ed81eaca6898d23110cba7a2cb00be60..6d933cc1ec50095e9cb129680bcd2e7973fe2e05 100644 (file)
--- a/src/site/features.mkd
+++ b/src/site/features.mkd
@@ -1,6 +1,7 @@
 ## Standard Features (GO/WAR)\r
-- JGit http/https SmartHTTP servlet\r
-- JGit git protocol daemon\r
+- Integrated JGit http/https SmartHTTP servlet\r
+- Integrated JGit git protocol daemon\r
+- Integrated Mina SSHD daemon\r
 - Optional feature to allow users to create personal repositories\r
 - Optional feature to fork a repository to a personal repository\r
 - Optional feature to create a repository on push\r
@@ -77,7 +78,6 @@
 - Built-in AJP connector for Apache httpd\r
 \r
 ## Limitations\r
-- HTTP/HTTPS/GIT are the only supported Git protocols (SSH is in progress, ticket-6)\r
 - Built-in access controls are not branch-based, they are repository-based.\r
 \r
 [jgit]: http://eclipse.org/jgit "Eclipse JGit Site"\r