aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-08-21 03:10:35 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-08-21 03:10:35 +0000
commit50e1b43408e85fd2350b9df50e4ceb0c6a495a4f (patch)
treea68b4fce2b312f3e267c644e5ea061e12ecdad43 /doc
parent1082ade032f1eec471f31e68c1a68887c5e8b14a (diff)
downloadikiwiki-50e1b43408e85fd2350b9df50e4ceb0c6a495a4f.tar
ikiwiki-50e1b43408e85fd2350b9df50e4ceb0c6a495a4f.tar.gz
* Add monotone support, contributed by William Uther.
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki.setup14
-rw-r--r--doc/setup.mdwn26
2 files changed, 40 insertions, 0 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index a9a9b9f19..864dc928f 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -43,6 +43,20 @@ use IkiWiki::Setup::Standard {
#historyurl => "http://localhost:8000/", # hg serve'd local repository
#diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",
+ # Monotone stuff
+ #rcs => "monotone",
+ #mtnkey => "web\@machine.company.com",
+ # Monotone options
+ #mtnsync => 0, # set this if you want the wiki to sync on update and commit
+ #mtnrootdir => "path/to/root/of/workspace", # The path to your workspace (defaults to the srcdir itself)
+ # e.g. use if your srcdir is a subdirectory of the workspace
+ #mtnbinpath => "path/to/montone/binary", # by default we just use "mtn" and assume it is in your path.
+ #mtnmergerc => "path/to/mergerc", # this is a monotone lua hook file used by ikiwiki for
+ # inserting conflict markers. By default we use
+ # mtnrootdir/_MTN/mergerc. This hook will be populated with
+ # default code the first time you use ikiwiki. You can
+ # change it to alter how conflict markers are inserted.
+
wrappers => [
#{
# # The cgi wrapper.
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index abd6ac7ad..8e5653442 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -154,6 +154,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=montone 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,