83 lines
3.4 KiB
Markdown
83 lines
3.4 KiB
Markdown
So you want to set up your own wiki using ikiwiki? This turorial will walk
|
|
you through setting up a wiki that is stored in [[Subversion]] and that has
|
|
optional support for commits from the web.
|
|
|
|
1. [[Install]] ikiwiki.
|
|
|
|
apt-get install ikiwiki # soon
|
|
|
|
Ikiwiki requires [[MarkDown]] be installed, and also uses the following
|
|
perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
|
|
|
|
2. Create the subversion repository for your wiki.
|
|
|
|
svnadmin create /svn/wikirepo
|
|
svn mkdir file:///svn/wikirepo/trunk -m create
|
|
|
|
3. Check out the repository to make the working copy that ikiwiki will use.
|
|
|
|
svn co file:///svn/wikirepo/trunk ~/wikiwc
|
|
|
|
4. Create some files and add them into subversion. Or you might copy the
|
|
files from /usr/share/ikiwiki/basewiki and check those in to get a
|
|
head start on creating your wiki.
|
|
|
|
echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
|
|
echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
|
|
svn add ~/wikiwc/*.mdwn
|
|
svn commit ~/wikiwc -m add
|
|
|
|
5. Build your wiki for the first time.
|
|
|
|
ikiwiki --verbose ~/wikiwc/ \
|
|
/usr/share/ikiwiki/templates ~/public_html/wiki/ \
|
|
--url=http://host/~you/wiki/
|
|
|
|
Replace the url with the right url to your wiki. You should now
|
|
be able to visit the url and see your page that you created earlier.
|
|
|
|
6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
|
|
the wiki. You can play around with other ikiwiki parameters such as
|
|
`--wikiname` and `--rebuild` too. Get comfortable with its command line
|
|
(see [[usage]]).
|
|
|
|
7. By now you should be getting tired of typing in all the command line
|
|
options each time you change something in your wiki's setup. And it's
|
|
also getting old to have to manualy rebuild the wiki each time you
|
|
change a file. Time to introduce setup files.
|
|
|
|
A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
|
|
`doc/ikiwiki.setup` in the ikiwiki sources), and edit it.
|
|
|
|
Most of the options, like `wikiname` in the setup file are the same as
|
|
ikiwiki's command line options (documented in [[usage]]. `srcdir`,
|
|
`templatedir` and `destdir` are the three directories you specify when
|
|
running ikiwiki by hand. `svnrepo` is the path to your subversion
|
|
repository. Make sure that all of these are pointing to the right
|
|
directories, and read through and configure the rest of the file to your
|
|
liking.
|
|
|
|
Note that the default file has a block to configure a svn wrapper. This
|
|
sets up a [[post-commit]] hook to update the wiki.
|
|
|
|
When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
|
|
will set everything up and update your wiki.
|
|
|
|
8. Set up [[CGI]] to allow editing the wiki from the web.
|
|
|
|
Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
|
|
sure the filename for the cgi wrapper is ok, run
|
|
`ikiwiki --setup ikiwiki.setup`, and you're done!
|
|
|
|
9. Add [[PageHistory]] links to the top of pages. This requires you to have
|
|
setup [[ViewCVS]] or something similar to access your [[Subversion]]
|
|
repository. The `historyurl` setting makes ikiwiki add the links, and
|
|
in that url, "[[]]" is replaced with the name of the file to view. So
|
|
edit ikiwiki.setup and set `historyurl` to something like this:
|
|
|
|
`http://svn.host/trunk/[[]]?root=wiki`
|
|
|
|
Then run `ikiwiki --setup ikiwiki.setup` again.
|
|
|
|
10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
|