Show last authors
1 1 Configuration
2
3 One you have XWiki [installed>Installation] you'll want to configure it. Configuration can be done in 2 ways:
4
5 * by stopping the XWiki instance and editing the ~~xwiki/WEB-INF/xwiki.cfg~~ file, and then restarting XWiki
6 * by logging in as a user with admin rights and going to the Administration page (when using the XWiki 1.0 skin, there's a an "Administration" link in the top right corner of the screen - You can also go directly to ~~http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences~~). This allows to keep the Server running while making the changes.
7
8 Note that some configurations are only accessible from the ~~xwiki.cfg~~ file and have no equivalent on the Administration page.
9
10 There are various things you can configure:
11
12 #toc("" "" "")
13
14 1.1 Enable superadmin account
15
16 Edit the <tt>xwiki.cfg</tt> file and enable the <tt>xwiki.superadminpassword</tt> property. For example:
17
18 {code:none}
19 # Enable to allow superadmin. It is disabled by default as this could be a security breach if
20 # it were set and you forgot about it.
21 xwiki.superadminpassword=system
22 {code}
23
24 When logging in, the username will be "superadmin" and the password will be the one you set in the <tt>xwiki.superadminpassword</tt> property.
25
26 1.1 Language settings
27
28 To define the default language for your wiki go to the Administration page and in the Preferences tag locate the "Default Language" field and enter the language code for the language you wish to use. For example: "en" for English, "fr" for French, "de" for German, etc.
29
30 In addition you can configure you wiki to be multilingual. See the [I18 user page>Features.I18N] for more information.
31
32 1.1 Wiki Access Configuration
33
34 The first thing you will want to do is configure a policy access for your wiki. Depending on what you intend to use your wiki for, you have several options:
35
36 * [Open Wiki>#HOpenWiki]: anyone can edit pages (including non registered users)
37 * [Public Wiki>#HPublicWiki]: only registered users can edit pages but registration is open to anyone. This is the default configuration of the default wiki (the wiki provided as a XAR on the [download page>xwiki:Main.Download]).
38 * [Private Wiki with password>#HPrivateWikiwithpassword]: registration is closed
39 * [Private Wiki with token for registering>#HPrivateWikiwithtoken]: registration is closed but users knowing the token can register
40
41 1.1.1 Open Wiki
42
43 TODO
44
45 1.1.1 Public Wiki
46
47 TODO
48
49 1.1.1 Private Wiki with password
50 1.1.1.1 Global rights
51
52 In [Global rights>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences?editor=globalrights&global=1] set *User:XWikiGuest, Groups:, Level:register, Allow-Deny:Allow*.
53
54 1.1.1.1 Registration
55
56 In [Preferences>http://localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences] under *Registration* set *Use email verification:yes*. fill the other fields appropriately.
57
58 1.1.1 Private Wiki with token
59
60 TODO
61
62
63 1.1 Enabling/Disabling Statistics
64
65 To disable [the Statistics feature>code:Applications.StatisticsApplication], edit your ~~xwiki.cfg~~ file and replace the following properties as shown here:
66 {code:xml}
67 xwiki.stats=0
68 xwiki.stats.default=0
69 {code}
70
71 where:
72
73 * ~~xwiki.stats~~ controls whether Statistics are on or off
74 * ~~xwiki.stats.default~~ controls whether Statistics are on or off by default for the current Wiki. This is useful in [Virtual Wiki mode>AdminGuide.Virtualization]. A wiki can decide whether Statistics is on/off by setting the "statistics" field in XWiki.XWikiPreferences. If no such field is defined the the default value ~~xwiki.stats.default~~ is used.
75
76 To enable Statistics, change "0" to "1".
77
78 1.1 Optional Store Features
79
80 XWiki stores all document attachment versions by default. This is very memory consuming (both RAM and HDD).
81 If you need only latest versions of attachments, you can disable attachment version control by editing your ~~xwiki.cfg~~ and adding:
82 {code:xml}
83 xwiki.store.attachment.versioning=0
84 {code}
85
86
87 1.1 Customizing the Skin
88
89 See the [Skin Guide>AdminGuide.Skins].
90
91 1.1 Security configuration
92
93 See the [Security Guide>AdminGuide.Security].
94
95 1.1 Customizing Menus
96
97 The first thing to understand is that menus depend on the skin you're using. If you're using the 1.0 skin it's likely you're using the [Panels Application>code:Applications.PanelsApplication] to provide the different menu panels you see on the left or right of your wikis. Check the [Panels Application>code:Applications.PanelsApplication] to know more on how to configure/modify them.
98
99 1.1 Encoding
100
101 See the [Encoding Guide>AdminGuide.Encoding].
102
103 1.1 User Authentication
104
105 See the [Authentication Guide>AdminGuide.Authentication].
106
107 1.1 Customizing the registration page
108
109 The default registration page is defined as a template on the file system (named <tt>registerinline.vm</tt>). However it's possible to easily override it by creating a page named <tt>XWiki.Registration</tt>.
110
111 1.1 Logging
112
113 See the [Logging page>Logging].
114
115 1.1 Configuring Interwiki links
116
117 [Interwiki linking>http://en.wikipedia.org/wiki/InterWiki] is a short hand syntax for linking to pages on other websites. For example, you could link to http://en.wikipedia.org/wiki/InterWiki just by typing \[InterWiki@WikiPedia\].
118
119 Since XWiki renders wiki syntax using the [Radeox>http://radeox.org] engine, it supports Interwiki links in [much the same way as SnipSnap>http://snipsnap.org/space/InterWiki+HowTo].
120
121 To configure Interwiki links on your wiki:
122
123 * Create a file named <tt>\[location from where you start your container\]/conf/*intermap.txt*</tt>
124 * Fill <tt>intermap.txt</tt> with content like:
125 {code}
126 IMDB http://us.imdb.com/Title?
127 OpenWiki http://openwiki.com/?
128 SourceForge http://sourceforge.net/
129 TWiki http://twiki.org/cgi-bin/view/
130 Why http://clublet.com/c/c/why?
131 Wiki http://c2.com/cgi/wiki?
132 WikiPedia http://www.wikipedia.com/wiki/
133 {code}
134
135 You can of course add your own entries.
136
137 * Note that Radeox's parser for intermap.txt is [very fragile>http://snipforge.org/jira/browse/RADEOX-49]. A blank line at the bottom of the file is enough to make it fall over.
138 * Restart XWiki (you'll need to restart XWiki every time you change <tt>intermap.txt</tt>) and try out an Interwiki link.
139 * If it does not work, check your <tt>xwiki.log</tt> file. You'll see if <tt>conf/intermap.txt</tt> could not be found, or if there was an error parsing it.
140
141 1.1 Setting the default editor to use (Wiki or WYSIWYG)
142
143 Go the Administration screen, then click on the "General" icon and select the default editor to use, as shown on the following screenshot:
144
145 {image:defaulteditor.png}
146
147 1.1 Short URLs
148
149 It's possible to [configure XWiki so that is uses shorter URLs>Main.ShortURLs].
150
151 1.1 Configure the names of database schemas (since 1.6M1).
152
153 Sometimes, especially in enterprise environment, we need control names of database schemes, other than default.
154
155 * xwiki.db -- name of database scheme of main wiki.
156 * xwiki.db.prefix -- usefull mainly for [virtual wikies>Virtualization], where we have database scheme for each virtual wiki. This prefix is added to database scheme name after usual mapping between wiki names and schemes.
157
158 1.1 Turning off comments or attachments
159
160 You need to change the XWiki.XWikiPreferences class like this:
161
162 * Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=class</tt>
163 * Add a new property called <tt>showcomments</tt> (or <tt>showattachments</tt> for turning off attachments) of type String Class
164 * Go to <tt>\<server\>/xwiki/bin/edit/XWiki/XWikiPreferences?editor=object&classname=XWiki.XWikiPreferences</tt> and write no in the <tt>showcomments</tt> (or <tt>showattachments</tt>) field
165
166 That's it, the comments (or attachments) are gone. If you want to re-enable them, replace the "no" value with "yes".
167
168 1.1 Configure edit comment behavior
169
170 When page editing you can add a comment of changes in special comment field by default (Look at [Features.PageEditing#HCommoneditactions]).
171 You can disable this feature by set ~~xwiki.editcomment=0~~ in ~~xwiki.cfg~~.
172
173 When edit comment feature is enabled, you also can set edit comment mandatory by set ~~xwiki.editcomment.mandatory=1~~ in ~~xwiki.cfg~~. This will show popup window with the request to set edit comment if there is no comment entered. It doesn't allow to set empty comment.
174 If you want a popup, but want to be able to set empty edit comment, set ~~xwiki.editcomment.suggested=1~~ in ~~xwiki.cfg~~
175
176 If you set edit comment as mandatory or suggested, you can also remove comment field from page editing form and use only popup window for set edit comment. Set ~~xwiki.editcomment.hidden=0~~ in ~~xwiki.cfg~~ to do this.
177
178 You can use the special fields in ~~XWikiPreferences~~ object instead of edit ~~xwiki.cfg~~.
179 These fields are: ~~editcomment~~, ~~editcomment_mandatory~~, ~~editcomment_suggested~~ and ~~editcomment_hidden~~.
180
181 1.1 Configuring the SMTP server
182
183 If you're planning to use XWiki's feature that send emails you'll need to configure the SMTP server used and the email address under which XWiki will send emails.
184
185 To configure these go to the Administration page (<tt>http://\<server\>/xwiki/bin/admin/XWiki/XWikiPreferences</tt>), click on the "general" icon and modify the <tt>Admin email</tt> field to set the email under which XWiki emails will be sent and modify the <tt>Outgoing SMTP Server</tt> field to set the SMTP server to use, as shown on the figure below.
186
187 {image:emailconfiguration.png}
188
189 #warning("Now xwiki can't configure password for SMTP user. Hence, you should use a SMTP server without password Authentication.")
190
191 1.1 Redirections
192
193 XWiki supports defining redirections for incoming requests. To activate this feature modify your <tt>xwiki.cfg</tt> file and set the following property:
194 {code:none}
195 xwiki.preferences.redirect=1
196 {code}
197
198 Then for each redirection you want to add, add a <tt>XWiki.GlobalRedirect</tt> object to your main wiki's <tt>XWiki.XWikiPreferences</tt> document. The <tt>XWiki.GlobalRedirect</tt> object has 2 fields: <tt>pattern</tt> and <tt>destination</tt>. The URL received is matched on <tt>pattern</tt> and if there's a match it's replaced with the value from <tt>destination</tt>. XWiki then redirects to the new URL.
199
200 1.1 Customizing the PDF export Look & Feel
201
202 TODO: Explain the pdftemplate parameter + the XWiki.PDFClass class.
203 {image:XWikiExport200805192259.png}
204
205
206 1.1 Sample xwiki.cfg
207
208 {code}
209 xwiki.version=1.1-SNAPSHOT
210 xwiki.base=../../
211 xwiki.store.class=com.xpn.xwiki.store.XWikiHibernateStore
212 xwiki.store.hibernate.path=/WEB-INF/hibernate.cfg.xml
213 xwiki.store.hibernate.updateschema=1
214 xwiki.store.hibernate.custommapping=1
215
216 \#\# Jcr Store configuration
217 \#xwiki.store.class=com.xpn.xwiki.store.jcr.XWikiJcrStore
218 \#xwiki.store.attachment.class=com.xpn.xwiki.store.jcr.XWikiJcrAttachmentStore
219 \#xwiki.store.versioning.class=com.xpn.xwiki.store.jcr.XWikiJcrPropertyVersioningStore
220 \#xwiki.store.jcr.mapping=WEB-INF/classes/jcrmapping.xml
221 \#xwiki.store.jcr.provider=com.xpn.xwiki.store.jcr.JackRabbitJCRProvider
222 \#xwiki.store.jcr.jackrabbit.repository.config=WEB-INF/classes/jackrabbit/repository.xml
223 \#xwiki.store.jcr.jackrabbit.repository.path=jackrabbitrepo
224 \#xwiki.store.jcr.jackrabbit.nodetypes.config=WEB-INF/classes/jackrabbit/nodetypes.cnd
225
226 xwiki.store.cache=1
227 xwiki.store.cache.capacity=100
228 xwiki.monitor=1
229
230 \# List of active plugins.
231 xwiki.plugins=com.xpn.xwiki.monitor.api.MonitorPlugin,\\
232 com.xpn.xwiki.plugin.calendar.CalendarPlugin,\\
233 com.xpn.xwiki.plugin.feed.FeedPlugin,\\
234 com.xpn.xwiki.plugin.ldap.LDAPPlugin,\\
235 com.xpn.xwiki.plugin.google.GooglePlugin,\\
236 com.xpn.xwiki.plugin.flickr.FlickrPlugin,\\
237 com.xpn.xwiki.plugin.mail.MailPlugin,\\
238 com.xpn.xwiki.plugin.packaging.PackagePlugin,\\
239 com.xpn.xwiki.plugin.query.QueryPlugin,\\
240 com.xpn.xwiki.plugin.svg.SVGPlugin,\\
241 com.xpn.xwiki.plugin.charts.ChartingPlugin,\\
242 com.xpn.xwiki.plugin.fileupload.FileUploadPlugin,\\
243 com.xpn.xwiki.plugin.image.ImagePlugin,\\
244 com.xpn.xwiki.plugin.captcha.CaptchaPlugin,\\
245 com.xpn.xwiki.plugin.userdirectory.UserDirectoryPlugin,\\
246 com.xpn.xwiki.plugin.usertools.XWikiUserManagementToolsImpl,\\
247 com.xpn.xwiki.plugin.zipexplorer.ZipExplorerPlugin,\\
248 com.xpn.xwiki.plugin.autotag.AutoTagPlugin
249
250 \# This parameter allows XWiki to operate in Hosting mode
251 \# allowing to create multiple wikis having their own database
252 \# and responding to different URLs
253 xwiki.virtual=0
254 xwiki.virtual.redirect=http://127.0.0.1:9080/xwiki/bin/Main/ThisWikiDoesNotExist
255
256 \# This parameter will activate the exo integration
257 xwiki.exo=0
258
259 xwiki.authentication=form
260 xwiki.authentication.validationKey=totototototototototototototototo
261 xwiki.authentication.encryptionKey=titititititititititititititititi
262 xwiki.authentication.cookiedomains=xwiki.com,wiki.fr
263 \# Comment if you want to enable logout only for /bin/logout/XWiki/XWikiLogout
264 xwiki.authentication.logoutpage=/[^/]+/logout/*
265
266 \# Stats configuration allows to globally activate/deactivate stats module
267 \# it is also possible to choose a different stats service to record
268 \# statistics separately from XWiki.
269 \# Note: Statistics are disabled by default for improved performances.
270 xwiki.stats=0
271 xwiki.stats.default=1
272 xwiki.stats.class=com.xpn.xwiki.stats.impl.XWikiStatsServiceImpl
273
274 xwiki.encoding=ISO-8859-1
275 xwiki.render.macromapping=1
276 xwiki.backlinks=1
277 xwiki.tags=1
278
279 \#\# Use edit comments
280 xwiki.editcomment=1
281 \#\# Hide editcomment field and only use JS
282 xwiki.editcomment.hidden=0
283 \#\# Make edit comment mandatory
284 xwiki.editcomment.mandatory=0
285 \#\# Make edit comment suggested (asks 1 time if the comment is empty. 1 shows one popup if comment
286 \#\# is empty. 0 means there is no popup. This setting is ignored is mandatory is set)
287 xwiki.editcomment.suggested=0
288
289 \# GraphViz plugin configuration. The GraphViz plugin is not configured by default.
290 \# To enable it, add "com.xpn.xwiki.plugin.graphviz.GraphVizPlugin" to the list of plugins
291 \# in the xwiki.plugins property.
292 \# Uncomment and set the locations of the Dot and Neato executables
293 \#xwiki.plugin.graphviz.dotpath=c:/Program Files/ATT/GraphViz/bin/dot.exe
294 \#xwiki.plugin.graphviz.neatopath=c:/Program Files/ATT/GraphViz/bin/neato.exe
295
296 xwiki.plugin.laszlo.baseurl=/openlaszlo/xwiki/
297 xwiki.plugin.laszlo.path=c:/Program Files/Apache Software Foundation/Tomcat 5.0/webapps/openlaszlo/xwiki/
298
299 xwiki.plugin.image.cache.capacity=30
300
301 xwiki.plugin.captcha=1
302
303 \#\# Personal config
304
305 \# Enable to allow superadmin. It is disabled by default as this could be a security breach if
306 \# it were set and you forgot about it.
307 \#xwiki.superadminpassword=system
308
309 xwiki.authentication.ldap=0
310 xwiki.authentication.ldap.server=172.29.116.202
311 xwiki.authentication.ldap.check_level=1
312 xwiki.authentication.ldap.port=389
313 xwiki.authentication.ldap.base_DN=dc=necf,dc=fr
314 xwiki.authentication.ldap.bind_DN=cn={0},cn=Users,dc=necf,dc=fr
315 xwiki.authentication.ldap.bind_pass={1}
316 xwiki.authentication.ldap.UID_attr=sAMAccountName
317 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,email=mail,ldap_dn=dn
318
319 xwiki.authentication.unauthorized_code=200
320
321 \# This parameter will activate the sectional editing
322 xwiki.section.edit=1
323
324 \# Uncomment if you want to ignore requests for unmapped actions, and simply display the document
325 \# xwiki.unknownActionResponse=view
326
327 \#\# WYSIWYG Editor configuration
328
329 \# You can configure the toolbars you wish to see in the WYSIWYG editor by defining the
330 \# xwiki.wysiwyg.toolbars property.
331 \# When not defined it defaults to:
332 \# xwiki.wysiwyg.toolbars=texttoolbar, listtoolbar, indenttoolbar, undotoolbar, titletoolbar, \
333 \# styletoolbar, horizontaltoolbar, attachmenttoolbar, macrostoolbar, \
334 \# tabletoolbar, tablerowtoolbar, tablecoltoolbar, linktoolbar
335 \# The full list of toolbars includes the one defined above and the following ones:
336 \# subtoolbar, findtoolbar, symboltoolbar
337
338 \#\# Skin configuration
339
340 xwiki.defaultskin=albatross
341 xwiki.defaultbaseskin=albatross
342
343 {code}

Get Connected