From 8ec06317276abd624630c37675d8d563a1fcb754 Mon Sep 17 00:00:00 2001 From: James Moger Date: Thu, 27 Mar 2014 21:38:57 -0400 Subject: [PATCH] Documentation --- NOTICE | 705 +++++++++++++++++++++--------------------- releases.moxie | 2 + src/site/design.mkd | 2 + src/site/faq.mkd | 6 +- src/site/features.mkd | 6 +- 5 files changed, 368 insertions(+), 353 deletions(-) diff --git a/NOTICE b/NOTICE index 27c01e0e..da61b201 100644 --- a/NOTICE +++ b/NOTICE @@ -1,345 +1,360 @@ -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 - \ 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 7f910618..0f37bf2b 100644 --- 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 6d4b29ca..cd4b1b71 100644 --- 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) - [pegdown](https://github.com/sirthias/pegdown) (Apache 2.0) - [jedis](https://github.com/xetorthio/jedis) (MIT) +- [Mina SSHD](https://mina.apache.org) (Apache 2.0) +- [pf4j](https://github.com/decebals/pf4j) (Apache 2.0) ### Other Build Dependencies - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed) diff --git a/src/site/faq.mkd b/src/site/faq.mkd index a631797a..1b522f82 100644 --- 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.
Please see the *User Roles* section of the [setup](/setup.html) page for details. ### Can I restrict access to branches or paths within a repository? -No, not out-of-the-box. Access restrictions apply to the repository as a whole. +No, not yet. Access restrictions apply to the repository as a whole. 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). @@ -122,10 +122,6 @@ Alternatively, you could use [gitolite](https://github.com/sitaramc/gitolite) an ### Can I authenticate users against XYZ? 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. -### Why doesn't Gitblit support SSH? - -It will. This feature is in development and should land in the 1.5.0 release. - ### What types of Search does Gitblit support? As of 0.9.0, Gitblit supports Lucene-based searching. diff --git a/src/site/features.mkd b/src/site/features.mkd index 2d3daa56..6d933cc1 100644 --- a/src/site/features.mkd +++ b/src/site/features.mkd @@ -1,6 +1,7 @@ ## Standard Features (GO/WAR) -- JGit http/https SmartHTTP servlet -- JGit git protocol daemon +- Integrated JGit http/https SmartHTTP servlet +- Integrated JGit git protocol daemon +- Integrated Mina SSHD daemon - Optional feature to allow users to create personal repositories - Optional feature to fork a repository to a personal repository - Optional feature to create a repository on push @@ -77,7 +78,6 @@ - Built-in AJP connector for Apache httpd ## Limitations -- HTTP/HTTPS/GIT are the only supported Git protocols (SSH is in progress, ticket-6) - Built-in access controls are not branch-based, they are repository-based. [jgit]: http://eclipse.org/jgit "Eclipse JGit Site" -- 2.39.5