add rss button
[ikiwiki.git] / doc / setup.mdwn
1 So you want to set up your own wiki using ikiwiki? This turorial will walk
2 you through setting up a wiki that is stored in [[Subversion]] and that has
3 optional support for commits from the web.
4
5 1. [[Install]] ikiwiki.
6
7                 apt-get install ikiwiki # soon
8
9    Ikiwiki requires [[MarkDown]] be installed, and also uses the following
10    perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
11    `Mail::SendMail` `Time::Duration`
12
13 2. Create the subversion repository for your wiki.
14
15                 svnadmin create /svn/wikirepo
16                 svn mkdir file:///svn/wikirepo/trunk -m create
17
18 3. Check out the repository to make the working copy that ikiwiki will use.
19
20                 svn co file:///svn/wikirepo/trunk ~/wikiwc
21
22 4. Create some files and add them into subversion. Or you might copy the
23    files from /usr/share/ikiwiki/basewiki and check those in to get a
24    head start on creating your wiki.
25
26                 echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
27                 echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
28                 svn add ~/wikiwc/*.mdwn
29                 svn commit ~/wikiwc -m add
30
31 5. Build your wiki for the first time.
32
33                 ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
34                         --url=http://host/~you/wiki/
35
36    Replace the url with the real url to your wiki. You should now
37    be able to visit the url and see your page that you created earlier.
38
39 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
40    the wiki. You can play around with other ikiwiki parameters such as
41    `--wikiname` and `--rebuild` too. Get comfortable with its command line
42    (see [[usage]]).
43
44 7. By now you should be getting tired of typing in all the command line
45    options each time you change something in your wiki's setup. And it's
46    also getting old to have to manualy rebuild the wiki each time you
47    change a file. Time to introduce setup files. 
48    
49    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
50    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
51    
52    Most of the options, like `wikiname` in the setup file are the same as
53    ikiwiki's command line options (documented in [[usage]]. `srcdir`
54    and `destdir` are the two directories you specify when
55    running ikiwiki by hand. `svnrepo` is the path to your subversion 
56    repository. Make sure that all of these are pointing to the right
57    directories, and read through and configure the rest of the file to your
58    liking.
59
60    Note that the default file has a block to configure a svn wrapper. This
61    sets up a [[post-commit]] hook to update the wiki.
62
63    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
64    will set everything up and update your wiki.
65
66 8. Set up [[CGI]] to allow editing the wiki from the web.
67
68    Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
69    sure the filename for the cgi wrapper is ok, run 
70    `ikiwiki --setup ikiwiki.setup`, and you're done!
71
72 9. Add [[PageHistory]] links to the top of pages. This requires you to have
73    setup [[ViewCVS]] or something similar to access your [[Subversion]]
74    repository.  The `historyurl` setting makes ikiwiki add the links, and 
75    in that url, "\[[file]]" is replaced with the name of the file to view. So
76    edit ikiwiki.setup and set `historyurl` to something like this:
77
78         `http://svn.host/trunk/\[[file]]?root=wiki`
79    
80    Then run `ikiwiki --setup ikiwiki.setup` again.
81
82 10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]