← Back to branch summary

~ubuntu-branches/ubuntu/karmic/dokuwiki/karmic

« back to all changes in this revision

Viewing changes to debian/README.Debian

  • Committer: Bazaar Package Importer
  • Author(s): Mohammed Adnène Trojette
  • Date: 2007-03-29 19:44:52 UTC
  • mfrom: (2.1.6 feisty)
  • Revision ID: james.westby@ubuntu.com-20070329194452-8r2w798oo21ago6l
Tags: 0.0.20061106-6
http://bugs.debian.org/416509
http://bugs.debian.org/387974
* High-urgency upload for fixing RC bug.
* Make fr.po's translation of "global" consistent. (Closes: #416509)
* Remove /etc/apache*/conf.d/ on purge. (Closes: #387974)

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/README.Debian
1
1
DokuWiki for Debian
2
2
-------------------
3
3
 
 
4
The directory structure of DokuWiki's data tree has changed such that
 
5
the new location for the pages (*.txt) is
 
6
/var/lib/dokuwiki/data/pages. Additionally the 'attic' and 'media'
 
7
directories have moved from /var/lib/dokuwiki/ to
 
8
/var/lib/dokuwiki/data/.
 
9
 
 
10
The support for access control has also been improved. The default
 
11
location for the user database files 'acl.auth.php' and
 
12
'users.auth.php' at /etc/dokuwiki does not allow the files to be
 
13
writable for the web server. For this reason the files are located at
 
14
/var/lib/dokuwiki/acl/. Access control can be turned on in the
 
15
configuration file /etc/dokuwiki/dokuwiki.php by setting
 
16
$conf['useacl'] to '1'. By default, everyone is granted level 4 access
 
17
(see the DokuWiki guide at http://wiki.splitbrain.org/).
 
18
 
 
19
 -- Matti Pöllä <mpo@iki.fi>, Tue, 05 Jul 2005 11:50:17 +0300
 
20
 
4
21
The contents of the configuration files under conf/ in the upstream
5
22
source tree can be found in /etc/dokuwiki.
6
23
 
7
24
 -- Matti Pöllä <mpo@iki.fi>, Mon, 04 Apr 2005 08:37:19 +0200
 
25
 
 
26
A few tips for Debian's DokuWiki (last update for dokuwiki 2005-02-18a)
 
27
--------------------------------
 
28
 
 
29
(courtesy from Frédéric Lehobey)
 
30
 
 
31
Q: How to handle a local configuration file?
 
32
A: Create a file /etc/dokuwiki/local.php where you put all your
 
33
preferred values for the configuration variables like:
 
34
 
 
35
<?
 
36
$conf['superuser'] = '@admin';
 
37
?>
 
38
 
 
39
(this gives to the 'admin' group the dokuwiki superuser power).  Do
 
40
not leave any empty line at the end of this file.
 
41
 
 
42
Q: How can I select my language for dokuwiki?
 
43
A: Put your language in 'lang' variable like with adding the following
 
44
line to /etc/dokuwiki/local.php:
 
45
 
 
46
$conf['lang'] = 'fr';
 
47
 
 
48
(available languages may by found in /usr/share/dokuwiki/lang).
 
49
 
 
50
Q: How to enable ACL?
 
51
A: For the 'plain' authentication type, chosen by the (default)
 
52
 
 
53
$conf['authtype'] = 'plain';
 
54
 
 
55
variable, ACL is enabled by the
 
56
 
 
57
$conf['useacl'] = 1;
 
58
 
 
59
variable.
 
60
 
 
61
This authentication is ruled by the /etc/dokuwiki/acl.auth, and
 
62
/etc/dokuwiki/users.auth files.  You have templates of them in
 
63
/etc/dokuwiki/ with a .dist suffix appended.
 
64
 
 
65
Notice, that if you want to allow users to register themselves, as
 
66
 
 
67
$conf['openregister']= 1;
 
68
 
 
69
is enabled by default you must have /etc/dokuwiki/users.auth writable
 
70
by the web server.  If you are using apache or apache2 with Debian a
 
71
 
 
72
# chown www-data /etc/dokuwiki/users.auth
 
73
 
 
74
should do the trick.
 
75
 
 
76
Notice also clear text emails are sent by dokuwiki containing the
 
77
password (used in clear text later anyways).  The dokuwiki email
 
78
sender is (optionally) set by the
 
79
 
 
80
$conf['mailfrom'] = 'your.email@example.foo';
 
81
 
 
82
variable (empty default).  Remember that on a standard Debian
 
83
installation, exim4 requires rewriting of the email sender through the
 
84
/etc/email-addresses mechanism which would allow dokuwiki issued mail
 
85
to go outside only with some
 
86
 
 
87
www-data: relevant.email@example.foo
 
88
 
 
89
entry in /etc/email-addresses system configuration file.
 
90
 
 
91
Finally notice that the (editable) /etc/dokuwiki.users text file
 
92
expects fields in the following order:
 
93
 
 
94
user:MD5password:Real Name:email@example.foo:groups,comma,separated
 
95
 
 
96
groups being listed _without_ the usual leading '@' for groups.
 
97
 
 
98
The default group for new users is chosen by
 
99
 
 
100
$conf['defaultgroup']= 'user';
 
101
 
 
102
The 'md5sum.textutils --string=password' command (from coreutils
 
103
package) may be useful.
 
104
 
 
105
Q: What do I have to save when moving (or backuping) dokuwiki
 
106
somewhere else?
 
107
A: According to the online documentation the files (or directories) to
 
108
be saved are:
 
109
 
 
110
  /var/lib/dokuwiki/attic/, /var/lib/dokuwiki/changes.log,
 
111
  /var/lib/dokuwiki/data, /var/lib/dokuwiki/media, and (if any)
 
112
  /etc/dokuwiki/local.php
 
113
 
 
114
and, for ACL, /etc/dokuwiki/acl.auth and /etc/dokuwiki/users.auth
 
115
should also be preserved.
 
116
 
 
117
In case of inconsistencies, .cache directories in data and media, may
 
118
have to be cleared (maybe also your browser ones).
 
119
 
 
120
Stylesheet Loading
 
121
------------------
 
122
 
 
123
It is possible to customise the default stylesheet by creating a CSS
 
124
file in /etc/dokuwiki:
 
125
 
 
126
 - userstyle.css makes your changes available in screen mode.
 
127
 - userprint.css makes your changes available in print mode. 
 
128
 
 
129
More information is available at
 
130
<http://wiki.splitbrain.org/wiki:devel:css#stylesheet_loading>.