383cdca9d5cc93bfb0dc601728dc5f33dc74e35c
[ikiwiki.git] / doc / setup.mdwn
1 This tutorial will walk you through setting up a wiki with ikiwiki.
2
3 1. [[Install]] ikiwiki. See [[download]] for where to get it.
4
5 2. Decide where your wiki's files will go.
6
7    As a wiki compiler, ikiwiki builds a wiki from files in a source
8    directory, and outputs the files to a destination directory.
9
10    For the purposes of this tutorial, we'll set shell variables
11    for these locations, and use those variables in the commands that follow.
12
13                         SRCDIR=~/wikiwc
14                         DESTDIR=~/public_html/wiki/
15
16 3. Create the beginnings of your wiki.
17
18    This will create a simple main page for the wiki.
19
20                         mkdir $SRCDIR
21                         cd $SRCDIR
22                         $EDITOR index.mdwn
23
24    In the editor, you could start by entering a simple page like 
25    [[toggle id=page text="this one"]].
26    
27    [[toggleable id=page text="""
28                         Welcome to your new wiki.
29                         All wikis are supposed to have a [[SandBox]],
30                         so this one does too.
31                         ----
32                         This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net).
33    """]]
34    
35    See [[HelpOnFormatting]] for details about the markup language.
36
37    Note that several standard wiki pages will be added to your wiki, from
38    files in `/usr/share/ikiwiki/basewiki/`, so your wiki will automatically
39    get a [[SandBox]], and some other useful pages.
40
41 4. Build your wiki for the first time.
42
43                         ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/
44
45    Replace the url with the real url to your wiki. You should now
46    be able to visit the url and see your wiki.
47
48 5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding
49    the wiki. You can play around with other ikiwiki parameters such as
50    `--wikiname` and `--rebuild` too. Get comfortable with its command line
51    (see [[usage]]).
52
53 6. By now you should be getting tired of typing in all the command line
54    options each time you change something in your wiki's setup. Time to
55    introduce setup files.
56    
57    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
58    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it.
59    
60    Most of the options, like `wikiname` in the setup file are the same as
61    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
62    `destdir` are the two directories you specify when running ikiwiki by
63    hand. Make sure that these are pointing to the right directories, and
64    read through and configure the rest of the file to your liking.
65
66    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
67    will set everything up.
68
69 7. Turn on additional features.
70
71    Now you have a basic wiki with a configuration file. Time to experiment
72    with ikiwiki's many features. 
73    
74    Let's first enable a key wiki feature and set up [[CGI]] to allow
75    editing the wiki from the web. Just edit ikiwiki.setup, uncomment the
76    block for the cgi wrapper, make sure the filename for the cgi wrapper
77    is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
78
79    There are lots of other configuration options in ikiwiki.setup that you
80    can uncomment, configure, and enable by re-running
81    `ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
82    [[plugins]]..
83
84 8. Put your wiki in revision control.
85
86    At this point you might want to check your wiki in to a revision control
87    system you can get history of past changes and revert edits. Depending
88    on the revision control system you choose, the way this is done varies.
89    
90    There's little that's ikiwiki specific about these instructions; this is
91    just how you put a directory under revision control using the various
92    systems that ikiwiki supports.
93
94    [[toggle id=subversion text="Subversion"]]
95    [[toggleable id=subversion text="""
96                         REPOSITORY=~/wikirepo
97                         svnadmin create $REPOSITORY
98                         svn import $SRCDIR file://$REPOSITORY/trunk -m "initial import"
99                         rm -rf $SRCDIR
100                         svn co file://$REPOSITORY/trunk $SRCDIR
101    """]]
102    
103    [[toggle id=git text="Git"]]
104    [[toggleable id=git text="""
105                         REPOSITORY=~/wikirepo
106                         mkdir $REPOSITORY
107                         cd $REPOSITORY
108                         git init-db
109                         cp -a $SRCDIR/* .
110                         git add .
111                         git commit -m "initial import" -a
112                         rm -rf $SRCDIR
113                         git clone -l -s $REPOSITORY $SRCDIR
114    """]]
115
116    [[toggle id=tla text="TLA"]]
117    [[toggleable id=tla text="""
118                         REPOSITORY=~/wikirepo
119                         tla make-archive me@localhost--wiki $REPOSITORY
120                         tla my-id "<me@localhost>"
121                         cd $SRCDIR
122                         tla archive-setup me@localhost--wiki/wiki--0
123                         tla init-tree me@localhost--wiki/wiki--0
124                         # Edit {arch}/=tagging-method and change the precious
125                         # line to add the .ikiwiki directory to the regexp.
126                         tla add *
127                         tla import
128    """]]
129
130    [[toggle id=mercurial text="Mercurial"]]
131    [[toggleable id=mercurial text="""
132                         REPOSITORY=$SRCDIR
133                         hg init $REPOSITORY
134    """]]
135
136 9. Configure ikiwiki to use revision control.
137
138    Once your wiki is checked in to the revision control system,
139    you should configure ikiwiki to use revision control. Edit your
140    ikiwiki.setup, and uncomment the lines for the revision control system
141    you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using
142    subversion. Uncomment the block for the wrapper for your revision
143    control system, and configure the wrapper path in that block
144    appropriately. 
145    
146    Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more.
147    Now you should be able to edit files in $SRCDIR, and use your revision
148    control system to commit them, and the wiki will automatically update.
149    And in the web interface, RecentChanges should work, and files changed
150    by web users will also be committed using revision control.
151
152 10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].