Show last authors
1 {{velocity}}
2 $xwiki.ssx.use("Documentation.AdminGuide.Installation.InstallationStandalone.WebHome")
3 #set ($typePackaging = $escapetool.xml($request.packaging))
4 #if ("$!typePackaging" == '')
5 #set ($typePackaging = 'ZIP')
6 #end
7 ## Force highlight to be ZIP since we only distribute ZIP artifacts and we've removed the EXE and JAR ones.
8 #set ($highlight = true)
9 #if ("$!request.highlight" == 'false')
10 #set ($highlight = false)
11 #end
12 {{/velocity}}
13
14 == (% class="step" %)Download(%%) ==
15
16 (% class="instructions" %)
17 (((
18 Before you start make sure you've read the [[System Requirements>>platform:AdminGuide.Installation||anchor="HPrerequisites"]].
19
20 First, you need to [[download>>xwiki:Download.WebHome]] the suited XWiki version for your use case.
21 )))
22
23 == (% class="step" %)Install(%%) ==
24
25 (% class="instructions" %)
26 (((
27 {{velocity}}
28 {{html clean='false' wiki='true'}}
29 <div class="row installation-tabs">
30 #if (!$highlight)
31 <div class="col-xs-12 col-lg-4">
32 <ul class="nav nav-pills nav-stacked list-group installation-tabs-item" role="tablist">
33 <li role="presentation" class="#if($typePackaging == 'JAR')active#end list-group-item">
34 <a href="$doc.getURL('view','packaging=JAR#InstallJAR')" aria-controls="InstallJAR" role="tab" data-toggle="tab" class=""><span class="badge fill-blue pull-right">JAR</span>
35 <h4 class="list-group-item-heading">Graphical Installer for All Platforms</h4>
36 <p class="list-group-item-text noitems">Should be used by first-time users on non-Windows systems. This installer requires administrator rights on the target OS and if you don't have those permissions use the ZIP packaging below.</p></a>
37 </li>
38 <li role="presentation" class="#if($typePackaging == 'EXE')active#end list-group-item">
39 <a href="$doc.getURL('view','packaging=EXE#InstallEXE')" aria-controls="InstallEXE" role="tab" data-toggle="tab" class="">
40 <span class="badge fill-blue pull-right">EXE</span>
41 <h4 class="list-group-item-heading">Graphical Installer for Windows</h4>
42 <p class="list-group-item-text noitems">This installer requires administrator rights on the target OS and if you don't have those permissions use the ZIP packaging below.</p>
43 </a>
44 </li>
45 <li role="presentation" class="#if($typePackaging == 'ZIP')active#end list-group-item">
46 <a href="$doc.getURL('view','packaging=ZIP#InstallZIP')" aria-controls="InstallZIP" role="tab" data-toggle="tab" class="">
47 <span class="badge fill-blue pull-right">ZIP</span>
48 <h4 class="list-group-item-heading">ZIP Package</h4>
49 <p class="list-group-item-text noitems">This includes a Jetty Servlet Container and an HSQLDB database all set up, packaged as a ZIP file. Should be used by first-time users who do not need/want to use one of the installers above.</p>
50 </a>
51 </li>
52 </ul>
53 </div>
54 #end
55
56 <div class="tab-content installation-tabs-item col-xs-12 col-lg-8">
57 <div role="tabpanel" class="tab-pane #if($typePackaging == 'JAR')active#end" id="InstallJAR">{{/html}}The graphical installer is a generic installer that works on all platforms. It requires Java to be installed on your system. Simply double-click on it and follow the instructions.
58
59 {{warning}}
60 In case you have problems opening the file, you can use this command to launch the installation: {{code language="none"}}
61 java -jar <name_of_installer_file.jar>
62 {{/code}}
63 {{/warning}}
64
65 Go to the directory where you've installed XWiki (#[[##XWIKIHOME##]]#) and run {{code language="none"}}start_xwiki.bat{{/code}} in Windows or {{code language="none"}}start_xwiki.sh{{/code}} on Unix or Mac.
66
67 To stop it, run the {{code language="none"}}stop_xwiki.bat{{/code}} script on Windows and {{code language="none"}}stop_xwiki.sh{{/code}} on Unix or Mac.
68
69 On Mac you will need to use //"Open with Terminal"// or run these scripts from the Terminal.
70
71 {{warning}}In some cases, you might already have a Web Server running on port 8080. If this happens you have to use another port, specified by passing an argument to the start script (e.g. using the port 8081, as in {{code language="none"}}start_xwiki.sh -p 8081{{/code}} for XWiki 6.2+ and {{code language="none"}}start_xwiki.sh -8081{{/code}} for older versions).{{/warning}}
72
73 Do not close the terminal window that shows up. This is the XWiki server running.
74
75 {{html clean='false' wiki='true'}}</div>
76 <div role="tabpanel" class="tab-pane #if($typePackaging == 'ZIP')active#end" id="InstallZIP">{{/html}}The standalone package is a zip archive file that can be used for all platforms. Unzip it in any directory of your choice (let's call it #[[##XWIKIHOME##]]#).
77
78 Go to the directory where you've installed XWiki (#[[##XWIKIHOME##]]#) and run {{code language="none"}}start_xwiki.bat{{/code}} in Windows or {{code language="none"}}start_xwiki.sh{{/code}} on Unix or Mac.
79
80 To stop it, run the {{code language="none"}}stop_xwiki.bat{{/code}} script on Windows and {{code language="none"}}stop_xwiki.sh{{/code}} on Unix or Mac.
81
82 On Mac you will need to use //"Open with Terminal"// or run these scripts from the Terminal.
83
84 {{warning}}In some cases, you might already have a Web Server running on port 8080. If this happens you have to use another port, specified by passing an argument to the start script (e.g. using the port 8081, as in {{code language="none"}}start_xwiki.sh -p 8081{{/code}} for XWiki 6.2+ and {{code language="none"}}start_xwiki.sh -8081{{/code}} for older versions).{{/warning}}
85
86 Do not close the terminal window that shows up. This is the XWiki server running.
87 {{html clean='false' wiki='true'}}</div>
88 <div role="tabpanel" class="tab-pane #if($typePackaging == 'EXE')active#end" id="InstallEXE">{{/html}}Graphical Windows native installer is a Windows executable file. Simply execute it and follow the instructions.
89
90 The Windows installer creates shortcuts to start and stop XWiki in your Windows start menu. Launch XWiki using "start".
91
92 {{warning}}
93 Make sure you install with a user who has administration rights and run the installed XWiki server with that same user. Otherwise you might get some permission problems. They can be fixed by giving permission to the other user to write in the directories XWiki writes to. Those depend on the XWiki version you use:
94 * Before 4.0.1 and 4.1M1, 4.1M2: The directory where you installed XWiki Enterprise (the default location is #[[##C:\Program Files\XWiki Enterprise##]]#)
95 * 4.0.1 and 4.1: #[[##C:\XWiki Enterprise##]]#
96 * 4.2M1+: The XWiki Data directory in #[[##%APPDATA%\XWiki\<version>\data##]]#
97 {{/warning}}
98
99 {{warning}}
100 If you install on Windows 7 and if you're using a version of XWiki < 4.1 then you'll need to be careful **not** to install in the #[[##Program Files##]]# directory. This is because of new security measures in Windows 7 which prevent from writing in the ##Program Files## directory. A possible location is at the root of your C drive (e.g. #[[##C:\XWiki Enterprise##]]#).
101 {{/warning}}
102
103 Do not close the DOS window that shows up. This is the XWiki server running.
104
105 {{html clean='false'}}
106 </div>
107 </div>
108
109 </div>
110 {{/html}}
111 {{/velocity}}
112 )))
113
114 == (% class="step" %)Launch(%%) ==
115
116 (% class="instructions" %)
117 (((
118 Once XWiki is started point your browser to [[{{code language="none"}}http://localhost:8080/{{/code}}>>http://localhost:8080/]].
119 )))
120
121 == (% class="step" %)Log in(%%) ==
122
123 (% class="instructions" %)
124 (((
125 You can log in using the default {{code language="none"}}Admin{{/code}} user (first letter is capitalized). The default password is {{code language="none"}}admin{{/code}} (lowercase).
126
127 You should read [[Getting Started Guide>>enterprise:UserGuide.WebHome]] to learn how to use XWiki.
128 )))

Get Connected