### Windows Path Configuration Examples Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/exports/connect-internal-office-server Examples of homePath and profilePath settings for various Windows office installations. ```properties openoffice.profilePath=C:/Users/{user}/AppData/Roaming/openOffice.org/3 openoffice.homePath=C:/Program Files/OpenOffice.org 3 ``` ```properties openoffice.profilePath=C:/Users/{user}/AppData/Roaming/LibreOffice/3 openoffice.homePath=C:/Program Files/LibreOffice 3.4 ``` ```properties openoffice.profilePath=C:/Users/{user}/AppData/Roaming/openOffice.org/3 openoffice.homePath=C:/Program Files (x86)/OpenOffice.org 3 ``` ```properties openoffice.profilePath=C:/Users/{user}/AppData/Roaming/LibreOffice/3 openoffice.homePath=C:/Program Files (x86)/LibreOffice 3.4 ``` -------------------------------- ### NginX Configuration Example Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/NginX?rev1=4.2&rev2=5.1&viewer=changes A basic NginX configuration file setup for proxying requests to an XWiki backend. ```nginx user www-data; ``` -------------------------------- ### Export Parameter Examples Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/exports/export-page/html-customizations-url?viewer=code Examples of using specific URL parameters to control the export process. ```none http://server/xwiki/bin/export/Page?format=html&pages=PageName ``` ```none http://server/xwiki/bin/export/Page?format=html&name=packagename ``` ```none http://server/xwiki/bin/export/Page?format=html&pages=News.%25&excludes=OtherPage ``` -------------------------------- ### PDF Export URL Parameters Source: https://www.xwiki.org/xwiki/bin/view/documentation/xs/user/exports/export-page/pdf-customizations-url?xpage=print Examples of various URL parameters used to customize the PDF export output. ```text http://server/xwiki/bin/export/News/Announcements?format=pdf ``` ```text http://server/xwiki/bin/export/News/Announcements?format=pdf&pages=News.Announcements.WebHome&pages=News.Updates.WebHome ``` ```text http://server/xwiki/bin/export/News?format=pdf&pages=News.WebHome&includechilds=1 ``` ```text http://server/xwiki/bin/export/News?format=pdf&pages=News.WebHome&includechilds=2 ``` ```text http://server/xwiki/bin/export/News/Announcements?format=pdf&pages=News.Announcements.WebHome&includelinks=1 ``` ```text http://server/xwiki/bin/export/News/Announcements?format=pdf&pages=News.Announcements.WebHome&includelinks=2 ``` ```text http://server/xwiki/bin/export/News/Announcements?format=pdf&pagebreaks=1 ``` ```text http://server/xwiki/bin/export/News?format=pdf&comments=1 ``` ```text http://server/xwiki/bin/export/News?format=pdf&attachments=1 ``` -------------------------------- ### Sample xwiki.properties Configuration Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Configuration?rev=137.1&viewer=code Example configuration file showing core, rendering, cache, and OpenOffice settings. ```none # This is the new XWiki configuration file. In the future it'll replace the old # xwiki.cfg file. However right now it's only used by some XWiki components. # As time progresses more and more component will get their configurations from # this file. #------------------------------------------------------------------------------------- # Core #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies the default syntax to use when creating new documents. #-# Default value is xwiki/2.0. # core.defaultDocumentSyntax = xwiki/1.0 #------------------------------------------------------------------------------------- # Rendering #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely. #-# Valid values: #-# %w: wiki name #-# %s: space name #-# %p: page name #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage" #-# %t: page title #-# #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case #-# if the title cannot be retrieved for the document. #-# #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p". # rendering.linkLabelFormat = %p #-# [Since 2.0M3] #-# Overrides default macro categories (Each macro has a default category already defined, for example #-# "presentation" for the Table of Contents Macro). #-# #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category + #-# redefine the category for the Script Macro to be "My Other Category", you'd use: # rendering.macroCategories = toc:My Category # rendering.macroCategories = script:My Other Category #------------------------------------------------------------------------------------- # Cache #------------------------------------------------------------------------------------- #-# [Since 1.7M1] #-# The standard cache component implementation to use (can be local or distributed depending on the implementation). #-# The default standard cache implementation is JBoss Cache. # cache.defaultCache=jbosscache #-# [Since 1.7M1] #-# The local cache implementation to use. #-# The default local cache implementation is JBoss Cache. # cache.defaultLocalCache=jbosscache/local #---------------------------------------------------------------------------------- # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin #---------------------------------------------------------------------------------- #-# [Since 1.9M2] #-# Type of the openoffice server instance used by officeimporter plugin. #-# 0 - Internally managed server instance. (Default) #-# 1 - Externally managed (local) server instance. # openoffice.serverType=0 #-# [Since 1.9M2] #-# Port number used for connecting to the openoffice server instance. #-# Default port is 8100 # openoffice.serverPort=8100 #-# [Since 1.9M2] #-# If the openoffice server should be started / connected upon XE start. #-# Default value is false # openoffice.autoStart=false #-# [Since 1.8RC3] #-# Path to openoffice installation (serverType:0 only). #-# If no path is provided, a default value will be calculated based on the operating environment. # openoffice.homePath=/opt/openoffice.org3/ #-# [Since 1.8RC3] #-# Path to openoffice execution profile (serverType:0 only). ``` -------------------------------- ### Sample xwiki.properties Configuration Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Configuration?rev=106.1&viewer=code Example configuration file demonstrating core, rendering, cache, and OfficeImporter settings. ```none # This is the new XWiki configuration file. In the future it'll replace the old # xwiki.cfg file. However right now it's only used by some XWiki components. # As time progresses more and more component will get their configurations from # this file. #------------------------------------------------------------------------------------- # Core #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies the default syntax to use when creating new documents. #-# Default value is xwiki/2.0. # core.defaultDocumentSyntax = xwiki/1.0 #------------------------------------------------------------------------------------- # Rendering #------------------------------------------------------------------------------------- #-# [Since 1.8RC2] #-# Specifies how links labels are displayed when the user doesn't specify the label explicitely. #-# Valid values: #-# %w: wiki name #-# %s: space name #-# %p: page name #-# %P: page name with spaces between camel case words, i.e. "My Page" iff the page name is "MyPage" #-# %t: page title #-# #-# Note that if the page title is empty or not defined then it defaults to %p. This is also the case #-# if the title cannot be retrieved for the document. #-# #-# The default is "%p". Some examples: "%s.%p", "%w:%s.%p". # rendering.linkLabelFormat = %p #-# [Since 2.0M3] #-# Overrides default macro categories (Each macro has a default category already defined, for example #-# "presentation" for the Table of Contents Macro). #-# #-# Ex: To redefine the macro category for the TOC macro so that it'd be in the "My Category" category + #-# redefine the category for the Script Macro to be "My Other Category", you'd use: # rendering.macroCategories = toc:My Category # rendering.macroCategories = script:My Other Category #------------------------------------------------------------------------------------- # Cache #------------------------------------------------------------------------------------- #-# [Since 1.7M1] #-# The standard cache component implementation to use (can be local or distributed depending on the implementation). #-# The default standard cache implementation is JBoss Cache. # cache.defaultCache=jbosscache #-# [Since 1.7M1] #-# The local cache implementation to use. #-# The default local cache implementation is JBoss Cache. # cache.defaultLocalCache=jbosscache/local #---------------------------------------------------------------------------------- # Settings for the OpenOffice server instance consumed by the OfficeImporter plugin #---------------------------------------------------------------------------------- #-# [Since 1.9M2] #-# Type of the openoffice server instance used by officeimporter plugin. #-# 0 - Internally managed server instance. (Default) #-# 1 - Externally managed (local) server instance. # openoffice.serverType=0 #-# [Since 1.9M2] ``` -------------------------------- ### Start the XWiki service Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Installation/XWiki%20Installation%20on%20AWS/Deployment%20Using%20CDK%20Code?language=en&rev=2.1 Navigate to the XWiki installation directory and execute the startup script. ```bash cd xwikihome && cd xwiki-platform-distribution-flavor-jetty-hsqldb-13.1 ``` ```bash chmod +x ./start_xwiki.sh && ./start_xwiki.sh ``` -------------------------------- ### Hardware Configuration Example Source: https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Performances?language=en&rev=106.4 Example CPU configuration details for an XWiki cloud instance. ```text AMD Opteron(tm) Processor 6386 SE cpu MHz : 2800.000 cache size : 2048 KB ```