Deploying the Relay Server components to Apache on Linux

Before running the Relay Server with Apache, you need to deploy Relay Server files to each computer in the Relay Server farm.

Prerequisites

The Relay Server components are installed using the SQL Anywhere install. On Linux, the Relay Server files are installed to the /opt/sqlanywhere12 directory as part of the SQL Anywhere installation.

Context and remarks

Interactive quick setup feature

An interactive quick setup feature is provided as an alternative to this procedure. The quick setup feature:

Configures the web server for Relay Server
Creates a demo application
Generates a quick reference guide

Refer to the readme file for a more detailed description of the quick setup feature. The quick setup is comprised of two main steps:

Configure the Apache web server for Relay Server. This step can be accomplished by running ap-setup.sh script in the install-dir/RelayServer/Apache/quicksetup_apache directory.
Create and start Relay Server test services This step can be accomplished by running rs-test-setup.sh script in the install-dir/RelayServer/Apache/quicksetup_apache directory.

The Relay Server for Apache consists of the following executables:

mod_rs_ap_client.so
mod_rs_ap_server.so
rshost
dblgen12.res
libdbtasks12.so
libdbtasks12_r.so
libdbicudt12.so
libdbicu12_r.so
libdblib12_r.so
dbsupport
dbfhide
libdblib12.so
mod_rs_ap_monitor.so
mod_rs_ap_admin.so

Deploy the Relay Server components to Apache on Linux

Create the Relay Server configuration file rs.config.
Copy rs.config into the install-dir/relayserver/apache/bin?? directory. The server module expects the rshost executable to be in the same directory where you copied the rs.config file.
Edit the Relay Server configuration file rs.config using the following guidelines.
- The file should have four sections:
  - Relay server section
  - Backend farm section
  - Backend server section
  - Options section
- Each section starts with a section tag, made by enclosing a keyword that identifies the section name in square brackets.
- Add the appropriate properties to each section. A property is defined by specifying the property name on the left side of an equal sign and its value on the right side of the equal sign. For example, property name = value.
- The configuration file should contain only 7-bit ASCII characters.
The LD_LIBRARY_PATH environment variable needs to include the Apache install-dir/lib?? and install-dir/relayserver/apache/bin?? directories. Edit the /<apache-dir>/bin/envvars file to set and then export LD_LIBRARY_PATH.

Edit the Apache conf/httpd.conf file.

Add the following lines to load the Relay Server client and server modules:

LoadModule iarelayserver_client_module install-dir/relayserver/apache/bin??/mod_rs_ap_client.so

LoadModule iarelayserver_server_module install-dir/relayserver/apache/bin??/mod_rs_ap_server.so

Note

All modules are invoked using different URLs and all modules explicitly look for the string iarelayserver in the URL path. That part of the URL need not change.

Add the following line to load the SQL Anywhere Monitor support module:

LoadModule iarelayserver_monitor_module install-dir/relayserver/apache/bin??/mod_rs_ap_monitor.so

Add the following line to load the Remote Administration support module:

LoadModule iarelayserver_admin_module install-dir/relayserver/apache/bin??/mod_rs_ap_admin.so

Add the following line to create a <locationMatch> section for the client module:

<LocationMatch /cli/iarelayserver/* >
    SetHandler iarelayserver-client-handler
</LocationMatch>

Add the following line to create a <location> section for the server module:

<Location /srv/iarelayserver/* >
    SetHandler iarelayserver-server-handler
    RSConfigFile "/install-dir/relayserver/apache/bin??/rs.config"
</Location>

Note

You must specify an RSConfigFile directive which specifies the location of the Relay Server configuration file, rs.config. The rs.config file must reside in the same directory where the rshost executable is deployed.

Add the following line to create a <location> section for the SQL Anywhere Monitor module:

 <Location  /mon/iarelayserver/* >
    SetHandler iarelayserver-monitor-handler
</Location>

Add the following line to create a <location> section for the Remote Administration module:

<Location /admin/iarelayserver* >
  SetHandler iarelayserver-admin-handler
</Location>

If the TimeOut directive is set, ensure it is set to at least 60 seconds.

On Linux, if any of the following environment variables are set globally when Apache spawns a process, then there is nothing further needed for the configuration of Apache: $TMP, $TMPDIR or $TEMP.

If any of the above environment variables are not set globally, or if you want the default Relay Server log file to go in a specific temporary directory (for example, when the State Manager is started automatically but without customizations), then edit the file /<apache-dir>/bin/envvars to set and then export TMP.

For example, to edit $TMP in the envvars file, do the following:
set TMP="/tmp" export TMP
This sets the environment variable in the shell that Apache creates before it spawns its processes.

Note

The Apache user process must have write permissions to the specified tmp directory.

If you want to update the Relay Server configuration while it is started:

Copy the updated configuration file to the install-dir/relayserver/apache/bin?? directory. The configuration file must be called rs.config if auto start is used.

From the install-dir/relayserver/apache/bin?? directory, run the following command line to apply the configuration update:

rshost -u -f rs.config

If the Relay Server is set up as a farm with more than one server, repeat the previous steps for each computer in the Relay Server farm.

Results

The Relay Server configuration file is deployed to all computers in the Relay Server farm.

Next

None.

For information about which versions of Apache on Linux are supported, see [external link] http://www.sybase.com/detail?id=1061806.