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]], or
3 [[TLA]], and that has optional support for commits from the web.
5 1. [[Install]] ikiwiki. See [[download]] for where to get it.
7 2. Create the master rcs repository for your wiki.
10 svnadmin create /svn/wikirepo
11 svn mkdir file:///svn/wikirepo/trunk -m create
17 # Git requires something be in the repo to start with.
18 cp /usr/share/ikiwiki/basewiki/index.mdwn .
20 git commit -m create -a
24 tla make-archive me@localhost--wiki /tla/wikirepo
25 tla my-id "<me@localhost>"
27 3. Check out the repository to make the working copy that ikiwiki will use.
30 svn co file:///svn/wikirepo/trunk ~/wikiwc
33 git clone /git/wikirepo ~/wikiwc
38 tla archive-setup me@localhost--wiki/wiki--0
39 tla init-tree me@localhost--wiki/wiki--0
42 4. Build your wiki for the first time.
44 ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
45 --url=http://host/~you/wiki/
47 Replace the url with the real url to your wiki. You should now
48 be able to visit the url and see your wiki.
50 5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
51 used if you don't have a custom version, so let's start by making a
52 custom version of the wiki's index page:
55 cp /usr/share/ikiwiki/basewiki/index.mdwn .
60 svn commit -m customised index.mdwn
64 git commit -m customised index.mdwn
71 You can also add any files you like from scratch of course.
73 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
74 the wiki. You can play around with other ikiwiki parameters such as
75 `--wikiname` and `--rebuild` too. Get comfortable with its command line
78 7. By now you should be getting tired of typing in all the command line
79 options each time you change something in your wiki's setup. And it's
80 also getting old to have to manualy rebuild the wiki each time you
81 change a file. Time to introduce setup files.
83 A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
84 `doc/ikiwiki.setup` in the ikiwiki sources), and edit it.
86 Most of the options, like `wikiname` in the setup file are the same as
87 ikiwiki's command line options (documented in [[usage]]. `srcdir` and
88 `destdir` are the two directories you specify when running ikiwiki by
89 hand. `svnrepo` is the path to your subversion repository. Make sure
90 that all of these are pointing to the right directories, and read
91 through and configure the rest of the file to your liking.
93 If you want to use git, comment out the subversion stuff, uncomment and
96 Note that the default file has a block to configure an [[post-commit]]
97 wrapper to update the wiki. You need to uncomment the related block for
98 whatever rcs you use and comment out the other rcs blocks.
100 When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
101 will set everything up and update your wiki.
103 8. Set up [[CGI]] to allow editing the wiki from the web.
105 Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
106 sure the filename for the cgi wrapper is ok, run
107 `ikiwiki --setup ikiwiki.setup`, and you're done!
109 9. Add [[PageHistory]] links to the top of pages. This requires you to have
110 setup a repository browser. For Subversion, you may use [[ViewCVS]] or
111 something similar to access your [[Subversion]] repository. For Git,
112 [[Gitweb]] can be used.
114 The `historyurl` setting makes ikiwiki add the links, and in that url,
115 "\[[file]]" is replaced with the name of the file to view. So edit
116 ikiwiki.setup and ucomment the appropriate `historyurl` setting and edit
119 Then run `ikiwiki --setup ikiwiki.setup` again.
121 10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]