Contents of /suikawiki/script/INSTALL

* Installing SuikaWiki

This document summarize how to install SuikaWiki 3. 
See also SuikaWiki:SuikaWiki//Setup 
<http://suika.fam.cx/~wakaba/-temp/wiki/wiki?SuikaWiki//Setup> for
more information.

1. Install Perl.  SuikaWiki 3 requires Perl whose version is higher than 5.8.0.
   See <http://www.perl.com/> or <http://www.cpan.org/>.

2. Install Jcode module.  This version of SuikaWiki 3 requires Jcode
   module.  It is available at <http://openlab.ring.gr.jp/Jcode/> or
   with CPAN module,

       $ perl -MCPAN -e shell
       cpan> install Jcode

3. Install BerkeleyDB and MLDBM modules.  Although SuikaWiki 3 does not
   dependes these modules, initial (default) configuration of SWHCS
   requires these modules so that you have to install them to make it
   work without modifying WikiDB configuration.

   With CPAN module,
   
        $ perl -MCPAN -e shell
        cpan> install BerkeleyDB
        cpan> install MLDBM

4. Install manakai module.  See SuikaWiki:manakai
   <http://suika.fam.cx/~wakaba/-temp/wiki/wiki?manakai>.

5. Compiling WikiPlugin modules.  There are two directories
   containing WikiPlugin modules: lib/SuikaWiki/Plugin/ and
   misc/plugins/.  The former has core modules.  All of them
   MUST be compiled.  Later is optional modules so that you
   don't have to compile all modules.

   Compiling core modules:
   
        $ cd lib/SuikaWiki/Plugin/
        $ make all

   Compiling optional modules:
   
        $ cd misc/plugins/
        $ cd subdirectory/   # if necessary
        $ make modulename.pm

     For example, to enable SuikaWiki bug tracking system, type

        $ cd misc/plugins/
        $ make bugtrack.pm

6. Copy SuikaWiki WikiEngine files to somewhere you like.
   Only directory you have to copy is lib/ (ie. SuikaWiki WikiEngine Core)
   but you might wish to copy misc/, too, to use additional WikiPlugin
   modules.  You might also wish to copy other files, for example,
   wiki.cgi, for using SuikaWiki with WWW (see "Installing SWHCS" section).

** Installing SWHCS

Install SWHCS (SuikaWiki HTTP-CGI-Script Driver) if you are interested
in accessing SuikaWiki accross WWW.

1. Install SuikaWiki WikiEngine (you should know what to do if you
   read this document from top).

2. Copy wiki.cgi in your public (world readable) directory.
   SWHCS works as a CGI-script so you need inform your web server that
   this is a CGI-script.  See documentation for your web server software.

3. Prepare WikiDatabase (and configuration) directory.  If you does not
   have it (ie. it is the first time you set up SuikaWiki),

   a. Making configuration file:

      $ cd default/
      $ make config.ph

   b. Copy default/ directory into the directory in which wiki.cgi putted
      into, with name of "wikidata".  (You can use other directory or name but
      you have to fix path in wiki.cgi and wikidata/suikawiki-config.ph.)

   c. Make directories log/ and lock/ into WikiDatabase directory:

      $ cd path/to/wikidata/
      $ mkdir log/
      $ mkdir lock/

   d. Modify path/to/wikidata/suikawiki-config.ph if necessary.
      You can skip this step unless you does not like default configuration.

4. Open wiki.cgi with your web browser (via your web server, off cource!).
   You might want to write some special-purpose WikiPages such
   as HomePage, Wiki//Admin, Wiki//Page//License, Wiki//InterWikiName,
   Wiki//Style//SuikaWiki//text/html, etc.
1	wakaba	1.1	* Installing SuikaWiki
2
3			This document summarize how to install SuikaWiki 3.
4			See also SuikaWiki:SuikaWiki//Setup
5			<http://suika.fam.cx/~wakaba/-temp/wiki/wiki?SuikaWiki//Setup> for
6			more information.
7
8			1. Install Perl. SuikaWiki 3 requires Perl whose version is higher than 5.8.0.
9			See <http://www.perl.com/> or <http://www.cpan.org/>.
10
11			2. Install Jcode module. This version of SuikaWiki 3 requires Jcode
12			module. It is available at <http://openlab.ring.gr.jp/Jcode/> or
13			with CPAN module,
14
15			$ perl -MCPAN -e shell
16			cpan> install Jcode
17
18			3. Install BerkeleyDB and MLDBM modules. Although SuikaWiki 3 does not
19			dependes these modules, initial (default) configuration of SWHCS
20			requires these modules so that you have to install them to make it
21			work without modifying WikiDB configuration.
22
23			With CPAN module,
24
25			$ perl -MCPAN -e shell
26			cpan> install BerkeleyDB
27			cpan> install MLDBM
28
29			4. Install manakai module. See SuikaWiki:manakai
30			<http://suika.fam.cx/~wakaba/-temp/wiki/wiki?manakai>.
31
32			5. Compiling WikiPlugin modules. There are two directories
33			containing WikiPlugin modules: lib/SuikaWiki/Plugin/ and
34			misc/plugins/. The former has core modules. All of them
35			MUST be compiled. Later is optional modules so that you
36			don't have to compile all modules.
37
38			Compiling core modules:
39
40			$ cd lib/SuikaWiki/Plugin/
41			$ make all
42
43			Compiling optional modules:
44
45			$ cd misc/plugins/
46			$ cd subdirectory/ # if necessary
47			$ make modulename.pm
48
49			For example, to enable SuikaWiki bug tracking system, type
50
51			$ cd misc/plugins/
52			$ make bugtrack.pm
53
54			6. Copy SuikaWiki WikiEngine files to somewhere you like.
55			Only directory you have to copy is lib/ (ie. SuikaWiki WikiEngine Core)
56			but you might wish to copy misc/, too, to use additional WikiPlugin
57			modules. You might also wish to copy other files, for example,
58			wiki.cgi, for using SuikaWiki with WWW (see "Installing SWHCS" section).
59
60			** Installing SWHCS
61
62			Install SWHCS (SuikaWiki HTTP-CGI-Script Driver) if you are interested
63			in accessing SuikaWiki accross WWW.
64
65			1. Install SuikaWiki WikiEngine (you should know what to do if you
66			read this document from top).
67
68			2. Copy wiki.cgi in your public (world readable) directory.
69			SWHCS works as a CGI-script so you need inform your web server that
70			this is a CGI-script. See documentation for your web server software.
71
72			3. Prepare WikiDatabase (and configuration) directory. If you does not
73			have it (ie. it is the first time you set up SuikaWiki),
74
75			a. Making configuration file:
76
77			$ cd default/
78			$ make config.ph
79
80			b. Copy default/ directory into the directory in which wiki.cgi putted
81			into, with name of "wikidata". (You can use other directory or name but
82			you have to fix path in wiki.cgi and wikidata/suikawiki-config.ph.)
83
84			c. Make directories log/ and lock/ into WikiDatabase directory:
85
86			$ cd path/to/wikidata/
87			$ mkdir log/
88			$ mkdir lock/
89
90			d. Modify path/to/wikidata/suikawiki-config.ph if necessary.
91			You can skip this step unless you does not like default configuration.
92
93			4. Open wiki.cgi with your web browser (via your web server, off cource!).
94			You might want to write some special-purpose WikiPages such
95			as HomePage, Wiki//Admin, Wiki//Page//License, Wiki//InterWikiName,
96			Wiki//Style//SuikaWiki//text/html, etc.