|
|
OPS User Guide
- Getting Started
- Core Technologies Reference
- XForms
- Page Flow
- XML Pipelines (XPL)
- OPS Technologies Reference
- Processors Reference
- API Reference
- Integration
|
Installing Orbeon PresentationServer
1. Downloading
Orbeon PresentationServer (OPS) can be downloaded from
http://www.orbeon.com/community/downloads.
2. System Requirements
To install OPS you need an application server that runs on Java version 1.4.2 (or
later) and implements the Servlet API 2.3 (or later). OPS has been tested on the
following application servers:
- Apache Tomcat 4.1.31 (JDK 1.4.2)
- Apache Tomcat 5.5.4 (JDK 1.5.0)
- BEA WebLogic Server 9.1 (JRockit)
- IBM WebSphere 6
- JOnAS 4.6.6 (Tomcat 5.5.12, JDK 1.5.0)
- JBoss 4.0
Please contact us if you have questions about support for other application servers
or versions.
3. Installing OPS on Apache Tomcat
-
Assuming that TOMCAT_HOME represents the location of your
Tomcat installation: create a new TOMCAT_HOME/webapps/ops
directory.
-
Unzip ops.war in the ops directory you just
created.
-
With Tomcat 5, move xercesImpl.jar and
xmlParserAPIs.jar from common/endorsed to
server/lib . This way Xerces will be available to Tomcat, but it
won't override the version of Xerces and standard XML APIs that comes with
OPS.
-
You can now start Tomcat, and access http://localhost:8080/ops/
to test your installation (replacing localhost and
8080 with the host name and port number of your Tomcat
installation if different from the default), or perform one of the optional
installation steps below.
-
Optionally, to run the authentication example:
-
Open
TOMCAT_HOME/webapps/ops/WEB-INF/web.xml and
uncomment the security-constraint ,
login-config and security-role declarations at
the end of the file.
-
Open
TOMCAT_HOME/conf/server.xml and uncomment the
following declaration: <Realm
className="org.apache.catalina.realm.MemoryRealm" />
-
Edit
TOMCAT_HOME/conf/tomcat-users.xml and replace the
content of this by with:
<tomcat-users> <role rolename="administrator"/> <user username="admin" password="password" roles="administrator"/> </tomcat-users>
4. Installing OPS on BEA WebLogic 9.1
-
Select a directory where you want to store your web application. Let's
assume the path you chose is C:/WebApps/ops .
-
Unzip ops.war into C:/WebApps/ops . There should
now be a directory called WEB-INF under
C:/WebApps/ops .
-
Start WebLogic's adminstration console.
-
Use the console to install a new Web application. When prompted to select a
WAR file, point to the directory C:/WebApps/ops . When prompted
for a context path, choose a value such as ops . Complete the
installation and start the web application.
-
You should now be able to access the OPS examples by pointing your browser
to the address of your WebLogic server followed by the context path you
chose, for example: http://localhost:7001/ops/ .
5. Installing OPS on BEA WebLogic 7.0 and 8.1
Warning
OPS 3.0 hasn't been tested with these versions of WebLogic, but you may want to
try the following instructions for OPS 2.8.
-
Assume that DOMAIN represents your WebLogic domain directory
(typically c:\bea\user_projects ). Create a new directory:
DOMAIN\applications\orbeon .
-
Unzip ops.war in the orbeon directory you just
created.
-
Edit the startWeblogic.cmd (in DOMAIN ) and
change set STARTMODE=true to set
STARTMODE=false . This starts WebLogic in development mode. In
development mode, WebLogic automatically loads and deploys the content of
the application directory. If you don't want to start the
server in development mode, you have to explicitly declare a Web application
in the config.xml .
-
To improve performance on WebLogic (highly recommended!):
-
Start WebLogic (e.g. with
startWebLogic.cmd )
-
Make sure you can access the OPS examples with your browser (by going
to
http://localhost:7001/orbeon/ )
-
Stop WebLogic
-
Open the
config.xml file in an editor. Look for the
<WebAppComponent Name="orbeon"> element and add the
attribute: ServletReloadCheckSecs="-1" . This will prevent
WebLogic from checking if a servlet has changed in the application and
will make OPS much faster.
-
Optionally, to run the authentication example:
-
Open
DOMAIN/applications/orbeon/WEB-INF/web.xml and
uncomment the security-constraint ,
login-config and security-role declarations at
the end of the file.
-
Go to the WebLogic Console with a browser.
-
Create a new user named
admin with a password of your
choice.
-
Once OPS is properly installed, you can start WebLogic as usual with the
startWeblogic.cmd script (in DOMAIN ).
6. Installing OPS on IBM WebSphere 6
-
Launch WebSphere server.
-
On Windows go to Control Panel, Administrative Tools, Services.
Look for IBM WebSphere Application Server and make sure it is
started.
-
On Linux/UNIX, assuming that
WSAS_HOME represents the
location of your WebSphere installation, run
WSAS_HOME/profiles/default/bin/startServer.sh server1 .
-
Log in to the administrative console.
- Got to
http://localhost:9060/ibm/console/ .
- The default administrator login is
admin .
-
Install and deploy OPS (ops.war ).
- Click on Applications / Install New Application.
-
Select the
ops.war to upload, choose a context path
like /ops (from now on we will assume this was your
choice).
-
Hit "next" until you get to the end of the wizard, then hit
"finish". You can leave the defaults everywhere while going through
the wizard.
- Save the configuration.
- Click on Applications / Enterprise Applications.
- Select
ops_war and click on the "start" button.
-
Run and modify the examples.
- Go to
http://localhost:9080/ops/ .
-
You can view the log from OPS in
WSAS_HOME/profiles/default/logs/server1/SystemOut.log .
-
You can modify the examples resources as the application sever is
running and see the results of your modifications on the fly. The
resources are stored under
WSAS_HOME/profiles/default/installedApps/yourmachineNode01Cell/
orbeon_war.ear/ops.war/WEB-INF/resources . For instance,
try to modify examples/tutorial/hello1/view.xhtml :
replace "Hello World!" by your own message, and reload the page in
the browser to see the result.
7. Installing OPS on JBoss 4.0
-
Assuming that JBOSS_HOME represents the location of your JBoss
installation: create a new
JBOSS_HOME/server/default/deploy/ops.war directory.
-
Unzip ops.war in the ops.war directory you just
created.
-
Edit
JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/META-INF/jboss-service.xml
and change the value in
<attribute name="UseJBossWebLoader"> from false to
true .
-
Start JBoss by running JBOSS_HOME/bin/run.bat (or
run.sh on UNIX).
-
Run an modify the examples.
- Go to
http://localhost:8080/ops/
-
You can modify the examples resources as the application sever is
running and see the results of your modifications on the fly. The
resources are stored under
JBOSS_HOME/server/default/deploy/ops.war/WEB-INF/resources .
-
Optionally, to run the authentication sample:
8. Security
For security reasons, you might want to run OPS under a Security Manager. Java's
Security Manager allows you to control the Java sandbox and which resources the
application can access. When installed correctly, the Security Manager can prevent
unauthorized code to execute malicious actions, such as deleting files on the server
or initializing network connections. For more information, please read the Security in Java 2 SDK
1.2 tutorial and the Security
Manager API.
Follow the steps below to install the Security Manager:
-
Download the policy file.
-
Append the permissions to the application server
policy file. The table lists the policy file for
the supported servers.
Apache Tomcat |
catalina.policy |
BEA Weblogic |
weblogic.policy |
IBM WebSphere |
was.policy |
Sun ONE |
server.policy |
-
Add the following system properties to the server startup script.
- oxf.home: Location of the OPS exploded WAR file
- oxf.resources: Location of OPS resources directory
-
Modify the startup script to enable the security
manager. Add the following system properties:
- -Djava.security.manager
- -Djava.security.policy=="path to the policy file"
|