
                       README - DkWiki
                     www.domtemplate.com

DkWiki  Copyright (C) 2008  Michael Mifsud <http://www.domtemplate.com/>
This program comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it 
under certain conditions.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation <http://www.gnu.org/licenses/>.
-----------------------------------------------------


REQUIREMENTS:

 - Linux
 - Apache v1+ (v2 Tested)
 - MySQL v4+ (v5 Tested)
 - PHP v5
 
PREPERATION:

 1. Before any upgrade be sure to backup your existing DkWiki 
    site files. This will guard you against any unforseen errors

 2. If you are installing for the first time you will need to create
    a new .htacess file from the example one provided
    
        # cd {DkWiki_Path}
        # cp .htaccess.in .htccess
    
    If you wiki is located in the root of the domain then thats all you need. 
    However if you have installed the DkWiki into a subdirectory you will need
    update the following line, be sure to add the ending forward slash: 
       
        # vi .htaccess
           RewriteBase /    # Default rewrite path
           OR
           RewriteBase /{DkWiki-htdoc-path}/    # Custom URL path
    
    More Info: http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html#RewriteBase
    
 3. Lastly we need read/write permissions to the data directory.
    This is where the application will store all cache files and user
    files. For advanced users you can modify the .htaccess in teh data 
    directory to restrict files for added security.
    
        # cd {DkWiki_Path}
        # chmod -R ugo+rw data/
    
INSTALLATION:

 1. If this is a fresh install just browse to your DkWiki install url
    and you will be presented with the installation screen.

 2. If you have all green OK flags then we are ready to upgrade or 
    install. If installing, on the next page you will have a number of 
    form fields to fill in. These are the admin user details for the DkWiki
    and the Database connection details. Fill these in and click 'install'
    
 3. If you are upgrading from a past version then you should be able to 
    click install and the upgrade will happen if it is possible.
    If at any time it fails then you may have to use the manual upgrade 
    option. See below.
    
 4. Your Done! We hope you enjoy using the new Look DkWiki. 
 
    Also be sure to view the config.ini.in to see a list of configurable options. 
    To use them rename the config.ini.in to config.ini and set the parameters 
    to meet your requirements. View the Ext_Config object for more details 
    on these options. 
 
MANUAL INSTALLATION:

 1. Copy the config.ini.in to config.ini and change the configuration options 
    to your required settings. You will need to add you DB settings here.

 4. Have a look in the '/DkWiki/lib/Ext/sql' directory and you will need to install
    the install.sql file. This is not covered here see the MySQL docs <http://dev.mysql.com/doc/> 
    for how this is done for your particular server. If you are upgrading a previous install see the 
    UPGRADE section.
   
 5. For support you can sign up to the tropotek forum found at <http://forum.tropotek.com/>


UPGRADE:

 1. Use the upgrade sql files in /lib/sql/upgrade-???.sql
    You can run all the upgrade files after the version you have installed, so If you have v1.0 you 
    would need to run all upgrades above an up to the new version.
  
SUPPORT:

  Please use the forum at http://forum.tropotek.com/ to submit any bugs or
  feature requests. Also if you have any published examples of the DkWiki
  let us know and we will add it to our link pages on the domtemplate.com website.
  
  We requst that donations be made to the domtemplate.com project if you are using 
  the project for commercial sites. This will ensure the long time success of the 
  domtemplate.com projects.
   
  A further not to using the forum. Due to unscruplious spammers we have had to ban a
  number if IP addresses. If you find that one of your IP's is banned and you cannot
  access our servers, you can send us an email <unban@tropotek.com> outlining why you wish 
  to be removed from the banned list. But you must have a valid reason.
  