Changeset 45 for trunk/README

Show
Ignore:
Timestamp:
01/16/07 14:13:52 (2 years ago)
Author:
ingy
Message:
 r3090@skinny:  ingy | 2007-01-16 13:52:06 -0800
 Rearranging the Kwiki tree.
Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/README

    r28 r45  
    5151Just write a plugin! 
    5252 
    53 = INSTALLATION 
    54  
    55 Kwiki is incredibly easy to set up. Kwiki bundles everything you need to 
    56 get up and running including an optional standalone web server. All you 
    57 need is a Unix environment with Perl of version 5.8.3 or higher. 
    58  
    59 Ready? You only need to do a few simple steps: 
    60  
    61 1) Get the Kwiki software. 
    62  
    63 Odds are, that since you are reading this, you already have done this 
    64 step. If not, you can get the software using one of these methods: 
    65  
    66   A) svn checkout http://svn.2.kwiki.org/kwiki /usr/local/kwiki 
    67  
    68      This is the preferred way to get the sources, since it makes 
    69      getting updates as easy as `svn update`. 
    70  
    71   B) svk checkout http://svn.2.kwiki.org/kwiki /usr/local/kwiki 
    72  
    73      SVK is even better than SVN, but takes a little bit more time to 
    74      get used to. It is the Hacker's Choice for version control. 
    75  
    76   C) Download the latest Kwiki tarball from 
    77      http://downloads.2.kwiki.org/ and untar it. 
    78  
    79 Kwiki does not have an install procedure. Once you have the software, it 
    80 is "installed". Just put it some nice, safe place like `/usr/local/kwiki`. 
    81  
    82 2) Put the `kwiki` command line utility in your PATH. 
    83  
    84 At the top level of your new Kwiki software is a directory called `bin` 
    85 which contains the command line utility called `kwiki`. This utility is 
    86 needed for managing the Kwiki software. 
    87  
    88 You should put this `bin` directory in your PATH environment setting. Use a 
    89 command like this in your login script: 
    90  
    91     export PATH=/usr/local/kwiki/bin:$PATH 
    92  
    93 Now you can run `kwiki` commands in your shell. 
    94  
    95 NOTE: If you have already installed an older version of Kwiki, you may 
    96       already have a `kwiki` script in your PATH. It is important that 
    97       you put the new script in front of the older one in your PATH. Do 
    98       a `which kwiki` command to make sure things are set up properly. 
    99  
    100 3) Run the command `kwiki -configure`. 
    101  
    102 You need to run this command once for each time you update the Kwiki 
    103 software. This command learns things about your system environment and 
    104 saves them in a place that Kwiki can access them from easily. It will 
    105 ask you a few questions. 
    106  
    107 To learn find out what questions it will ask you (so you can be prepared 
    108 to answer them) see http://2.kwiki.org/?KwikiConfigurationQuestions. 
    109  
    110 4) Create a new wiki with `kwiki -new`. 
    111  
    112 This command installs a Kwiki instance, which is a running wiki website. 
    113 You can either create a new directory, or specify the directory name in 
    114 the command. 
    115  
    116     cd /path/to/cgi/ 
    117     mkdir kwikii-01 
    118     cd kwiki-01 
    119     kwiki -new 
    120  
    121 or (more simply): 
    122  
    123     kwiki -new /path/to/cgi/kwiki-01 
    124  
    125 5) Start a web server with `kwiki -start`. 
    126  
    127 Kwiki comes with its own lightweight web server. To start running your new 
    128 Kwiki instance, go into its directory and run `kwiki -start`. Or optionally 
    129 specify the directory on the command: 
    130  
    131     kwiki -start /path/to/cgi/kwiki-01 
    132  
    133 This is the easy way to get going, but for a real wiki on the Web, 
    134 you'll probably want to use a "real" web server. In this case, just make 
    135 sure your webserver is running and knows about your Kwiki. 
    136  
    137 You can use any CGI enabled web server to run Kwiki. Apache and Lighttpd 
    138 are popular choices. Just put your new Kwiki instance directory in a 
    139 place where the web server expects to have Perl CGI programs. This may 
    140 or may not require configuration changes to your web server. 
    141  
    142 6) You are done!!! 
    143  
    144 Well at least you got a Kwiki up and running. :-) See the next section 
    145 for advice on configuring and maintaining your new Kwiki. 
    146  
    147 == Installation Command Line Synopsis 
    148  
    149 In review, basically just do these commands: 
    150  
    151   > svk checkout http://svn.2.kwiki.org/kwiki /usr/local/kwiki 
    152   > export PATH=/usr/local/kwiki/bin:$PATH 
    153   > kwiki -configure 
    154   > kwiki -new /path/to/cgi/kwiki-01 
    155   > kwiki -start /path/to/cgi/kwiki-01 
    156  
    157 = CONFIGURATION 
    158  
    159 = COMMUNITY