X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/79d2526687e63fa4a15024d443def2e0866b7240..d7cf9b6fd98aa0f202ec1f4ac9a8137dbd0a1c47:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index d908e2177..f5dd8832e 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -121,39 +121,35 @@ This tutorial will walk you through setting up a wiki with ikiwiki. [[toggleable id=git text=""" When using Git, you probably want to set up two repositories, of which one should be bare (meaning that it does not have a working tree - checked out). We call the bare repository the "repo" and the other the - "srcdir". There are [other + checked out). We call the bare repository the "repository" and the + other will be the "srcdir" (which `ikiwiki` uses to compile the wiki). + There are [other ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories) to do the following, but this might be easiest: - REPO=~/wiki.git + REPOSITORY=~/wiki.git + GIT_DIR=$REPOSITORY git --bare init --shared cd $SRCDIR git init - echo .ikiwiki > .gitignore + echo /.ikiwiki > .gitignore git add . - git commit -m'Initial commit' - # if you expect $REPO to receive pushs from multiple - # clones, then it is advisable to stop git performing - # fast forwards -- this is to avoid overwriting the - # remote ref and losing commits from there. - git config receive.denyNonFastForwards true - git config core.bare true - mv .git $REPO - mv .ikiwiki .. - cd .. - rm -r $SRCDIR - git clone -l -s $REPO $SRCDIR - mv .ikiwiki $SRCDIR + git commit -m "initial commit" + git remote add origin $REPOSITORY + git config branch.master.merge refs/heads/master + git push --all It is **paramount** that you **never** push to the Git repository in `$SRCDIR` ([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)). Instead, if you want to work on the wiki from a remote machine, clone - `$REPO`, using either the `git` transport (if available), or + `$REPOSITORY`, using either the `git` transport (if available), or `ssh`. If at any point you commit changes in `$SRCDIR`, make sure to `git - push` them to the `$REPO`. + push` them to the `$REPOSITORY`. ikiwiki will do this automatically + for any changes made via the web. + + Finally, see [[Git_pitfalls]] if you experience problems. """]] [[toggle id=tla text="TLA"]] @@ -213,7 +209,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki. you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using subversion. Uncomment the block for the wrapper for your revision control system, and configure the wrapper path in that block - appropriately (for Git, it should be `$REPO/hooks/post-update`). + appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`). Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more. Now you should be able to edit files in $SRCDIR, and use your revision