====== DokuWiki Installation ======

**There are separate [[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 [[security|security page]] //before// you begin installing. Take it seriously. If in doubt, ask on the [[mailinglist| mailing list]]

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

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

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

[[:install:screencast|A screencast of installing DokuWiki]] shows installation to a shared web hosting provider, but it may be useful for other situations as well.

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

If you encounter problems following the steps above or need some detailed information 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]]
  * [[installer|install.php instructions]]
  * [[install:upgrade|Upgrading from a previous Version]]
  * [[FAQ|Frequently Asked Questions]]
==== Distribution/OS Specifics ====

    * [[install:Debian]]
    * [[install:Gentoo]]
    * [[install:FreeBSD]]
    * [[install:MacOSX]] or [[.install:mac_alt]] FIXME
    * [[install:OpenSolaris]]
    * [[install:Solaris]]
    * [[http://wiki.archlinux.org/index.php/Dokuwiki|Arch Linux]]
    * [[install:openSUSE|openSUSE]]
    * [[install:Ubuntu|Ubuntu]]
    * [[install:Fedora]]
    * [[install:Windows]]
    * NETGEAR ReadyNAS (coming soon)
    * Synology Diskstation NAS?
    * QNAP NAS??
    * [[install:Slax|SLAX]]
    * CentOS 6

==== Webserver Specifics ====

    * [[install:Lighttpd]]
    * [[install:Nanoweb]]
    * [[install:IIS]]
    * [[install:nginx]]
    * [[install:Hiawatha]]
    * [[install:Mongoose]]

==== Web Host Specifics ====

    * [[install:hosted|Installing DokuWiki on Hosted Webspace]]
    * [[install:dreamhost|DokuWiki on Dreamhost]]
    * [[install:godaddy.com|DokuWiki on GoDaddy]]
    * [[install:free.fr|DokuWiki on free.fr]]
    * [[install:sourceforge|DokuWiki on SourceForge]]
    * [[install:strato|DokuWiki on Strato and 1&1]]

==== Alternative Install Methods ====

    * [[install:downloader|DokuWiki Downloader]] -- a single script that takes care of downloading and installing DokuWiki
    * [[http://www.turnkeylinux.org/dokuwiki|TurnKey DokuWiki Appliance]] -- a free open source virtual appliance based on Ubuntu that's easy to use and lightweight. Auto-updated daily with latest security patches. Deploys in minutes to a Virtual Machine, bare metal, or in the cloud. Part of the [[http://www.turnkeylinux.org|TurnKey Linux Virtual Appliance Library]].
    * [[: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). Available for Windows, Linux, Mac x86, Mac PPC, Solaris x86 and Solaris SPARC.
    * [[http://bitnami.org/stack/dokuwiki|DokuWiki Bitnami Module]] -- an installer which deploys DokuWiki on top of LAMPStack if you are using Linux, or MAMPStack, WAMPStack or SAMPstack if you are using Mac, Windows or Solaris allowing to share database, webserver and language runtime with other applications modules.   
    * [[http://sourceforge.net/projects/desktopwiki/|Desktop Wiki]] -- another portable DokuWiki
    * [[devel:git#maintaining_a_stable_version_with_git|Using Git to handle the installation]]
    * [[http://dl.dropbox.com/u/42335010/dokuwiki.zip | Windows only portable Dokuwiki using Nginx]] - Download, extract and run dokuwiki.hta. Remember to run http://localhost:8080/install.php the first time.

===== 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 -- use config [[config:license]] or edit the ''footer.html'' inside the dokuwiki/lib/tpl/... folder if your template doesn't use tpl_licence() introduced with DokuWiki 2009-02-14.
  * Enter a few words how and where you use [[DokuWiki]] in the [[users|userpage]]
  * Subscribe to the [[newsletter]]
  * Read:
    * [[faq|Frequently Asked Questions]]
    * [[tips:maintenance|day-to-day maintenance needed for DokuWiki]]
    * [[tips|tips and tricks]], especially [[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 [[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]]