X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/6c33adac83ead56198010340b12e5027950601f6..52f12d39c53a65a092b45cae527160f2145ada66:/doc/setup.mdwn?ds=sidebyside

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 860afd6f5..2c3a979ed 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,11 +1,13 @@
 This tutorial will walk you through setting up a wiki with ikiwiki.
 
-1. [[Install]] ikiwiki. See [[download]] for where to get it.
+1. [[Download]] and [[install]] ikiwiki.
 
 2. Decide where your wiki's files will go.
 
-   As a wiki compiler, ikiwiki builds a wiki from files in a source
-   directory, and outputs the files to a destination directory.
+   As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
+   and outputs the files to a destination directory.  If you keep your wiki in
+   a version control system, the source directory will contain a working copy
+   checked out from the version control system.
 
    For the purposes of this tutorial, we'll set shell variables
    for these locations, and use those variables in the commands that follow.
@@ -32,18 +34,18 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
 	   		All wikis are supposed to have a [[SandBox]],
 	   		so this one does too.
 	   		----
-	   		This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net).
+	   		This wiki is powered by [ikiwiki](http://ikiwiki.info).
    """]]
    
    See [[HelpOnFormatting]] for details about the markup language.
 
-   Note that several standard wiki pages will be added to your wiki, from
-   files in `/usr/share/ikiwiki/basewiki/`, so your wiki will automatically
-   get a [[SandBox]], and some other useful pages.
+   Note that several [[standard_wiki_pages|basewiki]] will be added to your
+   wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will
+   automatically get a [[SandBox]], and some other useful pages.
 
 4. Build your wiki for the first time.
 
-			ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/
+			ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now
    be able to visit the url and see your wiki.
@@ -64,7 +66,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    introduce setup files.
    
    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
-   `doc/ikiwiki.setup` in the ikiwiki sources), and edit it.
+   `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. Note that this
+   file should *not* be put in your wiki's directory with the rest of the
+   files. A good place to put it is in a ~/.ikiwiki/ subdirectory.
    
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
@@ -115,16 +119,41 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    
    [[toggle id=git text="Git"]]
    [[toggleable id=git text="""
-   			REPOSITORY=~/wikirepo
-   			mkdir $REPOSITORY
-   			cd $REPOSITORY
-   			git init-db
-   			cp -a $SRCDIR/* .
-   			git add .
-   			git commit -m "initial import" -a
-			mv $SRCDIR/.ikiwiki .
-   			rm -rf $SRCDIR
-   			git clone -l -s $REPOSITORY $SRCDIR
+	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
+	ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories)
+	to do the following, but this might be easiest:
+
+			REPOSITORY=~/wiki.git
+			cd $SRCDIR
+			git init
+			echo .ikiwiki > .gitignore
+			git add .
+			git commit -m'Initial commit'
+			# if you expect $REPOSITORY 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 $REPOSITORY
+			mv .ikiwiki ..
+			cd ..
+			rm -r $SRCDIR
+			git clone -l -s $REPOSITORY $SRCDIR
+			mv .ikiwiki $SRCDIR
+
+	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
+	`$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 `$REPOSITORY`.
    """]]
 
    [[toggle id=tla text="TLA"]]
@@ -150,6 +179,32 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
 			hg commit -m "initial import"
    """]]
 
+   [[toggle id=monotone text="Monotone"]]
+   [[toggleable id=monotone text="""
+			# These instructions are standard instructions to import a directory into monotone
+			# and set it up so that you don't need any passwords to use it
+			REPOSITORY=~/.ikiwiki/mtn.db
+			BRANCH=com.company.wikiname
+			# remember the password you use in the next step and
+			# substitute it for 'wikiKeyPass' in the get_passphrase() hook below
+			# note the you should never generate two monotone keys with the same name
+			mtn genkey web@machine.company.com
+			mtn db init --db=$REPOSITORY
+			mv $SRCDIR $SRCDIR-old
+			cd $SRCDIR-old
+			echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore
+			mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import"
+			cd ..
+			mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR
+			mv $SRCDIR-old/.ikiwiki $SRCDIR
+			cat << EOF > $SRCDIR/_MTN/monotonerc
+			function get_passphrase (branchname)
+			    return "wikiKeyPass"
+			end
+			EOF
+			rm -r $SRCDIR-old
+   """]]
+
 9. Configure ikiwiki to use revision control.
 
    Once your wiki is checked in to the revision control system,
@@ -158,12 +213,13 @@ 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. 
-   
+   appropriately (for Git, it should be `$REPO/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
    control system to commit them, and the wiki will automatically update.
    And in the web interface, RecentChanges should work, and files changed
    by web users will also be committed using revision control.
 
-10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]. And check out
+    [[tips]] to find out how to get more out of ikiwiki.