Rivet 3.0 runs with the Apache 2.2.x and 2.4.x HTTP web servers. It is known to build and run on various Linux distributions (Debian & Ubuntu, Redhat, SuSE and CentOS), FreeBSD and OpenBSD. For some of these Unix-like operative systems binary packages are already available for download.
Rivet 2.x was restricted to work with the prefork MPM of the Apache HTTP webserver. MPM modules are fundamental components of the webserver architecture. They provide multiple implementations of multiprocessing in order to better suit specific OS features and scalability requirements. The prefork MPM exploited the UNIX traditional approach to multiprocess server applications based on the fork system call. This model has several limitations but also some advantages. The solution we adopted tries to attain the best from any MPM as much as possible and Rivet 3.0 is now able to run with the worker and the event MPMs. Rivet 3.0 has not been ported to OS of the Windows family but we feel that the current design would fit just fine with the Windows specific MPMs such as winnt.
If you need to build Apache Rivet yourself this is the procedure to follow
Building Tcl: requirements
Installing Rivet is about endowing the Apache HTTP webserver with the ability of running scripts written with the Tcl programming language. Therefore the Tcl language with its runtime, development libraries and shell (≥8.5.10 required, ≥8.6.0 recommended) have to be installed. Building Rivet you will have to tell the scripts where the Tcl libraries are located via the --with-tcl option of the configure script (see below).
Several Tcl packages shipped with rivet need also the Itcl OOP extension of Tcl. If you need to run any of the Session or DIO packages you need to install this language extension but you don't need it to build mod_rivet
Getting and Installing the Apache Sources
You can build Rivet either statically (compiled into the Apache web server) or dynamically (as a loadable shared library). We recommend that you build Rivet as a shared library, for maximum flexibility. We will tell Rivet where it the Apache development files and libraries are located via the --with-apxs option to configure (see below).
Most modern Unix OS (Linux and FreeBSD systems included) come with their own packages of the Apache Web Server executables, runtime libraries and development files and libraries. Check the documentation of the package manager of your OS to find out how to install this software
Download the sources at http://tcl.apache.org/rivet/html/download.html.
We will assume that you have Apache installed at this point. You must uncompress the Rivet sources in the directory where you wish to compile them.
gunzip rivet-3.0.2.tar.gz tar -xvf rivet-3.0.2.tar.gz
Rivet uses the standard ./configure ; make ; make install sequence which installs to their target directories the Apache module, the binary libraries and the Tcl code
There are several rivet specific options to configure that might be useful (or needed):
tclConfig.shfile is located.
apxsprogram that provides information about the configuration and compilation options of Apache modules.
::rivetnamespace. With this option you may prevent it thus forcing the programmers to fully qualify in their code. By default this option is enabled and it can be changed in the configuration with the directive ExportRivetNS. Disabling this option can be also reverted to 'On' with the --enable-import-rivet-commands switch
Example: configuring the build system to compile Rivet for an Apache HTTP server custom installation, using tcl8.6. In this specific case the determination of the apxs path is redundant and it could be omitted since it could be inferred from the --with-apache option value
./configure --with-tcl=/usr/lib/tcl8.6/ --with-tclsh=/usr/bin/tclsh8.6 \ --with-apxs=/usr/local/apache2/bin/apxs --with-apache=/usr/local/apache2 \ --with-rivetlib-target-dir=/usr/local/apache2/rivet3.0
At this point, you are ready to run make, which should run to completion without any errors (a warning or two is OK, generally).
Now, you are ready to run the
to install the resulting files. The
actually fires the
install-packages targets which in turn
copy the binary modules and Tcl packages to their destination
directories. This commands create a functional Rivet environment with its
Apache Configuration Files
Rivet is relatively easy to configure - we start off by adding the module itself:
This tells Apache to load the Rivet shared object, wherever it happens to reside on your file system. Now we have to tell Apache what kind of files are "Rivet" files and how to process them:
AddType application/x-httpd-rivet rvt AddType application/x-rivet-tcl tcl
These tell Apache to process files with the
extensions as Rivet files.
The characters encoding can be changed using the header type command, but you can also change the default charset for the whole site:
AddType 'application/x-httpd-rivet;charset=utf-8' rvt
All the pages generated by Rivet on this site will be sent with a Content-Type:'text/html;charset=utf-8' header.
You may also wish to use Rivet files as index files for directories. In that case, you would do the following:
DirectoryIndex index.html index.htm index.shtml index.cgi index.tcl index.rvt
For other directives that Rivet provides for Apache configuration, please see the section called “Apache Rivet 3.0 Configuration”.