ANY23-322 Any23 embedded service is broken
[any23.git] / service / src / main / assembly / README.txt
1   Licensed to the Apache Software Foundation (ASF) under one or more
2   contributor license agreements.  See the NOTICE file distributed with
3   this work for additional information regarding copyright ownership.
4   The ASF licenses this file to You under the Apache License, Version 2.0
5   (the "License"); you may not use this file except in compliance with
6   the License.  You may obtain a copy of the License at
7
8    http://www.apache.org/licenses/LICENSE-2.0
9
10   Unless required by applicable law or agreed to in writing, software
11   distributed under the License is distributed on an "AS IS" BASIS,
12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   See the License for the specific language governing permissions and
14   limitations under the License.
15
16 Apache Any23 Service ${project.version} (${implementation.build.tstamp})
17
18   What is it?
19   -----------
20
21   ${project.description}
22
23   Documentation
24   -------------
25
26   The most up-to-date documentation can be found at ${project.parent.url}.
27
28   Release Notes
29   -------------
30
31   The full list of changes can be found at ${project.parent.url}/service.html.
32
33   System Requirements
34   -------------------
35
36   JDK:
37     ${javac.target.version} or above. (see http://www.oracle.com/technetwork/java/)
38   Memory:
39     No minimum requirement.
40   Disk:
41     No minimum requirement.
42   Operating System:
43     No minimum requirement. On Windows, Windows NT and above or Cygwin is required for
44     the startup scripts. Tested on Windows XP, Fedora Core and Mac OS X.
45
46   Installing Apache Any23 Service
47   ----------------
48
49 ** Windows 2000/XP
50
51   1) Unzip the distribution archive, i.e. apache-${project.build.finalName}-bin.zip to the directory you wish to
52         install Apache Any23 ${project.version}.
53         These instructions assume you chose C:\Program Files\Apache Software Foundation.
54         The subdirectory apache-${project.build.finalName} will be created from the archive.
55
56   2) Add the ANY23_HOME environment variable by opening up the system properties (WinKey + Pause),
57         selecting the "Advanced" tab, and the "Environment Variables" button, then adding the ANY23_HOME
58         variable in the user variables with the value
59         C:\Program Files\Apache Software Foundation\apache-${project.build.finalName}.
60
61   3) In the same dialog, add the ANY23 environment variable in the user variables with the value %ANY23_HOME%\bin.
62
63   4) Optional: In the same dialog, add the EXTRA_JVM_ARGUMENTS environment variable in the user variables to specify
64         JVM properties, e.g. the value -Xms256m -Xmx512m. This environment variable can be used to supply extra options.
65         By default, it is set to: -Xms500m -Xmx500m -XX:-UseGCOverheadLimit
66
67   5) In the same dialog, update/create the Path environment variable in the user variables and prepend the value
68         %ANY23% to add Apache Any23 available in the command line.
69
70   6) In the same dialog, make sure that JAVA_HOME exists in your user variables or in the system variables and it is
71         set to the location of your JDK, e.g. C:\Program Files\Java\jdk1.5.0_02 and that %JAVA_HOME%\bin is in your Path
72         environment variable.
73
74   7) Open a new command prompt (Winkey + R then type cmd) and run any23server to launch the service.
75
76 ** Unix-based Operating Systems (Linux, Solaris and Mac OS X)
77
78   1) Extract the distribution archive, i.e. apache-${project.build.finalName}-bin.tar.gz to the directory you wish to
79         install Apache Any23 ${project.version}.
80         These instructions assume you chose /usr/local/apache-any23.
81         The subdirectory apache-${project.build.finalName} will be created from the archive.
82
83   2) In a command terminal, add the ANY23_HOME environment variable, e.g.
84         export ANY23_HOME=/usr/local/apache-any23/apache-${project.build.finalName}.
85
86   3) Add the ANY23 environment variable, e.g. export ANY23=$ANY23_HOME/bin.
87
88   4) Optional: Add the EXTRA_JVM_ARGUMENTS environment variable to specify JVM properties, e.g.
89         export EXTRA_JVM_ARGUMENTS="-Xms256m -Xmx512m".
90         This environment variable can be used to supply extra options.
91
92   5) Add ANY23 environment variable to your path, e.g. export PATH=$ANY23:$PATH.
93
94   6) Make sure that JAVA_HOME is set to the location of your JDK, e.g.
95         export JAVA_HOME=/usr/java/jdk1.5.0_02 and that $JAVA_HOME/bin is in your PATH environment variable.
96
97   7) Run any23server to launch the service.
98
99   Licensing
100   ---------
101
102   Please see the file called LICENSE.TXT
103
104   Apache Any23 URLS
105   ----------
106
107   Home Page:          ${project.parent.url}/
108   Downloads:          ${project.parent.url}/download.html
109   Release Notes:      ${project.parent.url}/changes-report.html
110   Mailing Lists:      ${project.parent.url}/mail-lists.html
111   Source Code:        ${project.parent.scm.url}
112   Issue Tracking:     ${project.issueManagement.url}
113   Available Plugins:  ${project.parent.url}/plugins.html