README
1
2
3 JSPWiki documentation
4 =====================
5
6What is it?
7-----------
8
9JSPWiki is a simple (well, not any more) WikiWiki clone, written in Java
10and JSP. A WikiWiki is a web site which allows anyone to participate
11in its development. JSPWiki supports all the traditional wiki features,
12as well as very detailed access control and security integration using JAAS.
13
14
15 Licensed to the Apache Software Foundation (ASF) under one
16 or more contributor license agreements. See the NOTICE file
17 distributed with this work for additional information
18 regarding copyright ownership. The ASF licenses this file
19 to you under the Apache License, Version 2.0 (the
20 "License"); you may not use this file except in compliance
21 with the License. You may obtain a copy of the License at
22
23 http://www.apache.org/licenses/LICENSE-2.0
24
25 Unless required by applicable law or agreed to in writing,
26 software distributed under the License is distributed on an
27 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
28 KIND, either express or implied. See the License for the
29 specific language governing permissions and limitations
30 under the License.
31
32
33The license file can be found in LICENSE.
34
35Pre-requirements
36----------------
37
38Okay, so you wanna Wiki? You'll need the following things:
39
40REQUIRED:
41
42* A JSP engine that supports Servlet API 2.3. I recommend Tomcat from
43 http://jakarta.apache.org/tomcat for a really easy installation.
44 Tomcat 5.x or later is supported.
45
46* Some previous administration experience... If you've ever installed
47 Apache or any other web server, you should be pretty well off.
48
49* And of course, a server to run the JSP engine on.
50
51* JDK 1.5+
52
53
54OPTIONAL:
55
56* JavaMail package from java.sun.com, if you want to use log4j mailing
57 capabilities. You'll also need the Java Activation Framework.
58
59* RCS versioning system installed and available in your PATH if you
60 want to use RCS versioning. It is also possible (and on Windows, it
61 is even recommended) to use the VersioningFileProvider, which does
62 not require RCS.
63
64
65Really simple installation
66--------------------------
67
68This section is meant for you, if you just want to have a really quick
69install without much worries. If you want to have a more complicated
70installation (with more power as to how to do things),
71check out the "Install" section below.
72
73Since JSPWiki 2.1.153, JSPWiki comes with a really simple installation
74engine. Just do the following:
75
761) Install Tomcat from http://jakarta.apache.org/ (or any other servlet
77 container)
78
792) After you've installed the engine and checked that it works, you just
80 make a subdirectory under $TOMCAT_HOME/webapps/.
81 For example, if you want your application to be called 'wiki', just create a directory
82 called 'wiki', then extract all files from the war file into that
83 directory, preserving the directory structure.
84
853) Point your browser at http://<myhost>/JSPWiki/Install.jsp
86 (Or, if you renamed it in the previous phase, use something like
87 http://<myhost>/wiki/Install.jsp)
88
894) Answer a couple of simple questions
90
915) Restart your container
92
936) Point your browser to http://<myhost>/JSPWiki/ (or whatever name you
94 chose in point 2)
95
96That's it!
97
98
99Advanced Installation
100---------------------
101
102First, install a JSP engine and a web server. You can download Tomcat
103from http://jakarta.apache.org/tomcat/. This software was built
104originally on top of Tomcat 5.5, but probably most other versions
105work, too, and most other JSP containers.
106
107After you've installed the engine and checked that it works, you just
108make a subdirectory under $TOMCAT_HOME/webapps/. For example, if you
109want your application to be called 'MyWiki', just create a directory
110called 'MyWiki', then extract all files from the war files into that
111directory, preserving the directory structure.
112
113Edit the WEB-INF/jspwiki.properties file to your liking. The only
114thing you need to set is the directory where you want your wiki pages
115to be stored. I recommend a directory that is regularly backed up.
116
117Unzip the contents of jspwiki-corepages.zip into your newly created
118directory. You can find the rest of the documentation in the
119JSPWiki-doc.zip file.
120
121(Re)start tomcat.
122
123Point your browser at http://<where your Tomcat is installed>/MyWiki/.
124You should see the Main Wiki page. See the next section if you want
125to edit the pages =).
126
127
128Installation with Windows
129-------------------------
130
131If you are using a version of Microsoft Windows, you'll find that
132getting RCS up and running may be a bit problematic, and thus we
133recommend the VersioningFileProvider.
134
135All JSPWiki documentation is in the web; please see
136http://doc.jspwiki.org/2.8/wiki/WindowsInstall
137
138Upgrading from previous versions
139--------------------------------
140
141Please read ReleaseNotes and the UPGRADING document.
142
143All JSPWiki documentation is in the web; please see
144http://doc.jspwiki.org/2.8/
145
146
147Configuring JSPWiki
148-------------------
149
150All configuration information is kept in WEB_INF/jspwiki.properties.
151The file is pretty well documented, so I recommend you read it through
152first.
153
154There are also some auxiliary configuration files, such as filters.xml.
155
156Also, there is a far more detailed documentation in the web:
157
158http://doc.jspwiki.org/2.8/
159
160
161Where to go next aka. where is the rest of the documentation?
162-------------------------------------------------------------
163
164The rest of the documentation is at
165
166http://doc.jspwiki.org/2.8/
167
168
169
170Contact
171-------
172
173JSPWiki authors can be contacted on the jspwiki-users mailing list.
174You can see the instructions on http://www.jspwiki.org/wiki/JSPWikiMailingList.
175
176The mailing list should also be your primary place to ask support questions.
177There are many wise and knowledgeable people on that list.
178