bc93da7b39d52e525f7488b548d98b4423f6b220
[ikiwiki.git] / doc / setup.mdwn
1 This tutorial will walk you through setting up a wiki with ikiwiki.
2
3 [[!toc ]]
4
5 ## [[Download]] and [[install]] ikiwiki.
6
7 If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
8 If you're not, see the [[download]] and [[install]] pages.
9
10 ## Quick start
11
12 If you'd like to set up a wiki now, and learn more later, just run this command
13 and answer a couple of questions.
14
15         % ikiwiki -setup /etc/ikiwiki/simple.setup
16         What will the wiki be named? mywiki
17         What revision control system to use? git
18
19 Wait for it to tell you an url for your new wiki.. Done!
20
21 (If the CGI doesn't seem to let you edit pages, you might need to
22 [[configure_apache|apache_cgi]]).)
23
24 ## Decide where your wiki's files will go.
25
26 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
27 and outputs the files to a destination directory.  If you keep your wiki in
28 a version control system, the source directory will contain a working copy
29 checked out from the version control system.
30
31 For the purposes of this tutorial, we'll set shell variables
32 for these locations, and use those variables in the commands that follow.
33
34         SRCDIR=~/wikiwc
35         DESTDIR=~/public_html/wiki/
36
37 Note that ikiwiki owns the working copy directory; do not perform your own
38 edits in ikiwiki's working copy.
39
40 ## Create the beginnings of your wiki.
41
42 This will create a simple main page for the wiki.
43
44         mkdir $SRCDIR
45         cd $SRCDIR
46         $EDITOR index.mdwn
47
48 In the editor, you could start by entering a simple page like
49 [[!toggle id=page text="this one"]].
50 [[!toggleable id=page text="""
51         Welcome to your new wiki.
52
53         All wikis are supposed to have a \[[SandBox]],
54         so this one does too.
55
56         ----
57
58         This wiki is powered by [ikiwiki](http://ikiwiki.info).
59 """]]
60    
61 See [[ikiwiki/formatting]] for details about the markup language.
62
63 Note that several [[standard_wiki_pages|basewiki]] will be added to your
64 wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will
65 automatically get a [[SandBox]], and some other useful pages.
66
67 ## Build your wiki for the first time.
68
69         ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
70
71 Replace the url with the real url to your wiki. You should now
72 be able to visit the url and see your wiki.
73
74 ## Add content to your wiki.
75
76 Continue editing or adding pages and rebuilding the wiki.
77    
78 To quickly get started on a common task like blogging with ikiwiki, you
79 can copy in files from the [[examples]]. The examples are located in
80 `doc/examples/` in the ikiwiki source package.
81
82 You can experiment with other ikiwiki parameters such as `--wikiname`
83 and `--rebuild` too. Get comfortable with its command line (see
84 [[usage]]).
85
86 ## Add a setup file.
87
88 By now you should be getting tired of typing in all the command line
89 options each time you change something in your wiki's setup. Time to
90 introduce setup files.
91
92 To generate a setup file, use `ikiwiki --dumpsetup`. You can pass
93 all the options have you been including at the command line, and they
94 will be stored in the setup file.
95
96         ikiwiki $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ --dumpsetup ikiwiki.setup
97
98 Note that this file should *not* be put in your wiki's directory with
99 the rest of the files. A good place to put it is in a ~/.ikiwiki/
100 subdirectory.
101    
102 Most of the options, like `wikiname` in the setup file are the same as
103 ikiwiki's command line options (documented in [[usage]]. `srcdir` and
104 `destdir` are the two directories you specify when running ikiwiki by
105 hand. Make sure that these are pointing to the right directories, and
106 read through and configure the rest of the file to your liking.
107
108 When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
109 will set everything up.
110
111 ## Turn on additional features.
112
113 Now you have a basic wiki with a setup file. Time to experiment
114 with ikiwiki's many features. 
115    
116 Let's first enable a key wiki feature and set up [[CGI]] to allow
117 editing the wiki from the web. Just edit ikiwiki.setup, uncomment the
118 settings for the `cgi_wrapper`, make sure the filename for the cgi wrapper
119 is ok, run `ikiwiki --setup ikiwiki.setup`, and you're done!
120
121 There are lots of other configuration options in ikiwiki.setup that you
122 can uncomment, configure, and enable by re-running
123 `ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
124 [[plugins]]..
125
126 ## Put your wiki in revision control.
127
128 At this point you might want to check your wiki in to a revision control
129 system so you can keep track of changes and revert edits. Depending
130 on the revision control system you choose, the way this is done varies.
131
132 Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and
133 should be preserved, but not checked into revision control.
134
135 The [[ikiwiki-makerepo]] command automates setting up a wiki in
136 revision control.
137
138 [[!toggle id=subversion text="Subversion"]]
139 [[!toggleable id=subversion text="""
140         REPOSITORY=~/wikirepo
141         ikiwiki-makerepo svn $SRCDIR $REPOSITORY
142 """]]
143
144 [[!toggle id=git text="Git"]]
145 [[!toggleable id=git text="""
146         REPOSITORY=~/wiki.git
147         ikiwiki-makerepo git $SRCDIR $REPOSITORY
148
149 Please see [[rcs/git]] for detailed documentation about how
150 ikiwiki uses git repositories, and some important caveats
151 about using the git repositories.
152 """]]
153
154 [[!toggle id=mercurial text="Mercurial"]]
155 [[!toggleable id=mercurial text="""
156         REPOSITORY=$SRCDIR
157         ikiwiki-makerepo mercurial $SRCDIR
158 """]]
159
160 [[!toggle id=bazaar text="Bazaar"]]
161 [[!toggleable id=bazaar text="""
162         REPOSITORY=$SRCDIR
163         ikiwiki-makerepo bzr $SRCDIR
164 """]]
165
166 [[!toggle id=tla text="TLA"]]
167 [[!toggleable id=tla text="""
168         REPOSITORY=~/wikirepo
169         tla make-archive me@localhost--wiki $REPOSITORY
170         tla my-id "<me@localhost>"
171         cd $SRCDIR
172         tla archive-setup me@localhost--wiki/wiki--0
173         tla init-tree me@localhost--wiki/wiki--0
174         # Edit {arch}/=tagging-method and change the precious
175         # line to add the .ikiwiki directory to the regexp.
176         tla add *
177         tla import
178 """]]
179
180 [[!toggle id=monotone text="Monotone"]]
181 [[!toggleable id=monotone text="""
182         # These instructions are standard instructions to import a directory into monotone
183         # and set it up so that you don't need any passwords to use it
184         REPOSITORY=~/.ikiwiki/mtn.db
185         BRANCH=com.company.wikiname
186         # remember the password you use in the next step and
187         # substitute it for 'wikiKeyPass' in the get_passphrase() hook below
188         # note the you should never generate two monotone keys with the same name
189         mtn genkey web@example.com
190         mtn db init --db=$REPOSITORY
191         mv $SRCDIR $SRCDIR-old
192         cd $SRCDIR-old
193         echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore
194         mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import"
195         cd ..
196         mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR
197         mv $SRCDIR-old/.ikiwiki $SRCDIR
198         cat << EOF > $SRCDIR/_MTN/monotonerc
199         function get_passphrase (branchname)
200             return "wikiKeyPass"
201         end
202         EOF
203         rm -r $SRCDIR-old
204 """]]
205
206 ## Configure ikiwiki to use revision control.
207
208 Once your wiki is checked in to the revision control system,
209 you should configure ikiwiki to use revision control. Edit your
210 ikiwiki.setup, set `rcs` to the the revision control system
211 you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using
212 subversion. Uncomment the configuration for the wrapper for your revision
213 control system, and configure the wrapper path appropriately
214 (for Git, it should be `$REPOSITORY/hooks/post-update`).
215
216 Once it's all set up, run `ikiwiki --setup ikiwiki.setup` once more.
217 Now you should be able to edit files in $SRCDIR, and use your revision
218 control system to commit them, and the wiki will automatically update.
219 And in the web interface, RecentChanges should work, and files changed
220 by web users will also be committed using revision control.
221
222 ## Enjoy your new wiki!
223
224 Add yourself to [[IkiWikiUsers]]. And check out
225 the [[tips]] to find out how to get more out of ikiwiki.