Author: gmazza
Date: Sun Dec 22 12:34:07 2013
New Revision: 1552987
URL: http://svn.apache.org/r1552987
Log:
Updated and simplified README.
Modified:
jspwiki/trunk/README
Modified: jspwiki/trunk/README
URL:
http://svn.apache.org/viewvc/jspwiki/trunk/README?rev=1552987&r1=1552986&r2=1552987&view=diff
==============================================================================
--- jspwiki/trunk/README (original)
+++ jspwiki/trunk/README Sun Dec 22 12:34:07 2013
@@ -1,4 +1,3 @@
-
Apache JSPWiki 2.10 - Documentation
===============================================
@@ -71,22 +70,19 @@ engine. Just do the following:
1) Install Tomcat from http://tomcat.apache.org/ (or any other servlet
container)
-2) After you've installed the engine and checked that it works, you just make a
- subdirectory under $TOMCAT_HOME/webapps/.
- For example, if you want your application to be called 'wiki', just create a
- directory called 'wiki', then extract all files from the war file into that
- directory, preserving the directory structure.
-
-3) Point your browser at http://<myhost>/JSPWiki/Install.jsp
- (Or, if you renamed it in the previous phase, use something like
- http://<myhost>/wiki/Install.jsp)
+2) Rename the JSPWiki.war file from the download and rename it based on
+ your desired URL (if you want it different from /JSPWiki). For example,
+ if you want your URL to be http://.../wiki, rename it to wiki.war.
+ This name will be referred to as <appname> below.
+ Place this WAR in your $TOMCAT_HOME/webapps folder and then start Tomcat.
+
+3) Point your browser at http://<myhost>/<appname>/Install.jsp
4) Answer a couple of simple questions
5) Restart your container
-6) Point your browser to http://<myhost>/JSPWiki/ (or whatever name you
- chose in point 2)
+6) Point your browser to http://<myhost>/<appname>/
That's it!
@@ -94,20 +90,20 @@ That's it!
Advanced Installation
---------------------
-First, install a JSP engine and a web server. You can download Tomcat
-from http://tomcat.apache.org. This software was built
-originally on top of Tomcat 5.5, but probably most other versions
-work, too, and most other JSP containers.
-
-After you've installed the engine and checked that it works, you just
-make a subdirectory under $TOMCAT_HOME/webapps/. For example, if you
-want your application to be called 'MyWiki', just create a directory
-called 'MyWiki', then extract all files from the war files into that
-directory, preserving the directory structure.
-
-Edit the WEB-INF/jspwiki.properties file to your liking. The only
-thing you need to set is the directory where you want your wiki pages
-to be stored. I recommend a directory that is regularly backed up.
+In the $TOMCAT_HOME/lib folder (or equivalent based on your servlet container),
+place a jspwiki-custom.properties file, which can contain any overrides to the
+default ini/jspwiki.properties file in the JSPWiki JAR. For any values not
+placed in jspwiki-custom.properties file JSPWiki will rely on the default file.
+Review the default file to look for values you may wish to override in the
custom
+file. Some common values to override in your custom file include
+jspwiki.baseURL, jspwiki.xmlUserDatabaseFile, jspwiki.xmlGroupDatabaseFile
+jspwiki.fileSystemProvider.pageDir,
jspwiki.basicAttachmentProvider.storageDir,
+and log4j.appender.FileLog.File. The comments in the default file will
suggest
+appropriate values to override them with.
+
+The custom file can also be placed in the WEB-INF/ folder of the WAR, but
storing
+this file in TOMCAT_HOME/lib allows you to upgrade the JSPWiki WAR without
needing
+to re-insert your customizations.
Unzip the contents of jspwiki-corepages.zip into your newly created
directory. You can find the rest of the documentation in the
@@ -119,54 +115,24 @@ Point your browser at http://<where your
You should see the Main Wiki page. See the next section if you want
to edit the pages =).
+The WEB-INF/jspwiki.policy file is used to change access permissions for
+the Wiki.
-Installation with Windows
--------------------------
-
-If you are using a version of Microsoft Windows, you'll find that
-getting RCS up and running may be a bit problematic, and thus we
-recommend the VersioningFileProvider.
-
-All JSPWiki documentation is in the web; please see
-http://doc.jspwiki.org/2.8/wiki/WindowsInstall
+Check the Apache JSPWiki website and project documentation for additional
+setup and configuration suggestions.
Upgrading from previous versions
--------------------------------
-Please read ReleaseNotes and the UPGRADING document.
-
-All JSPWiki documentation is in the web; please see
-http://doc.jspwiki.org/2.8/
-
-
-Configuring JSPWiki
--------------------
-
-All configuration information is kept in WEB_INF/jspwiki.properties.
-The file is pretty well documented, so I recommend you read it through
-first.
-
-There are also some auxiliary configuration files, such as filters.xml.
-
-Also, there is a far more detailed documentation in the web:
-
-http://doc.jspwiki.org/2.8/
-
-
-Where to go next aka. where is the rest of the documentation?
--------------------------------------------------------------
-
-The rest of the documentation is at
-
-http://doc.jspwiki.org/2.8/
-
-
+Please read ReleaseNotes and the UPGRADING document available with this
+distribution.
Contact
-------
-JSPWiki authors can be contacted on the jspwiki-users mailing list.
-You can see the instructions on http://www.jspwiki.org/wiki/JSPWikiMailingList.
+Questions can be asked to JSPWiki team members and fellow users via the
jspwiki-users
+mailing list: See http://jspwiki.apache.org/community/mailing_lists.html.
+Please use the user mailing list instead of contacting team members directly,
+and as this is a public list stored in public archives, be sure to avoid
including
+any sensitive information (passwords, data, etc.) in your questions.
-The mailing list should also be your primary place to ask support questions.
-There are many wise and knowledgeable people on that list.
