# Jigsaw
Documentation Overview

Jigsaw Home

This document has the following sections:

1. Short overview of Jigsaw
2. User's documentation
3. FAQ about Jigsaw
4. Programmer's documentation

# Overview of Jigsaw

The Jigsaw server is entirely written in Java. Because of this, it offers the following features:

- Portability
- Extensibility
- Object Oriented design

Jigsaw will run on any platform that supports Java, with no changes! Jigsaw has been reported to run on several platforms Jigsaw is made of a core and a set of extension modules. You can add your own modules, dynamically, to the server. Moreover, because the Java runtime comes with both threads and garbage collection, your job, as an extension writer, is largely simplified. The full code of the server is object-oriented. The interested thing is that all the resources are objects. By opposition to most of the existing servers, which consider a resource as being either a cgi script or a file. Jigsaw allows any object to become accessible via HTTP or whatever protocol implemented.

# User's Documentation

You will find here the basics on how to install and run the server to the description of the most complex configuration you can do with Jigsaw.

1. Installation of Jigsaw.
2. Command line options.
3. Basic concepts of Jigsaw.
4. JigAdmin 2.0 overview.
5. Configuration of Jigsaw.
6. Authentication in Jigsaw.
7. Pics in Jigsaw.
8. Page Compilation.
9. Redirections in Jigsaw.
10. Tutorials.

1. How to use JigAdmin.
2. How to use JigKill.
3. Configuration of attributes.
4. Creation of a resource.
5. Creation of an indexer.
6. How to add a new Mime Type in Jigsaw.
7. How to use Server Side Include commands in Jigsaw.
8. How to setup CGI scripts in Jigsaw.
9. How to setup Servlets in Jigsaw.
10. How to setup publication (PUT) in Jigsaw.
11. How to setup Jigsaw as a proxy.
12. How to setup authentication.
13. How to setup virtual hosting in Jigsaw.
14. Browsing zip files with Jigsaw

11. Reference information for frames and resources.

# FAQ

Answers to all the Frequently Asked Questions about Jigsaw and its use.

# Programmer's documentation

You will find here the description of Jigsaw from a programmer point of view, and indications on how to extend it to fulfill your needs.

1. Internal design.
2. JXML, the internal format used to store the resources metadata.
3. API (frames of no-frames). This is the API of the developpement version of Jigsaw available from the public CVS tree.
4. Tutorials.

1. How to compile Jigsaw.
2. How to write a Resource.
3. How to write a Frame.
4. How to write a server-side Filter.
5. How to write a client-side Filter.
6. How to write a new Server Side Include command.

5. Sample code.

Jigsaw Team
$Id: Overview.html,v 1.76 1999/09/09 13:08:36 bmahe Exp $

Copyright © 1999 W3C (MIT, INRIA, Keio ), All Rights Reserved. W3C liability, trademark , document use and software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.