doc/setup.mdwn

   1 So you want to set up your own wiki using ikiwiki? This tutorial will walk
   2 you through setting up a wiki that is stored in [[Subversion]], [[Git]],
   3 [[TLA]] or [[Mercurial]], and that has optional support for commits from the web.
   4
   5 1. [[Install]] ikiwiki. See [[download]] for where to get it.
   6
   7 2. Create the master rcs repository for your wiki.
   8
   9                 # Subversion
  10                 svnadmin create /svn/wikirepo
  11                 svn mkdir file:///svn/wikirepo/trunk -m create
  12
  13                 # Git
  14                 mkdir /git/wikirepo
  15                 cd /git/wikirepo
  16                 git init-db
  17                 # Git requires something be in the repo to start with.
  18                 cp /usr/share/ikiwiki/basewiki/index.mdwn .
  19                 git add .
  20                 git commit -m create -a
  21
  22                 # TLA
  23                 mkdir /tla
  24                 tla make-archive me@localhost--wiki /tla/wikirepo
  25                 tla my-id "<me@localhost>"
  26                 # Edit {arch}/=tagging-method and change the precious
  27                 # line to add the .ikiwiki directory to the regexp.
  28
  29                 # Mercurial
  30                 hg init /hg/wikirepo
  31
  32 3. Check out the repository to make the working copy that ikiwiki will use.
  33
  34                 # Subversion
  35                 svn co file:///svn/wikirepo/trunk ~/wikiwc
  36
  37                 # Git
  38                 git clone /git/wikirepo ~/wikiwc
  39
  40                 # TLA
  41                 mkdir ~/wikiwc
  42                 cd ~/wikiwc
  43                 tla archive-setup me@localhost--wiki/wiki--0
  44                 tla init-tree me@localhost--wiki/wiki--0
  45                 tla import
  46
  47                 # Mercurial
  48                 # Mercurial uses a single repo approach, so no need to
  49                 # clone anything. Because the following examples
  50                 # refer to the ~/wikiwc working copy we symlink it:
  51                 ln -s /hg/wikirepo ~/wikiwc
  52
  53 4. Build your wiki for the first time.
  54
  55                 ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
  56                         --url=http://host/~you/wiki/
  57
  58    Replace the url with the real url to your wiki. You should now
  59    be able to visit the url and see your wiki.
  60
  61 5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
  62    used if you don't have a custom version, so let's start by making a
  63    custom version of the wiki's index page:
  64
  65                 cd ~/wikiwc
  66                 cp /usr/share/ikiwiki/basewiki/index.mdwn .
  67                 $EDITOR index.mdwn
  68
  69                 # Subversion
  70                 svn add index.mdwn
  71                 svn commit -m customised index.mdwn
  72
  73                 # Git
  74                 git add index.mdwn
  75                 git commit -m customised index.mdwn
  76                 git push origin
  77
  78                 # TLA
  79                 tla add index.mdwn
  80                 tla commit
  81
  82                 # Mercurial
  83                 hg add index.mdwn
  84                 hg commit -m customised index.mdwn
  85
  86    You can also add any files you like from scratch of course.
  87
  88 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
  89    the wiki. You can play around with other ikiwiki parameters such as
  90    `--wikiname` and `--rebuild` too. Get comfortable with its command line
  91    (see [[usage]]).
  92
  93 7. By now you should be getting tired of typing in all the command line
  94    options each time you change something in your wiki's setup. And it's
  95    also getting old to have to manualy rebuild the wiki each time you
  96    change a file. Time to introduce setup files.
  97
  98    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
  99    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it.
 100
 101    Most of the options, like `wikiname` in the setup file are the same as
 102    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
 103    `destdir` are the two directories you specify when running ikiwiki by
 104    hand. `svnrepo` is the path to your subversion repository.  Make sure
 105    that all of these are pointing to the right directories, and read
 106    through and configure the rest of the file to your liking.
 107
 108    If you want to use something other than subversion, comment out the
 109    subversion configuration, and uncomment and edit the configuration for
 110    your chosen RCS.
 111
 112    Note that the default file has a block to configure an [[post-commit]]
 113    wrapper to update the wiki. You need to uncomment the related block for
 114    whatever RCS you use and comment out the other rcs blocks.
 115
 116    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
 117    will set everything up and update your wiki.
 118
 119 8. Set up [[CGI]] to allow editing the wiki from the web.
 120
 121    Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
 122    sure the filename for the cgi wrapper is ok, run
 123    `ikiwiki --setup ikiwiki.setup`, and you're done!
 124
 125 9. Add [[PageHistory]] links to the top of pages. This requires you to have
 126    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
 127    something similar to access your [[Subversion]] repository.  For Git,
 128    [[Gitweb]] can be used, etc.
 129
 130    The `historyurl` setting makes ikiwiki add the links, and in that url,
 131    "\[[file]]" is replaced with the name of the file to view. So edit
 132    ikiwiki.setup and ucomment the appropriate `historyurl` setting and edit
 133    it for your setup.
 134
 135    Then run `ikiwiki --setup ikiwiki.setup` again.
 136
 137 10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]