- Adds a tag plugin that allows more easily tagging pages.
[ikiwiki.git] / 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]] or [[Git]],
3 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 3. Check out the repository to make the working copy that ikiwiki will use.
23
24                 # Subversion
25                 svn co file:///svn/wikirepo/trunk ~/wikiwc
26                  
27                 # Git
28                 git clone /git/wikirepo ~/wikiwc
29
30 4. Build your wiki for the first time.
31
32                 ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
33                         --url=http://host/~you/wiki/
34
35    Replace the url with the real url to your wiki. You should now
36    be able to visit the url and see your wiki.
37
38 5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
39    used if you don't have a custom version, so let's start by making a
40    custom version of the wiki's index page:
41
42                 cd ~/wikiwc
43                 cp /usr/share/ikiwiki/basewiki/index.mdwn .
44                 $EDITOR index.mdwn
45                  
46                 # Subversion
47                 svn add index.mdwn
48                 svn commit -m customised index.mdwn
49                  
50                 # Git
51                 git add index.mdwn
52                 git commit -m customised index.mdwn
53                 git push origin
54
55    You can also add any files you like from scratch of course.
56
57 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
58    the wiki. You can play around with other ikiwiki parameters such as
59    `--wikiname` and `--rebuild` too. Get comfortable with its command line
60    (see [[usage]]).
61
62 7. By now you should be getting tired of typing in all the command line
63    options each time you change something in your wiki's setup. And it's
64    also getting old to have to manualy rebuild the wiki each time you
65    change a file. Time to introduce setup files. 
66    
67    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
68    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
69    
70    Most of the options, like `wikiname` in the setup file are the same as
71    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
72    `destdir` are the two directories you specify when running ikiwiki by
73    hand. `svnrepo` is the path to your subversion repository.  Make sure
74    that all of these are pointing to the right directories, and read
75    through and configure the rest of the file to your liking.
76
77    If you want to use git, comment out the subversion stuff, uncomment and
78    edit the git stuff.
79
80    Note that the default file has a block to configure an [[post-commit]] 
81    wrapper to update the wiki. You need to uncomment the related block for
82    whatever rcs you use and comment out the other rcs blocks.
83
84    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
85    will set everything up and update your wiki.
86
87 8. Set up [[CGI]] to allow editing the wiki from the web.
88
89    Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
90    sure the filename for the cgi wrapper is ok, run 
91    `ikiwiki --setup ikiwiki.setup`, and you're done!
92
93 9. Add [[PageHistory]] links to the top of pages. This requires you to have
94    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
95    something similar to access your [[Subversion]] repository.  For Git,
96    [[Gitweb]] can be used.
97    
98    The `historyurl` setting makes ikiwiki add the links, and in that url,
99    "\[[file]]" is replaced with the name of the file to view. So edit
100    ikiwiki.setup and ucomment the appropriate `historyurl` setting and edit
101    it for your setup.
102    
103    Then run `ikiwiki --setup ikiwiki.setup` again.
104
105 10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]