FAST START

Basically just do these commands:

> svn checkout http://svn.kwiki.org/kwiki/trunk /usr/local/kwiki
> export PATH=/usr/local/kwiki/bin:$PATH
> kwiki -new /path/to/cgi/kwiki-01

If you want to use the builtin web server (see note below):

> kwiki -start 8080

Point your browser at the new Kwiki:

> open http://localhost:8080/index.cgi

Bug

If you get the following error when trying to add a plugin,

> kwiki -add Kwiki::CoolURI
Can't locate object method "plugins_file" via package
"Kwiki::Config" at /usr/local/kwiki/lib/Kwiki/Command/V1.pm 
line 132.
>

a line is missing from the default config.yaml file

> vi config.yaml

Add the following line

plugins_file: plugins

save the file and try again.

> kwiki -add Kwiki::CoolURI

Note: emacs creates a backup file config.yaml~ which kwiki will try to read. Delete that file. The same thing may apply to other editors if they also create backup files.

Note

Make sure that the 'kwiki' command you are running is the one that was checked out from svn, not one from a previous installation (e.g. /usr/local/bin/kwiki).

Note: Builtin Web Server

The builtin server requires adding the Kwiki::Simple::Server::HTTP plugin.

> cd /path/to/cgi/kwiki-01
> vi plugins

Add the following line to the bottom of the plugins file:

Kwiki::Simple::Server::HTTP

The update the kwiki and start the local web server:

> kwiki -update
> kwiki -start 8080

Press ^c to kill the local web server.

Basic CGI Setup

If using an apache web server, you might decide to put your kwiki in the default CGI directory (typically called cgi-bin), but if you do that, kwiki will seem to work, but will look strange because the icons and the CSS files will attempt to be run as CGI programs instead of being sent to the browser.

The best way (this assumes you have access to the web server's config file) is to install your kwiki somewhere and then set up the directory so that only .cgi files are executed; everything else goes to the browser.

Alias /mykwiki/ "/home/peregrin/Documents/Kwiki/mykwiki/"
<Directory /home/peregrin/Documents/Kwiki/mykwiki/>
     Order allow,deny                                                       
     Allow from all                                                         
     AllowOverride All
     Options ExecCGI                                                        
     AddHandler cgi-script .cgi   
     DirectoryIndex index.cgi                                          
</Directory>