Nurpawiki for Debian
--------------------


1. Setting up Nurpawiki
~~~~~~~~~~~~~~~~~~~~~~~

To use Nurpwaki, you first need to set up a PostgreSQL database. With
Wheezy's PostgreSQL (version 9.1), the steps on the SQL server are (as
user postgres):

 1. Create a user in the database:
      createuser ${DBUSER}
 2. Create the database for Nurpawiki:
      createdb -O ${DBUSER} -E UTF-8 ${DBNAME}
 3. Set a password for the user accessing the database:
      psql ${DBNAME} ${DBUSER}
      ALTER ROLE ${DBUSER} PASSWORD '${DBPASSWORD}';
      \q

You can take, for example, DBUSER=ocsigen and DBNAME=nurpawiki (beware
of commands executed in psql shell). Nurpawiki will create the SQL
schema itself if needed.

A sample template for a configuration file is available in
/usr/share/doc/nurpawiki/examples. Filling it with proper database
user, database name and password will give you a <file> that can be
run with "ocsigenserver -c <file>" (as root). Ocsigen will then be
listening on port 8080, as user ocsigen, and be serving Nurpawiki only
(at /). If satisfied, and if you don't use any other Ocsigen-based
service, you can directly use that configuration file as
/etc/ocsigenserver/ocsigenserver.conf and use the initscript to launch
ocsigenserver. Of course, Nurpawiki can be used with other
Ocsigen-based services, but you'll have to edit
/etc/ocsigenserver/ocsigenserver.conf yourself.

At installation, a wiki user "admin" with an empty password is created.


2. Websites
~~~~~~~~~~~

  Tutorial on using Nurpawiki:
    http://code.google.com/p/nurpawiki/wiki/Tutorial

  Nurpawiki project page (use Issues tab for bug reporting):
    http://code.google.com/p/nurpawiki/

  Ocsigen project page:
    http://ocsigen.org/


3. Known limitations
~~~~~~~~~~~~~~~~~~~~

Ocsigen provides a /etc/ocsigenserver/conf.d directory for easy
splitting of the configuration but the default
/etc/ocsigenserver/ocsigenserver.conf provided by the ocsigenserver
package makes it useless. This is the reason why the configuration
part is still a bit tricky (this will hopefully be fixed in the
future).

 -- Stéphane Glondu <glondu@debian.org>, Tue,  9 Apr 2013 15:50:35 +0200
