====== DokuWiki Installation ======
There are separate   [[wiki:install:upgrade|upgrade instructions]] if you have an existing installation.

Installing [[DokuWiki]] is very easy - in general it's just a matter of unpacking and setting permissions. You should first try to follow the simple instructions given here, if you encounter problems or the instructions are not detailed enough for you, follow one of the links below.

  * **Step 1:** Download the newest release from the [[sb>dokuwiki|Download Page]].

  * **Step 2:** Read the [[wiki:security|security page]] //before// you begin installing. Take it seriously. If in doubt, ask on the  [[wiki:mailinglist| mailing list]]

  * **Step 3:** Unpack the distribution tarball and upload/copy the files to your webspace.

  * **Step 4:** Open the install.php in your browser and follow the instructions.  (For additional information, see the [[wiki:installer]] page.)

  * **Step 5:** Enjoy your DokuWiki install and browse through the [[manual]] to discover what you can do with it

A screencast of installing DokuWiki is available [[wiki:screencast:install|here]].  While it shows installation to a shared web hosting provider, it may be useful for other situations.

===== Detailed Instructions =====

If you encounter problems following the steps above or need some detailed infos for one of the steps check out these pages:

  * [[.install:unpacking|Extracting a .tgz archive]]
  * [[.install:permissions|How to set up permissions]]
  * [[.install:hosted|Installing DokuWiki on Hosted Webspace]]
  * [[wiki:installer|install.php instructions]]
  * [[.install:upgrade|Upgrading from a previous Version]]
  * Distribution/OS Specifics:
    * [[.install:Debian]]
    * [[.install:Gentoo]]
    * [[.install:FreeBSD]]
    * [[.install:MacOSX]]
    * [[.install:fsg-3]] (NAS with linux kernel)
    * [[.install:Solaris]]
  * Webserver Specifics:
    * [[.:install:Apache]]
    * [[.install:Lighttpd]]
    * [[.install:Nanoweb]]
    * [[.install:IIS]]
  * Web Host Specifics:
    * [[.install:hosted|Installing DokuWiki on Hosted Webspace]]
    * [[wiki:faq:sourceforge|DokuWiki on Sourceforge]]
    * [[wiki:faq:free.fr|DokuWiki on free.fr]]
  * Alternative Install Methods:
    * [[http://www.splitbrain.org/blog/2007-12/01-dokuwiki_on_a_stick|DokuWiki on a Stick]] -- run DokuWiki directly from an USB stick
    * [[http://bitnami.org/stack/dokuwiki|DokuWiki Bitnami Stack]] -- an installer which deploys DokuWiki and all that's necessary to run it (Apache, PHP)
    * [[wiki:darcs#maintaining_a_stable_version_with_darcs|Using Darcs to handle the installation]]
  * [[FAQ|Frequently Asked Questions]]

===== It Works! What Now? =====

Here is what you may want to do when everything is up and working:

  * Check the [[security]] page again ;-)
  * Consider enabling [[rewrite|URL rewriting]]
  * Choose a license for your content -- edit the ''footer.html'' inside the dokuwiki/lib/tpl/default folder to represent the appropriate license
  * Enter a few words how and where you use [[DokuWiki]] in the [[users|userpage]]
  * [[http://freshmeat.net/subscribe/48181/|Subscribe]] to DokuWiki at [[http://www.freshmeat.net|freshmeat.net]] to stay informed of updates and get a mail whenever a security problem is encountered.
  * Read:
    * [[wiki:faq|Frequently Asked Questions]]
    * [[wiki:tips:maintenance|day-to-day maintenance needed for Dokuwiki]]
    * [[wiki:tips|tips and tricks]], especially [[wiki:tips:tailorwikirules|best-practices]] to follow after [[installing]]

===== It Doesn't Work! Troubleshooting =====

If you've encountered problems installing DokuWiki, and you've carefully checked each of the steps above:

  * [[sb>dokuwiki|download the source package]] again to ensure you do not have a corrupt download
  * upload your files again - FTP corruption is a common cause for problems.  Uploading a zip file and extracting on the server may be more reliable than uploading files individually
  * double and triple check [[wiki:install:permissions|file and folder permissions]] - this is a **very** common cause of problems
  * be sure to [[http://forum.dokuwiki.org/search|search the forum]] before posting your questions to the [[http://forum.dokuwiki.org/forum/2/|installation forum]]
 
=== Development Version ===
If you're attempting to run a [[http://dev.splitbrain.org/browse/snapshots/|development version]] (which will likely fix some bugs whilst adding new ones) and receive message "//unrecognised or modified dokuwiki.php//", perform the following:
    - copy the reported hash key, e.g. '''1e5c42eac3219d9e21927c39e3240aad'''
    - open //install.php// and find <code>$dokuwiki_hash array</code>
    - duplicate the final line within the array, e.g. <code>'2007-06-26'   => 'b3ca19c7a654823144119980be73cd77',</code>
    - edit your duplicated line for date and new hash key, e.g. <code>'2008-03-17'   => '1e5c42eac3219d9e21927c39e3240aad',</code>
    - save, upload to server and rerun ''install.php''