Difference between revisions of "Dokuwiki"

From ArchWiki
Jump to: navigation, search
(PHP, lighttp, and fastcgi: Create the test document.)
(Installing Plugins)
(22 intermediate revisions by 14 users not shown)
Line 1: Line 1:
== Installing DokuWiki ==
+
[[Category:Office]]
=== What is DokuWiki? ===
+
[[es:Dokuwiki]]
 
+
[[zh-TW:Dokuwiki]]
 
"DokuWiki is a standards-compliant, simple-to-use wiki which allows users to create rich documentation repositories. It provides an environment for individuals, teams and companies to create and collaborate using a simple yet powerful syntax that ensures data files remain structured and readable outside the wiki."
 
"DokuWiki is a standards-compliant, simple-to-use wiki which allows users to create rich documentation repositories. It provides an environment for individuals, teams and companies to create and collaborate using a simple yet powerful syntax that ensures data files remain structured and readable outside the wiki."
  
 
"Unlimited page revisions allows restoration to any earlier page version, and with data stored in plain text files, no database is required. A powerful plugin architecture allows for extension and enhancement of the core system. See the features section for a full description of what DokuWiki has to offer."[http://wiki.splitbrain.org/wiki:dokuwiki]
 
"Unlimited page revisions allows restoration to any earlier page version, and with data stored in plain text files, no database is required. A powerful plugin architecture allows for extension and enhancement of the core system. See the features section for a full description of what DokuWiki has to offer."[http://wiki.splitbrain.org/wiki:dokuwiki]
  
In other words; DokuWiki is a wiki written in PHP and requires no database.
+
In other words, DokuWiki is a wiki written in PHP and requires no database.
  
 
[http://www.dokuwiki.org/ Like to see a running example?]
 
[http://www.dokuwiki.org/ Like to see a running example?]
  
=== Initial Notes ===
+
== Initial Notes ==
 +
DokuWiki should work on any web server which supports PHP 5.1.2 or later.  As the requirements may change over time, you should consult the [http://www.dokuwiki.org/requirements requirements page] for DokuWiki for additional details.
  
The following guide sets up a DokuWiki under a directory beneath the html root.
+
It is strongly recommend to read through the appropriate sections of [http://www.dokuwiki.org/security DokuWiki's security page] for your web server.  Most popular web servers are covered but there are generic instructions as well.
  
If anyone would like to add a vhost setup guide please feel free to add it.
+
The package in [community] unpacks DokuWiki at {{ic|/srv/http/dokuwiki}} and changes ownership to the "http" user. This should work fine for most popular web servers as packaged for Arch.
  
==== lighttp Notes ====
+
== Installation ==
  
See [[Fastcgi_and_lighttpd]] for more details.
+
# Install your web server of choice (e.g. [[Apache]] or [[lighttpd]]) and configure it for [[PHP]].  As mentioned above, DokuWiki has no need for a database server so you may be able to skip those steps when setting up your web server.
 +
# Install {{Pkg|dokuwiki}} from [community] with [[pacman]].
 +
# Configure web server for dokuwiki (see section below)
 +
# With your web browser of choice, open <nowiki>http://&lt;your-server&gt;/dokuwiki/install.php</nowiki> and continue the installation from there.
  
The html root is located under /srv/http. This directory may not be created by default, so create it if not.
+
Alternatively, if you would like to install from tarball, you can read from http://www.dokuwiki.org/Install.  Generally the procedure is the same as above.  Instead of using pacman, you will need to [http://www.splitbrain.org/projects/dokuwiki download the tarball], unpack it to your server's document root (e.g. {{ic|/srv/http/dokuwiki}}), and chown to the appropriate user (e.g. "http").
  #mkdir -p /srv/http
+
lighttp also creates (or uses) the user account and group of http:http.
+
  #chown http:http /srv/http
+
  
All of these settings can be changed in the file
+
== Configuration ==
  /etc/lighttpd/lighttpd.conf
+
  
==== DokuWiki Notes ====
+
=== Apache ===
  
Some of the DocuWiki plugins look to the root of the webserver rather than the root of the DokuWiki folder, which can cause some problems. All of the default plugins work with the following installation method.
+
Firstly, create the file {{ic|/etc/httpd/conf/extra/dokuwiki.conf}} with the following contents:
  
== Installing lighttp ==
+
{{bc|
=== PHP, lighttp, and fastcgi ===
+
Alias /dokuwiki /usr/share/webapps/dokuwiki
Install PHP [[Fastcgi and lighttpd]]
+
<Directory /usr/share/webapps/dokuwiki/>
  #pacman -S lighttpd fcgi php
+
    Options +FollowSymLinks
Add an entry to your rc.conf
+
    AllowOverride All
  DAEMONS=(syslog-ng network netfs crond '''lighttpd''')
+
    order allow,deny
Edit your /etc/hosts.allow (by adding the following line)
+
    allow from all
  lighttpd:    ALL
+
    php_admin_value open_basedir "/srv/http/:/home/:/tmp/:/usr/share/pear/:/usr/share/webapps/:/etc/webapps/dokuwiki/:/var/lib/dokuwiki/"
Start your webserver (''sanity check'')
+
</Directory>
  #/etc/rc.d/lighttpd start
+
}}
Create a test document
+
  #echo "Testing lighttpd" > /srv/http/index.html
+
Open a web browser to http://127.0.0.1/, and you should see the test document.
+
  
If it didn't work try (and check again):
+
Include the newly created file in the Apache configuration by placing the following line at the end of {{ic|/etc/httpd/conf/httpd.conf}}:
chown -R http:http /var/run/lighttpd/
+
{{bc|
 +
Include conf/extra/dokuwiki.conf
 +
}}
  
Stop the webserver
+
Make sure the folders {{ic|/etc/webapps/dokuwiki}} and {{ic|/var/lib/dokuwiki}} are owned by user and group "http". You may relocate these directories if you like as long as you update the references in {{ic|/etc/httpd/conf/extra/dokuwiki.conf}} respectively.
  #/etc/rc.d/lighttpd stop
+
  
=== Configuration ===
+
Afterwards restart Apache:
 +
  # systemctl restart httpd.service
  
Uncomment these lines in /etc/lighttpd/lighttpd.conf
+
Then finish the installation by running the ''dokuwiki/install.php'' script in your browser.
<pre>
+
"mod_fastcgi"
+
</pre>
+
<pre>
+
fastcgi.server            = ( ".php" =>
+
                              ( "localhost" =>
+
                                (
+
                                  "socket" => "/var/run/lighttpd/php-fastcgi.socket",
+
                                  "bin-path" => "/usr/bin/php-cgi"
+
                                )
+
                              )
+
                            )
+
</pre>
+
  
== Installing DokuWiki ==
+
=== lighttpd Specific Configuration ===
=== Downloading the Latest Version ===
+
Go to the [http://www.splitbrain.org/projects/dokuwiki DokuWiki download] site and get the latest version
+
  #mv dokuwiki*.tar.gz /srv/http
+
  #cd /srv/http
+
  #tar zxf dokuwiki*.tar.gz
+
  #mv dokuwiki-DATE dokuwiki
+
  
=== Preparing the Installation Files ===
+
Edit the {{ic|/etc/lighttpd/lighttpd.conf}} file as per the [http://www.dokuwiki.org/install:lighttpd dokuwiki instructions] (might contain updated information).
chown the DokuWiki files
+
  #chown -R http:http dokuwiki/
+
(http is the default user for lighttp, if you changed this, change the user:group to the lighttp user:group)
+
 
+
=== DokuWiki Specific lighttp Configuration ===
+
 
+
Edit the /etc/lighthttpd/lighttpd.conf file
+
  
 
Under the line:
 
Under the line:
<pre>
+
{{bc|1=
 
$HTTP["url"] =~ "\.pdf$" {
 
$HTTP["url"] =~ "\.pdf$" {
 
   server.range-requests = "disable"
 
   server.range-requests = "disable"
 
}
 
}
</pre>
+
}}
  
 
add this:  
 
add this:  
<pre>
+
{{bc|1=
 
# subdir of dokuwiki
 
# subdir of dokuwiki
 
# comprised of the subdir of the root dir where dokuwiki is installed
 
# comprised of the subdir of the root dir where dokuwiki is installed
Line 111: Line 84:
 
$HTTP["url"] =~ "^" + var.dokudir + "/inc/"  { url.access-deny = ( "" ) }
 
$HTTP["url"] =~ "^" + var.dokudir + "/inc/"  { url.access-deny = ( "" ) }
 
$HTTP["url"] =~ "^" + var.dokudir + "/conf/" { url.access-deny = ( "" ) }
 
$HTTP["url"] =~ "^" + var.dokudir + "/conf/" { url.access-deny = ( "" ) }
</pre>
+
}}
  
''These entries give some basic security to docuwiki.'' lighttpd does not use .htaccess files like apache. You CAN install with out this, but I would NEVER recommend it.  
+
''These entries give some basic security to DokuWiki.'' lighttpd does not use .htaccess files like Apache. You CAN install with out this, but I would NEVER recommend it.
  
For further (possibly updated) configuration, please see the [http://wiki.splitbrain.org/wiki:install:lighttpd DokuWiki lighttpd install guide]
+
{{bc|1=
 +
alias.url += ("/dokuwiki" => "/usr/share/webapps/dokuwiki/")
 +
}}
 +
Add alias somewhere in lighttpd or fastcgi conf file
  
=== Restart lighttp ===
+
Restart lighttp:
Start your webserver
+
   # /etc/rc.d/lighttpd restart
   #/etc/rc.d/lighttpd start
+
 
+
=== Install DokuWiki ===
+
Open a webbrowser to
+
  http://127.0.0.1/dokuwiki/install.php
+
  
 
== Post Installation ==
 
== Post Installation ==
 
=== Cleaning Up ===
 
=== Cleaning Up ===
 
'''After configuring the server remove the install.php file!'''
 
'''After configuring the server remove the install.php file!'''
   #rm install.php
+
   # rm /srv/http/dokuwiki/install.php
  
 
=== Installing Plugins ===
 
=== Installing Plugins ===
 +
Many community created plugins can be found [http://www.dokuwiki.org/plugins here]
  
Many community created plugins can be found [http://wiki.splitbrain.org/wiki:plugins here]
+
They can be added through the web interface (as well as updated) through the Admin menu. Some plugins cannot be downloaded, if they go over ssl (e.g. git). Uncomment following line in {{ic|/etc/php/php.ini}}:
 
+
{{bc|1=
They can be added through the web interface (as well as updated) through the Admin menu.
+
extension=openssl.so
 +
}}
  
 
=== Backing Up ===
 
=== Backing Up ===
Line 145: Line 118:
 
== Further Reading ==
 
== Further Reading ==
  
The DokuWiki [http://www.dokuwiki.org/ main site] has all of the information and help that you could possibly need.
+
The [http://www.dokuwiki.org/ DokuWiki main site] has all of the information and help that you could possibly need.
 +
 
 +
== See Also ==
 +
[http://wiki.gotux.net/config:dokuwiki DokuWiki HowTo Install and Upgrade]

Revision as of 09:31, 15 February 2013

"DokuWiki is a standards-compliant, simple-to-use wiki which allows users to create rich documentation repositories. It provides an environment for individuals, teams and companies to create and collaborate using a simple yet powerful syntax that ensures data files remain structured and readable outside the wiki."

"Unlimited page revisions allows restoration to any earlier page version, and with data stored in plain text files, no database is required. A powerful plugin architecture allows for extension and enhancement of the core system. See the features section for a full description of what DokuWiki has to offer."[1]

In other words, DokuWiki is a wiki written in PHP and requires no database.

Like to see a running example?

Initial Notes

DokuWiki should work on any web server which supports PHP 5.1.2 or later. As the requirements may change over time, you should consult the requirements page for DokuWiki for additional details.

It is strongly recommend to read through the appropriate sections of DokuWiki's security page for your web server. Most popular web servers are covered but there are generic instructions as well.

The package in [community] unpacks DokuWiki at /srv/http/dokuwiki and changes ownership to the "http" user. This should work fine for most popular web servers as packaged for Arch.

Installation

  1. Install your web server of choice (e.g. Apache or lighttpd) and configure it for PHP. As mentioned above, DokuWiki has no need for a database server so you may be able to skip those steps when setting up your web server.
  2. Install dokuwiki from [community] with pacman.
  3. Configure web server for dokuwiki (see section below)
  4. With your web browser of choice, open http://<your-server>/dokuwiki/install.php and continue the installation from there.

Alternatively, if you would like to install from tarball, you can read from http://www.dokuwiki.org/Install. Generally the procedure is the same as above. Instead of using pacman, you will need to download the tarball, unpack it to your server's document root (e.g. /srv/http/dokuwiki), and chown to the appropriate user (e.g. "http").

Configuration

Apache

Firstly, create the file /etc/httpd/conf/extra/dokuwiki.conf with the following contents:

Alias /dokuwiki /usr/share/webapps/dokuwiki
<Directory /usr/share/webapps/dokuwiki/>
    Options +FollowSymLinks
    AllowOverride All
    order allow,deny
    allow from all
    php_admin_value open_basedir "/srv/http/:/home/:/tmp/:/usr/share/pear/:/usr/share/webapps/:/etc/webapps/dokuwiki/:/var/lib/dokuwiki/"
</Directory>

Include the newly created file in the Apache configuration by placing the following line at the end of /etc/httpd/conf/httpd.conf:

Include conf/extra/dokuwiki.conf

Make sure the folders /etc/webapps/dokuwiki and /var/lib/dokuwiki are owned by user and group "http". You may relocate these directories if you like as long as you update the references in /etc/httpd/conf/extra/dokuwiki.conf respectively.

Afterwards restart Apache:

 # systemctl restart httpd.service

Then finish the installation by running the dokuwiki/install.php script in your browser.

lighttpd Specific Configuration

Edit the /etc/lighttpd/lighttpd.conf file as per the dokuwiki instructions (might contain updated information).

Under the line:

$HTTP["url"] =~ "\.pdf$" {
  server.range-requests = "disable"
}

add this:

# subdir of dokuwiki
# comprised of the subdir of the root dir where dokuwiki is installed
# in this case the root dir is the basedir plus /htdocs/
# Note: be careful with trailing slashes when uniting strings.
# all content on this example server is served from htdocs/ up.
#var.dokudir = var.basedir + "/dokuwiki"
var.dokudir = server.document-root + "/dokuwiki"

# make sure those are always served through fastcgi and never as static files
# deny access completly to these
$HTTP["url"] =~ "/\.ht" { url.access-deny = ( "" ) }
$HTTP["url"] =~ "/_ht" { url.access-deny = ( "" ) }
$HTTP["url"] =~ "^" + var.dokudir + "/bin/"  { url.access-deny = ( "" ) }
$HTTP["url"] =~ "^" + var.dokudir + "/data/" { url.access-deny = ( "" ) }
$HTTP["url"] =~ "^" + var.dokudir + "/inc/"  { url.access-deny = ( "" ) }
$HTTP["url"] =~ "^" + var.dokudir + "/conf/" { url.access-deny = ( "" ) }

These entries give some basic security to DokuWiki. lighttpd does not use .htaccess files like Apache. You CAN install with out this, but I would NEVER recommend it.

alias.url += ("/dokuwiki" => "/usr/share/webapps/dokuwiki/")

Add alias somewhere in lighttpd or fastcgi conf file

Restart lighttp:

 # /etc/rc.d/lighttpd restart

Post Installation

Cleaning Up

After configuring the server remove the install.php file!

 # rm /srv/http/dokuwiki/install.php

Installing Plugins

Many community created plugins can be found here

They can be added through the web interface (as well as updated) through the Admin menu. Some plugins cannot be downloaded, if they go over ssl (e.g. git). Uncomment following line in /etc/php/php.ini:

extension=openssl.so

Backing Up

It is very trivial to backup DokuWiki, since there is no database. All pages are in plain text, and require only a simple tar, or rsync.

A quick breakdown of the directories of interest in the current (2008-05-05) version:

 /dokuwiki/data/  =>  All User Created Data
 /dokuwiki/lib/plugins/  =>  All User Added Plugins

Further Reading

The DokuWiki main site has all of the information and help that you could possibly need.

See Also

DokuWiki HowTo Install and Upgrade