====== Configuration Setting: title ====== This is the name of your Wiki installation. Change it to whatever you like. If you want to run multiple installations of [[:DokuWiki]] on the same server they need to have different titles! * Type: String * Default: ''DokuWiki'' Note: If you have an ampersand (&) in your title, you should write it as ''&''. ===== See also ===== * [[config:|Configuring DokuWiki]] ---- ====== Configuration Setting: start ====== This is the name of the default page in each [[:namespace]] (including the root namespace,) which is loaded when no page name is given. It should be a valid [[:pagename]] and never contain a namespace. Also known as "The Homepage" ;-). * Type: String * Default: ''start'' //Note://\\ //This page is named startpage to avoid confusion with start page of the config namespace. The option is just named ''start''.// ===== See also ===== * [[config:|Configuring DokuWiki]] * [[:Namespaces]] ---- ====== Configuration Setting: lang ====== This sets the language of the interface. If you selected your language in the [[:installer]] this option will be preset correctly for you. * Type: String * Default: ''en'' ===== See also ===== * [[config:|Configuring DokuWiki]] * [[:Localization]] ---- ====== Configuration Setting: template ====== The name of the template (aka. skin) used by your [[:DokuWiki]] installation. * Type: String * Default: ''default'' Note: after changing the template, your styles may look broken. To fix this, force your browser to refresh its cache (eg. hit Shift-F5). ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[:Templates]] ---- ====== Configuration Setting: license ====== [[devel:develonly]] This setting configures the license under which the content of your wiki can be distributed. The licenses you can choose in this setting are configured in the ''conf/license.php''. By default it contains a list of [[http://www.creativecommons.org|Creative Commons]] licenses. * Type: String * Default: ''cc-by-nc-sa'' You should think a bit about the proper license when you start your wiki, because changing it later may require the consent of all previous contributors to your wiki. ===== Adding a new license ===== To avoid problems on upgrading your Wiki later you shold not edit the ''conf/license.php'' file directly but create a new ''conf/license.local.php'' file to add your entries. The file should look like this: 'Full Name of the License', 'url' => 'http://example.com/license', ); ''license'' is the short name of the chosen license as it is used in the config setting mentioned above. For each license an image named like the short name (ending in ''.gif'' or ''.png'' should be placed in ''lib/images/license/button'' (80x15 pixel) and ''lib/images/license/badge'' (88x31 pixel). ===== See also ===== * [[:config:|Configuring DokuWiki]] ---- ====== Configuration Setting: savedir ====== This is the path where all files will be stored. This is a filesystem path relative to the basedir specified below. It needs to be writable by the webserver. * Type: String * Default: ''./data'' Inside this directory are multiple subdirectories and the changelog. You can override their position by the following config parameters((not available within the Config Manager)): ^ Parameter ^ default inside savedir ^ | datadir | pages | | olddir | attic | | mediadir | media | | cachedir | cache | | lockdir | locks | | changelog | changes.log | | metadir | meta | | indexdir | index | | tmpdir | tmp | ===== See also ===== * [[:config:|Configuring DokuWiki]] ---- ====== Configuration Setting: basedir ====== Usually DokuWiki can detect the directory that it is installed in on its own. But sometimes this does not work for various reasons. If DokuWiki does not seem to function properly and cannot find things such as images for its web pages, you can set the directory here. The path you should set here, is the path from the server root to your DokuWiki installation. Eg. if your wiki is available at ''%%http://www.yourserver.com/dokuwiki/%%'' you should set basedir to ''/dokuwiki/''. Be sure to have a leading and a trailing slash! * Type: String * Default: ''/'' ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[config:baseurl]] ---- ====== Configuration Setting: baseurl ====== URL to server including protocol - blank for autodetect The path you should set here, is the path of server root. Eg. if your wiki is available at ''%%http://www.yourserver.com:port/dokuwiki/%%'' you should set baseurl to ''%%http://www.yourserver.com:port%%'', ending without slash. * Type: String * Default: '''' //Note: The ':port' portion is relevant only if the web server is running on a non-standard port (i.e. not port 80). You can omit that portion if you are running on the standard port.// ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[config:basedir]] ---- ====== Configuration Setting: dmode ====== This option sets the permissions you want your directories to be created with. What you set here is the mode to set on your directories in octal (not a string, but a number always starting with 0). The default creates directories with unix permissions of ''0755'' (''rwxr-xr-x'') * Type: Number * Default: ''0777'' This setting has no effect on Windows servers. ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[config:fmode]] * [[install:Permissions]] * [[:Security]] ---- ====== Configuration Setting: fmode ====== This option sets the permissions you want your files to be created with. What you set here is the mode to set on your files in octal (not a string, but a number always starting with 0). The default creates files with unix permissions of ''0644'' (''rw-r--r--''). * Type: Number * Default: ''0666'' This setting has no effect on Windows servers. The first non-zero digit (6 in the default above) determines the //user// permissions (ie. permissions of the file owner), second non-zero digit is the //group// permissions and the last digit is permissions for //other// (ie. everyone else). To convert permissions into the correct number, use the following key: * Read=4 * Write=2 * Execute=1 and sum the result for each one of the above groups. Thus, if you want read and write permissions for the user owning the files, specify 4+2=6 as the first non-zero digit. If you would want read and execute permissions (appropriate eg. for directories) for the group that the file belongs to, specify 4+1=5 as the second non-zero digit. The default permission value above is interpreted as read and write permissions for the ''user'' and only read permissions (number 4) for the ''group'' and ''others''. ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[config:dmode]] * [[install:Permissions]] * [[:Security]]. ---- ====== Configuration Setting: allowdebug ====== To make it simpler to answer support requests, DokuWiki can output a huge list of debug strings when requested. For that, enable the option and append ''"&do=debug"'', without the " characters, to the URL, as in ''%%http://example.com/dokuwiki/doku.php?id=playground&do=debug%%''. This is useful to troubleshoot all kind of configuration problems when setting up the Wiki for the first time. But it reveals a lot of info about the server DokuWiki is running on as well. :!: To be on the safe side you should disable this option and thus disabling the debug function right after your Wiki was set up successfully. * Type: Boolean * Default: ''0'' ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[:Security]] ---- ====== Configuration Setting: recent ====== Defines the number of documents per page to show in the [[:Recent changes]]; the default number items to return in XML [[:syndication]] of recent changes; and the number of items to return in XML [[:syndication]] of the list of documents. * Type: Number * Default: ''20'' ===== See also ===== * [[:config:|Configuring DokuWiki]] ---- ====== Configuration Setting: breadcrumbs ====== Defines the number of recently visited pages to show in the [[:breadcrumbs]] trail. Set to 0 to disable it. * Type: Number * Default: ''10'' ===== See also ===== * [[:config:|Configuring DokuWiki]] * [[:config:youarehere]] config option * [[:Breadcrumbs]] ----