= Installation Instructions for Wikiup, version beta0.1 =

You will first have to make sure that the Apache and CVS servers are
running in your machine and that you have Python 2 installed.

Untar the wikiup distribution tarball, and in its main directory run
the setup.py script (as root) to put the Python modules in place:
	./setup.py install

== Apache set-up ==

In the default configuration we will assume that the root directory in
your Apache installation is /var/www which is accessed through the
URL http://localhost and the Apache server is being run by the user
www-data (make the necessary changes in the following instructions).
We also assume that your Apache configuration includes a cgi-bin directory
in /usr/lib/cgi-bin/, which is accessible through http://localhost/cgi-bin/

	1. Create a directory for static pages: `makedir /var/www/wikiup`
	2. Make it belong to Apache: `chown www-data.www-data /var/www/wikiup`
	3. Create a directory for the scripts: `makedir /usr/lib/cgi-bin/wikiup`

You may choose different names for those directories, but remember to
update the configuration file wikiup.conf (see below).
Copy all files and subdirectories under cgi/ in the Wikiup distribution, into
`/usr/lib/cgi-bin/wikiup`.

== CVS set-up ==

Create a CVS repository where Wikiup will keep the source of your Wiki pages.
In the default configuration we assume it is in /cvsroot/wikiup. Make sure the
user running Apache (www-data in our case) has read/write privileges in that
repository.
 

== Configuration file and HTML templates ==

Create a directory where you will copy all files in the etc/ subdirectory of
the Wikiup distribution. For this version of Wikiup, it has to be /etc/wikiup
In future releases we will allow you to change that default. Edit
the configuration file wikiup.conf in that directory, as needed. Edit also
the HTML templates for static and dynamic pages as you wish. There are a few
variables that can/should be included in those templates and will be replaced
by Wikiup:

	%(tile)s	page's title
	%(text)s	page's text
	%(username)s  username (should not be used in the static template)
	%(home)s	the home directory, relative to the base URL for either
		  static or dynamic pages.

(the "s" stands for string format).

You must create two files where Apache can write:

	touch users login
	chown www-data.www-data users login

the default location is /etc/wikiup, but you can put them anywhere you want
and even change their names, if you update the wikiup.conf file accordingly.

At this point Wikiup should be fully operational. Access
http://localhost/cgi-bin/wikiup/wikiup (or whatever you need to access the
wikiup CGI script in your case). You should obtain a message telling you that
the default page does not exist and a link to create it. The syntax rules
can be found in [doc/syntax] in the Wikiup distribution.

== Current limitations ==

At this release, there is no registration script. You have to register users
manually by editing the *users* file. Each line in that file must have a
structure similar to that of /etc/passwd:

  Login-name:encrypted-password:Numerical-user-ID:Num-group-ID:Name <e-mail>

The password should be encrypted with MD5:

  echo -n 'password' | md5sum

You should try to use the same user-id and group-id number as in /etc/passwd
because they will be used in future releases. In fact, you can cut and paste
lines from /etc/passwd but the encrypted password cannot be used (generate
them with the md5sum command).

Wikiup allows you to put pages in subdirectories of the CVS repository, but
currently those subdirectories must be created manually in the repository.
Also, you can edit the pages off-line and commit them to the repository, but
the corresponding html pages will not be updated until you edit them on-line
with wikiup. In the next release we will include a simple script to let CVS do
the html conversion automatically.

Enjoy it.

Porto, May 20th 2003. Jaime Villate <villate@gnu.org>
 
