Rename doc/README to doc/setup.txt
[remote/remote-ws.git] / doc / setup.txt
blob81c78e96e0b2d1df18ac742841678c50bf56c7ce
1 A. Java SDK setup
2 1. Get J2SE 5.0 and setup CLASSPATH and JAVA_HOME to point to the appropriate folders.
3 2. Optionally, use the alternatives system to point usr/bin/java to the java executable
5 B. Apache Jakarta Tomcat setup
6 1. Obtain Jakarta Tomcat 5.5 distribution
7 2. Untar and copy the tree to the desired location
8 3. Set JAVA_HOME to J2SE path in a script that gets executed at startup
9 4. Create a tomcat user and group
10                 groupadd -g 220 tomcat
11                 useradd -u 220 -g tomcat -c "Tomcat" -r -d /usr/local/tomcat -s "/sbin/nologin" tomcat
12 4. Setup the included start and stop scripts for Tomcat according to the boot-howto.
13    Ignore instructions for apache.
14 5. Check installation at localhost:8080
16 C. Apache Axis setup
17 1. Obtain Apache Axis 1.2 distribution
18 2. Untar and copy /webapps/axis subtree to $CATALINA_HOME/webapps/testbedservices
19 3. Get the JavaBeans Activation Framework from http://java.sun.com/products/javabeans/glasgow/jaf.html
20 4. Put the activation.jar in  $CATALINA_HOME/webapps/testbedservices/WEB-INF/lib/
22 D. MySql Connector for Tomcat DBCP setup
23 1. Obtain MySql Connector/J and install the jar file in $CATALINA_HOME/common/lib/
24 2. Edit the xml file $CATALINA_HOME/conf/server.xml, put in the folowing under the
25    <Context> node:
27         <!-- url: The JDBC connection url for connecting to your MySQL dB.
28          The autoReconnect=true argument to the url makes sure that the
29          mm.mysql JDBC Driver will automatically reconnect if mysqld closed the
30          connection.  mysqld by default closes idle connections after 8 hours.
31         -->
32         <Resource name="jdbc/REMOTE" auth="Container" type="javax.sql.DataSource"
33                         maxActive="100" maxIdle="30" maxWait="10000"
34                         username="remote_admin" password="<thepassword>"
35                         driverClassName="com.mysql.jdbc.Driver"
36                         url="jdbc:mysql://localhost/REMOTE?autoReconnect=true"/>
38 E. Web service setup
39 1. Compile the project
40 2. Start the Axis server $CATALINA_HOME/bin/startup.sh
41 3. Edit the deploy.sh script CATALINA_HOME variable to point to the location
42    of the Axis server.
43 4. Run the deploy script
44 5. Check the installation on the web server