# HG changeset patch # User paulb # Date 1137367279 0 # Node ID c2f55d6536c775229e588d5c421b4597f19ec314 # Parent 106307c85f76a664c05e099cc97ab49cdf5a066f [project @ 2006-01-15 23:21:19 by paulb] Added notes about Django. Improved documentation about the deploy function. diff -r 106307c85f76 -r c2f55d6536c7 docs/deploying-applications.html --- a/docs/deploying-applications.html Sun Jan 15 23:20:51 2006 +0000 +++ b/docs/deploying-applications.html Sun Jan 15 23:21:19 2006 +0000 @@ -1,12 +1,9 @@ - - - - - Deploying an Application - - - + + + + Deploying an Application + +

Deploying an Application

@@ -14,7 +11,7 @@

Here is a table which summarises the steps required to actually deploy your application in the different server environments or frameworks:

- +
@@ -30,7 +27,7 @@ Deploy application code in the specified script directory
Restart the Web server - + @@ -73,9 +70,8 @@

Notes on each server environment can be found in subdirectories within the docs directory:

- - + \ No newline at end of file diff -r 106307c85f76 -r c2f55d6536c7 docs/developing.html --- a/docs/developing.html Sun Jan 15 23:20:51 2006 +0000 +++ b/docs/developing.html Sun Jan 15 23:21:19 2006 +0000 @@ -77,7 +77,7 @@

The following topic is referenced in many locations and should be reviewed when encountering problems with input and output text:

-

Deployment

The following topics (illustrated by the programs found in the other subdirectories of the examples directory) describe how WebStack applications may be deployed in server environments:

Framework
DjangoSet up an instance and application in the Django environment
Deploy application code in the specified application directory
Java Servlet Use the supplied script in tools/JavaServlet and follow your servlet container's instructions
+
- + @@ -31,7 +28,7 @@ - + @@ -42,7 +39,7 @@ - + @@ -53,7 +50,7 @@ - + @@ -71,5 +68,4 @@ on certain frameworks.
  • Some mod_python releases do not provide session support directly.
    • - - + \ No newline at end of file diff -r 106307c85f76 -r c2f55d6536c7 docs/writing-adapters.html --- a/docs/writing-adapters.html Sun Jan 15 23:20:51 2006 +0000 +++ b/docs/writing-adapters.html Sun Jan 15 23:21:19 2006 +0000 @@ -1,11 +1,8 @@ - - - Writing Adapters - - - + + + Writing Adapters +

    Writing Adapters

    Depending on how "simple" the @@ -22,37 +19,37 @@

    When deploying an application, it is possible to use a one-shot deployment -function for BaseHTTPRequestServer, CGI, Twisted and WSGI. The +function for BaseHTTPRequestServer, CGI, Django, Java Servlet, mod_python, Twisted and WSGI configurations. The deploy function is called as follows:

    deploy(resource)
    deploy(resource, authenticator) # where authenticators are used

    For some frameworks, an address may be specified:

    deploy(resource, address=(host_string, port_integer))
    deploy(resource, authenticator, address=(host_string, port_integer))
    -

    Here is a summary of which -frameworks require address information:

    +

    And for some frameworks, the return value of the function is important:

    something = deploy(resource)
    something, something_else = deploy(resource, authenticator)

    Here is a summary of which +frameworks require address information and which produce important return values from the deploy function:

    BaseHTTPRequestHandler CGImod_pythonDjangomod_python Java Servlet API Twisted WebwareUnicode response writing WebStack WebStackWebStackWebStackWebStack Framework WebStack WebStackCookies WebStack [1] WebStack [1]Framework [2]Framework [3]Framework [2] Framework [3] Framework [3] Framework [3]Sessions WebStack WebStackFramework [4]FrameworkFramework [4] Framework WebStack Framework
    - + - + - + - + +is ignored) - + - +
    FrameworkAddress InformationAddress InformationReturn Values
    BaseHTTPRequestHandlerSupportedSupported
    CGIIgnoredIgnored
    DjangoIgnoredHandler function
    Java ServletIgnoredServlet class
    mod_pythonIgnoredHandler function and authenticator function (a 2-tuple)
    Twisted Supported (host_string -is ignored)
    Webware (> 0.8.1)IgnoredURL context object
    WSGIIgnoredIgnored
    @@ -103,19 +100,15 @@ Web server runs the adapter code - + DjangoSimple - see aboveThe adapter prepares the handler function Java Servlet - Must subclass HttpServlet - Application must be -deployed using supplied tools + Simple - see above + The adapter prepares the servlet class mod_python - Must implement handler -function - Web server runs the -adapter code (which must be declared -within Apache) + Simple - see above + The adapter prepares the handler function Twisted @@ -128,8 +121,7 @@ <= 0.8.1: Must implement InstallInWebKit function
    -> 0.8.1: Simple, but must provide a urlParser -object +> 0.8.1: Simple - see above Application must be deployed within WebKit @@ -151,5 +143,4 @@

    See "Deploying an Application" for more details of the deployment process for each environment.

    - - + \ No newline at end of file