Caudium HOWTO

David Gourdelier

vida at caudium dot net

Copyright © 2002 by The Caudium Group.

Revision History
Revision 2.2	2002-09-20	Revised by: dg
Few more fixes, document now contains images and icons. See revision history for more information.
Revision 2.1	2002-06-14	Revised by: dg
Document is now well-formed XML, one more example. See revision history for more information.
Revision 2.0	2002-06-14	Revised by: Tab
Converted to DocBook XML 4.1.2. See revision history for more information.
Revision 1.0	2002-06-06	Revised by: dg
Initial release
Revision 0.91
Indentation of the SGML document and one more paragraph. See revision history for more.
Revision 0.9
This Howto is going into stable state. See the revision history for more information.
Revision 0.05	2002-04-04
This HOWTO is in the DocBook format. See the revision history for more information.
Revision 0.04
Added Introduction and license. See the revision history for more information.
Revision 0.03
Added some useful corrections. See the revision history for more information.
Revision 0.02
Minor correction in other answers. See the revision history for more information.
Revision 0.01	2002-03-11
Initial revision. See the revision history for more information.

This is the Caudium HOWTO. This document will give an overview of the Caudium server. New users will learn how to set a basic virtual server up. More experienced users will find useful tips on development and optimization. Finally at the end I give some documentation on Caudium top priorities for people who want to contribute.

Table of Contents

2. Overview

2.1. What is Caudium?
2.2. Caudium vs Roxen: Why a fork?
2.3. Comparing Caudium with Apache
2.4. Advantages of Caudium
2.5. Disadvantages of Caudium

3. Getting packages

3.1. How to get packages for Debian GNU/Linux
3.2. How to get packages for FreeBSD
3.3. How to get packages for Solaris
3.4. How to get CAMAS from CVS/source

4. Creating your first server

4.1. Installing Caudium from sources
4.2. Starting
4.3. Stopping from command line
4.4. Directory organization
4.5. Upgrading Caudium
4.6. Configuration InterFace (CIF.)
4.7. Adding your first server

5. Customizing your server

5.1. How to run Caudium as a non-privileged user; How to secure Caudium
5.2. How to benchmark a web server
5.3. How to tune your system for best Caudium performances
5.4. How to use your own fonts
5.5. How to get UltraLog working

6. Developing with Caudium

6.1. Your first RXML file
6.2. The Pike tag
6.3. Your first Pike script
6.4. Your first module
6.5. How to use a backtrace
6.6. How to print something to debug log file

7. How to help the Caudium community

7.1. How to promote Caudium
7.2. How to write documentation
7.3. How to get a CVS account
7.4. How to test Caudium
7.5. How to send a bug report

8. Revision History/Credits/The End

8.1. Revision History
8.2. Credits and contributors
8.3. The End

A. GNU Free Documentation License

A.1. PREAMBLE
A.2. APPLICABILITY AND DEFINITIONS
A.3. VERBATIM COPYING
A.4. COPYING IN QUANTITY
A.5. MODIFICATIONS
A.6. COMBINING DOCUMENTS
A.7. COLLECTIONS OF DOCUMENTS
A.8. AGGREGATION WITH INDEPENDENT WORKS
A.9. TRANSLATION
A.10. TERMINATION
A.11. FUTURE REVISIONS OF THIS LICENSE
A.12. How to use this License for your documents

List of Figures
4-1. Ports in the CIF
4-2. Filesystem in the CIF
4-3. Example of output

List of Examples
4-1. Your user filesystem.
4-2. A simple virtual hosting regular expression.
4-3. A better and quicker regular expression.
6-1. Some simple RXML tags.
6-2. The PHP documentation as a Pike tag.
6-3. A basic Pike script.
6-4. A real world script.
6-5. A script for the power user.
6-6. A sample module.

		Next
		License