]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/setup.mdwn
web commit by JamesWestby
[ikiwiki.git] / doc / setup.mdwn
index 68c7ee1df37ebce923cfd464d65828147c6a7a80..1669071d6c28c8a71a611245ab73d8c9f4b2e930 100644 (file)
@@ -1,6 +1,6 @@
 So you want to set up your own wiki using ikiwiki? This tutorial will walk
 So you want to set up your own wiki using ikiwiki? This tutorial will walk
-you through setting up a wiki that is stored in [[Subversion]] or [[Git]],
-and that has optional support for commits from the web.
+you through setting up a wiki that is stored in [[Subversion]], [[Git]],
+[[TLA]] or [[Mercurial]], and that has optional support for commits from the web.
 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 
 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 
@@ -9,19 +9,51 @@ and that has optional support for commits from the web.
                # Subversion
                svnadmin create /svn/wikirepo
                svn mkdir file:///svn/wikirepo/trunk -m create
                # Subversion
                svnadmin create /svn/wikirepo
                svn mkdir file:///svn/wikirepo/trunk -m create
-               
+                
                # Git
                mkdir /git/wikirepo
                cd /git/wikirepo
                git init-db
                # Git
                mkdir /git/wikirepo
                cd /git/wikirepo
                git init-db
+               # Git requires something be in the repo to start with.
+               cp /usr/share/ikiwiki/basewiki/index.mdwn .
+               git add .
+               git commit -m create -a
+               # No need to keep files in the master repository; so at this
+               # stage, you may want to remove all files (except .git) to
+               # save disk space.
+
+               # TLA
+               mkdir /tla
+               tla make-archive me@localhost--wiki /tla/wikirepo
+               tla my-id "<me@localhost>"
+
+               # Mercurial
+               hg init /hg/wikirepo
 
 3. Check out the repository to make the working copy that ikiwiki will use.
 
                # Subversion
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
 3. Check out the repository to make the working copy that ikiwiki will use.
 
                # Subversion
                svn co file:///svn/wikirepo/trunk ~/wikiwc
-               
+                
                # Git
                # Git
-               git clone /git/wikirepo ~/wikiwc
+               # Create a local clone to save disk space and also to
+               # optimize performance. See git-clone(1).
+               git clone -l -s /git/wikirepo ~/wikiwc
+
+               # TLA
+               mkdir ~/wikiwc
+               cd ~/wikiwc
+               tla archive-setup me@localhost--wiki/wiki--0
+               tla init-tree me@localhost--wiki/wiki--0
+               # Edit {arch}/=tagging-method and change the precious
+               # line to add the .ikiwiki directory to the regexp.
+               tla import
+
+               # Mercurial
+               # Mercurial uses a single repo approach, so no need to
+               # clone anything. Because the following examples
+               # refer to the ~/wikiwc working copy we symlink it:
+               ln -s /hg/wikirepo ~/wikiwc
 
 4. Build your wiki for the first time.
 
 
 4. Build your wiki for the first time.
 
@@ -38,16 +70,24 @@ and that has optional support for commits from the web.
                cd ~/wikiwc
                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                $EDITOR index.mdwn
                cd ~/wikiwc
                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                $EDITOR index.mdwn
-               
+                
                # Subversion
                svn add index.mdwn
                svn commit -m customised index.mdwn
                # Subversion
                svn add index.mdwn
                svn commit -m customised index.mdwn
-               
+                
                # Git
                git add index.mdwn
                git commit -m customised index.mdwn
                git push origin
 
                # Git
                git add index.mdwn
                git commit -m customised index.mdwn
                git push origin
 
+               # TLA
+               tla add index.mdwn
+               tla commit
+
+               # Mercurial
+               hg add index.mdwn
+               hg commit -m customised index.mdwn
+
    You can also add any files you like from scratch of course.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    You can also add any files you like from scratch of course.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
@@ -66,13 +106,17 @@ and that has optional support for commits from the web.
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
    `destdir` are the two directories you specify when running ikiwiki by
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
    `destdir` are the two directories you specify when running ikiwiki by
-   hand. `rcsrepo` is the path to your master rcs repository.  Make sure
+   hand. `svnrepo` is the path to your subversion repository.  Make sure
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 
-   Note that the default file has a block to configure an Rcs wrapper to
-   update the wiki.  You need to uncomment the related block for whatever
-   rcs you use and comment out the other rcs blocks.
+   If you want to use something other than subversion, comment out the
+   subversion configuration, and uncomment and edit the configuration for
+   your chosen RCS.
+
+   Note that the default file has a block to configure an [[post-commit]] 
+   wrapper to update the wiki. You need to uncomment the related block for
+   whatever RCS you use and comment out the other rcs blocks.
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.
@@ -86,18 +130,12 @@ and that has optional support for commits from the web.
 9. Add [[PageHistory]] links to the top of pages. This requires you to have
    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
    something similar to access your [[Subversion]] repository.  For Git,
 9. Add [[PageHistory]] links to the top of pages. This requires you to have
    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
    something similar to access your [[Subversion]] repository.  For Git,
-   [[Gitweb]] can be used.
+   [[Gitweb]] can be used, etc.
    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit
    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit
-   ikiwiki.setup and set `historyurl` to something like this for
-   Subversion:
-
-       `http://svn.host/trunk/\[[file]]?root=wiki`
-
-   Or this for Git:
-
-       `http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]`
+   ikiwiki.setup and ucomment the appropriate `historyurl` setting and edit
+   it for your setup.
    
    Then run `ikiwiki --setup ikiwiki.setup` again.
 
    
    Then run `ikiwiki --setup ikiwiki.setup` again.