docs/index.mkd

   1 # Hosting Git Repositories
   2
   3 ----
   4
   5 Gitolite allows you to setup git hosting on a central server, with
   6 fine-grained access control and many more powerful features.
   7
   8 # install/setup
   9
  10 <span class="box-r">If you're installing via your package manager, make sure
  11 you get the right one; it's often called `gitolite3`.</span>
  12
  13 Source code is at <https://github.com/sitaramc/gitolite>.
  14
  15 If your Unix-fu and ssh-fu are good, take a look at the [quick install](quick_install)
  16 page.  Otherwise follow the documentation flow, skipping whatever you think
  17 you don't need.
  18
  19 # documentation
  20
  21 <span class="green box-r" style="padding: 10px"> **(April 2014): There's a
  22 [book on gitolite][book] out**.  I've received some emails over the years
  23 asking where to donate for gitolite to show your appreciation, and I've always
  24 refused politely.  Well, if you insist... buy the book :-) </span>
  25
  26 In general, the sections (see links in the navigation bar at the top) should
  27 be fairly self-explanatory, and reading through the documentation as it flows
  28 (i.e., using the "Next" link at the top right of each page) should work fine.
  29 There are some forward references here and there, but you can ignore those
  30 links on a first pass.
  31
  32 !!! danger "In addition:"
  33
  34     There's a **[fool proof setup](fool_proof_setup)** guide with detailed help showing one
  35     fool-proof way to install, as long as you follow instructions faithfully!
  36
  37     Once you've installed and setup, there's the **[cookbook](cookbook)** with recipes
  38     for common tasks.
  39
  40 # TROUBLESHOOTING
  41
  42 The [emergencies](emergencies) page helps with all sorts of install/setup issues,
  43 recovering from lost keys and other self-inflicted wounds, lists some common
  44 (and some uncommon!) errors and non-standard configs that may trip you up.
  45
  46 # contact/support
  47
  48 ## security issues
  49
  50 <span class="red">If you think you found a possible **security issue**, please email me
  51 (<sitaramc@gmail.com>) directly.</span>
  52
  53 ## mailing list(s)
  54
  55 For all other communications, please use the mailing list.  This has some
  56 advantages over sending direct to me (if I'm not available, someone else might
  57 respond; someone else may have additional info that I may not have thought of,
  58 or experiences to share; the issue becomes searchable for future reference;
  59 and finally, it keeps me honest!)
  60
  61 **NOTE**: The first email from a new member is held until I can clear it;
  62 subsequent emails from the same email address do not get held up.
  63
  64 Mailing list for support and general discussion:
  65
  66 *   Subscribe: <gitolite+subscribe@googlegroups.com>
  67 *   Post: <gitolite@googlegroups.com>
  68
  69 (If you're unwilling to join the mailing list, you can still send me direct
  70 mail if it's something simple, obvious, or quick.  But if the issue needs
  71 multiple mails and/or some discussion, I prefer the mailing list.)
  72
  73 There's also a low traffic, one-way, mailing list for release and security
  74 announcements:
  75
  76 *   Subscribe: <gitolite-announce+subscribe@googlegroups.com>
  77
  78 If you wish to send me code, please see the file called CONTRIBUTING in the
  79 source distribution.
  80
  81 ## IRC
  82
  83 Our IRC channel is `#gitolite` on libera.chat.  I live in India (UTC+0530 time
  84 zone), but there are a few regulars (*thanks, guys, you know who you are!*)
  85 from other times zones.  That said, it's not heavy traffic and you may have to
  86 wait a while for an answer, depending on the time of day and day of week.
  87
  88 There are also many gitolite-knowledgeable people on the git channel `#git`.
  89
  90 # license
  91
  92 The gitolite software is copyright Sitaram Chamarty and is licensed under the
  93 GPL v2; please see the file called COPYING in the source distribution.
  94
  95 This **documentation**, which is maintained separately from the main gitolite
  96 source code, is copyright Sitaram Chamarty and is provided under a [Creative
  97 Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
  98 License](https://creativecommons.org/licenses/by-nc-sa/3.0/).
  99
 100 However, certain parts are contributed by others who may have chosen other
 101 licenses; their names and license will be mentioned in the respective files.
 102
 103 Documentation for a software product will naturally contain code examples.  I
 104 believe that the principle of fair use should cover use of those snippets; see
 105 especially factors 3 and 4 in the list of factors
 106 [here](https://en.wikipedia.org/wiki/Fair_use#Fair_use_under_United_States_law).
 107
 108 If you're not convinced that it would be fair use, then you may consider those
 109 code snippets, as well as associated "comments" if any, to be under the GPLv2
 110 license.  Licensing is about intent, and the intent of these examples is that
 111 you use them wherever and however you can use gitolite itself.
 112
 113 !!! note "Note:"
 114
 115     GIT is a trademark of Software Freedom Conservancy and my use of
 116     "Gitolite" is under license.
 117
 118 [basic]: basic.html
 119 [advanced]: advanced.html
 120 [book]: https://www.packtpub.com/gitolite-essentials/book
 121