[Sommaire] [Imprimer]

   1  $Id: INSTALL.txt 9853 2003-03-04 21:21:05Z ralfbecker $
   2  
   3  
   4  Feedback
   5  --------
   6  
   7  Your feedback is welcome to help make these installation instructions
   8  more useful, understandable, and complete.  If you have any suggestions,
   9  criticisms, questions, or other comments, please send them to
  10  tavi-devel@lists.sourceforge.net.  Thanks!
  11  
  12  
  13  WikkiTikkiTavi - Installation
  14  -----------------------------
  15  
  16  (See below, under "WikkiTikkiTavi - Upgrading", if you are upgrading an
  17  existing 'Tavi installation.)  See http://tavi.sourceforge.net/ for
  18  more detailed instructions dealing with virtual hosts, 'Tavi templates,
  19  URL rewriting, etc.
  20  
  21  1.  Choose a location in which to install 'Tavi.  You do not need to
  22      install 'Tavi under your webspace; in fact, it is recommended that
  23      you do not do so.  While there are no known security exploits in
  24      'Tavi 0.21, it is best for security purposes to leave as few
  25      scripts exposed to the web as possible.
  26  
  27      Additionally, if you install 'Tavi in a central location, you can
  28      use it once for multiple wikis on your web server.  This makes
  29      administration of virtual hosts or wiki farms much simpler.  Upgrading
  30      to a later version of 'Tavi also is simplified, as you can upgrade
  31      multiple wikis in one step.
  32  
  33      For the sake of example, the following assumes that you have chosen
  34      to install 'Tavi in the following directory:
  35  
  36        /usr/local/lib/tavi/
  37  
  38      Alternatively, you can install 'Tavi directly in your webspace and
  39      use it without complication; there is no reason that 'Tavi *must* be
  40      installed in a central location, although it is recommended.
  41  
  42  2.  Download the 'Tavi archive into the installation directory.  You can
  43      find it at http://prdownloads.sourceforge.net/tavi/
  44  
  45  3.  Unpack the archive in the installation directory.  It should create
  46      a subdirectory named 'tavi-0.21'.
  47  
  48  4.  [Not necessary, but recommended.]
  49  
  50      Create a symbolic link in the installation directory that points to
  51      the archive subdirectory.  For example, create a symbolic link in
  52      /usr/local/lib/tavi/ called 'tavi-current', that points to
  53      '/usr/local/lib/tavi/tavi-0.21'.  This allows your wikis to point
  54      to 'tavi-current', allowing you to automatically upgrade them to
  55      a newer release by simply pointing 'tavi-current' to the new
  56      release's location.
  57  
  58  5.  Run install/create-db.pl to create the database tables for your wiki:
  59  
  60      Its first parameter should be the name of the (already created) MySQL
  61      database where the tables will be created.  If you have not yet
  62      created the database, you should do so before running the script.
  63  
  64      Its second and third parameters are the user name and password to use
  65      to access the database.
  66  
  67      Optionally, you can include a fourth parameter to specify a prefix to
  68      be prepended to the table names.  If you have access to only one MySQL
  69      database, you can use this feature to install multiple wikis in the same
  70      database.
  71  
  72      You may also include a fifth parameter to specify the hostname or IP
  73      address of the database server, if it is not the local host.
  74  
  75      Examples:
  76  
  77        perl ./create-db.pl wiki joe passwd
  78        perl ./create-db.pl project sally pass wiki_ database.example.com
  79        perl ./create-db.pl common jim key "" mysql.example.com
  80  
  81  6.  In the install/ directory, run the "configure.pl" script to generate a
  82      configuration file for your wiki.  It takes one parameter, the location
  83      of the configuration file.  For example:
  84  
  85        perl ./configure.pl /home/u/user12/tavi/config.php
  86        perl ./configure.pl ../config.php
  87  
  88      You will be prompted for such things as the URL to the wiki script,
  89      the name of your wiki, database information, etc.
  90  
  91      As with the 'Tavi source, it is recommended that you keep your
  92      configuration file in a location that cannot be accessed from the web.
  93  
  94      You may wish to double-check the 'config.php' file that was created by
  95      the configuration script, to make sure that the settings are correct.
  96  
  97  7.  If you installed 'Tavi in your webspace, then skip this step, since
  98      index.php is already accessible from the web.
  99  
 100      A. Now you have to create an entry point to your wiki.  Choose a directory
 101         in your webspace to be the base point for your wiki.  For sake of
 102         example, we will use /home/joe/public_html/mywiki/.
 103  
 104      B. Create a subdirectory named 'admin/' in this directory.  E.g.,
 105         /home/joe/public_html/mywiki/admin.
 106  
 107      C. In the base directory, create a symbolic link to the index.php in the
 108         'Tavi installation.  For example, create
 109         /home/joe/public_html/mywiki/index.php that is a link to
 110         /usr/local/lib/tavi/tavi-current/index.php.
 111  
 112      D. In the admin/ subdirectory, create a symbolic link to the index.php in
 113         the admin subdirectory in the 'Tavi installation.  For example, create:
 114         /home/joe/public_html/mywiki/admin/index.php that is a link to
 115         /usr/local/lib/tavi/tavi-current/admin/index.php.
 116  
 117  8.  Configure your script so that it can access the 'Tavi scripts and so that
 118      it can access your configuration file.  If you have installed 'Tavi in
 119      your webspace, and you have placed the config.php file in the root of
 120      that location, then you can skip this step.  Otherwise, continue:
 121  
 122      A. Locate the directories for your 'Tavi installation and for your
 123         config.php file.  For example, they might be:
 124  
 125           /usr/local/lib/tavi/tavi-current
 126           /home/joe/tavi/mywiki
 127  
 128      B. If you are running PHP as mod_php under Apache, add the directories
 129         to the .htaccess file in the directory where the wiki resides.
 130         Separate them with colons:
 131  
 132           php_value include_path "/home/joe/tavi/mywiki:/usr/local/lib/tavi/tavi-current"
 133  
 134      C. If, instead, you are running PHP as a CGI program, then you will have to
 135         similarly change the include_path in your php.ini file to point to the
 136         given directories.  (To prevent this from affecting your other PHP
 137         scripts, see http://tavi.sourceforge.net/CGI+Wrapping.)
 138  
 139  9.  [Optional, but recommended.]
 140  
 141      Turn off register_globals for 'Tavi.  While there are no known security
 142      exploits in 'Tavi 0.21, this is generally a good idea to make your scripts
 143      less liable to undiscovered exploits.
 144  
 145      A. If you are running PHP as mod_php under Apache, add the following line
 146         to the .htaccess file in the directory where the wiki resides:
 147  
 148           php_flag register_globals off
 149  
 150      B. If, instead, you are running PHP as a CGI program, then you will have
 151         to similarly change the register_globals setting in your php.ini file.
 152         (To prevent this from affecting your other PHP scripts, see
 153         http://tavi.sourceforge.net/CGI+Wrapping.)
 154  
 155  10. Visit your wiki and start creating pages!
 156  
 157      Apart from your wiki's home page, you should also create RecentChanges,
 158      containing (at minimum) a wildcard subscription list like so:
 159  
 160        [[! *]]
 161  
 162      You should also create some InterWiki entries.  See
 163      http://tavi.sourceforge.net/InterWiki for help.
 164  
 165  11. Advertise your wiki.  Feel free to put a link to your wiki on
 166      http://tavi.sourceforge.net/TaviSites.
 167  
 168  12. Read more about using and administering 'Tavi at
 169      http://tavi.sourceforge.net/TaviDocumentation.
 170  
 171  
 172  Advanced
 173  ========
 174  
 175     * Customizing Your Wiki
 176  
 177       See http://tavi.sourceforge.net/CustomizingTavi for help on how you can
 178       tweak your wiki's behavior and appearance to your heart's content.
 179  
 180     * Virtual Hosts and Wiki Farms
 181  
 182       If you are running a virtual host server, or a wiki farm, you might
 183       wish to install 'Tavi a single time, rather than once for each wiki.
 184       If you installed 'Tavi as suggested above, this will be easy to achieve.
 185       See http://tavi.sourceforge.net/VirtualHosts for help.
 186  
 187     * Using Templates
 188  
 189       'Tavi allows you to configure templates to customize your wiki's
 190       appearance.  To make things easier on yourself if you upgrade 'Tavi
 191       in the future, you should *copy* rather than directly edit the default
 192       template.  See http://tavi.sourceforge.net/CustomizingTemplates for
 193       help.
 194  
 195     * URL Rewriting
 196  
 197       With a few simple tricks you can set up your wiki so the pages appear
 198       like http://example.com/wiki/PageName.  See
 199       http://tavi.sourceforge.net/URL+Rewriting for help.
 200  
 201     * Sister Wikis
 202  
 203       'Tavi allows you to set up *sister wikis*.  'Tavi will recognize pages
 204       on sister wikis that have the same names as pages on your wiki.  It
 205       will display links to the sister wiki pages on your wiki's pages.
 206       See http://tavi.sourceforge.net/SisterWiki for help.
 207  
 208     * Automated Upgrades
 209  
 210       'Tavi's configuration has been re-organized so that upgrades in the
 211       future should be nearly effortless.  See
 212       http://tavi.sourceforge.net/AutomatedUpgrades for help.
 213  
 214  
 215  WikkiTikkiTavi - Upgrading
 216  ==========================
 217  
 218  'Tavi version 0.21 has rearranged its configuration somewhat, to allow for
 219  more effortless upgrades in the future.
 220  
 221  Unfortunately, this means that upgrading from version 0.20 to version 0.21
 222  will not quite be effortless.  Fortunately, no database changes need to be
 223  made; the only changes are in configuration.
 224  
 225  config.php is no longer in the distribution.  Instead, you create config.php
 226  when you install 'Tavi, and it is never overwritten, even if you later upgrade
 227  to a newer release.
 228  
 229  The simplest way to upgrade to 'Tavi 0.21 is to scrap your existing config.php
 230  and use install/configure.pl to generate a new one for you, as described
 231  above in "WikkiTikkiTavi - Installation".  It will prompt you for all the
 232  relevant configuration values.
 233  
 234  If you have been using a customized template, we recommend that you place
 235  it in a directory other than template/.  This will prevent it from being
 236  overwritten when you upgrade now (or later).  (However, you may wish to
 237  consider using the new template as a starting point for your custom template,
 238  as it has been tweaked to be compliant with the XHTML-Strict standard.) 
 239  
 240