Skip to content

Commit

Permalink
move warnings up, add warning about clobbering update hook and such
Browse files Browse the repository at this point in the history
  • Loading branch information
sitaramc committed Jul 31, 2013
1 parent 582ab63 commit 5623ead
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 17 deletions.
43 changes: 30 additions & 13 deletions WARNINGS.mkd
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# WARNINGS

Gitolite does NOT like it if you fiddle with files, directories, permissions,
etc., on the server except as directed in the documentation. Gitolite also
expects all the directories and files it manages/uses to be owned by the
[hosting user][nnc] and not have strange permissions and ownerships.

Very few people have fallen foul of this, but the ones who *did* became very
obnoxious about it, hence this warning.

Gitolite depends on several system-installed packages: openssh, git, perl, sh
being the main ones. They should all be configured sensibly and with most of
the normal defaults. (For example, if your sshd config says the authorized
keys file should be placed in some directory other than the default, expect
trouble).
**Please take note of the following points**:

* If you're bringing existing repos into gitolite, please see
[this][existing] first.

* Gitolite expects all the directories and files it manages/uses to be owned
by the [hosting user][nnc] and not have strange permissions and
ownerships.

* Gitolite does NOT like it if you fiddle with files and directories it
cares about in any way except as directed in the documentation.

Gitolite cares about the following directories

~/.gitolite.rc
~/.gitolite
~/repositories/gitolite-admin.git

Also, in each repo, gitolite cares about

gl-*
hooks/update

* Gitolite depends on several system-installed packages: openssh, git, perl,
sh being the main ones. They should all be configured sensibly and with
most of the normal defaults. (For example, if your sshd config says the
authorized keys file should be placed in some directory other than the
default, expect trouble).

...ok that's the serious stuff done...

----

Expand Down
3 changes: 1 addition & 2 deletions install.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ Notes:
be any user, even your own normal one. (If you're using an RPM/DEB the
install probably created one called "gitolite").

Also see the [WARNINGS][] page for more on what gitolite expects on the server
side.
Also see the [WARNINGS][] page for important information of general use.

### client

Expand Down
4 changes: 2 additions & 2 deletions master-toc.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ documentation: [basic][] and [advanced][].
* [contact][] info, mailing list, IRC channel
* [license][] info

## [WARNINGS][]

## help for [emergencies][]

* **install/setup issues caused by [ssh][]**
Expand All @@ -32,8 +34,6 @@ documentation: [basic][] and [advanced][].
* [non-standard configs][nonstd] that'll trip you up
* things that are [not gitolite problems][ngp]

## [WARNINGS][]


## [testing][] gitolite
* [trying][] out gitolite
Expand Down
2 changes: 2 additions & 0 deletions qi.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## ASSUMPTIONS

* You've read the [WARNINGS][] page ;-)

* This is an ssh-based setup. For smart http setup click [here][http].

* This is a fresh install, not a migration from the old gitolite (v1.x,
Expand Down
9 changes: 9 additions & 0 deletions rare.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

## #existing moving existing repos into gitolite

> **WARNING**: gitolite **will clobber** any existing `update` hook in your
> repos when you do this. Please see either the [cookbook][] or the
> [customisation][cust] document for information on how to make your
> existing update hook work with gitolite.
> Gitolite *may clobber* any existing "git-daemon-export-ok" file in your
> repo; see the page on [interfacing with external tools][external] for how
> to enable that via gitolite.
On the server:

* Move the repos to `$HOME/repositories`.
Expand Down

0 comments on commit 5623ead

Please sign in to comment.