Code

Ticket #3047: docs.diff

File docs.diff, 4.1 KB (added by Simon G. <dev@…>, 7 years ago)

Docs with Malcolm's changes.

Line 
1Index: docs/faq.txt
2===================================================================
3--- docs/faq.txt        (revision 4739)
4+++ docs/faq.txt        (working copy)
5@@ -328,8 +328,9 @@
6 
7 Although we recommend mod_python for production use, you don't have to use it,
8 thanks to the fact that Django uses an arrangement called WSGI_. Django can
9-talk to any WSGI-enabled server. The most common non-mod_python deployment
10-setup is FastCGI. See `How to use Django with FastCGI`_ for full information.
11+talk to any WSGI-enabled server. Other common non-mod_python deployment
12+setups are FastCGI, SCGI, or AJP. See `How to use Django with FastCGI`_ for
13+full information.
14 
15 Also, see the `server arrangements wiki page`_ for other deployment strategies.
16 
17@@ -337,7 +338,7 @@
18 the development Web server that comes with Django. Things should Just Work.
19 
20 .. _WSGI: http://www.python.org/peps/pep-0333.html
21-.. _How to use Django with FastCGI: ../fastcgi/
22+.. _How to use Django with FastCGI, SCGI, or AJP: ../fastcgi/
23 .. _server arrangements wiki page: http://code.djangoproject.com/wiki/ServerArrangements
24 
25 How do I install mod_python on Windows?
26Index: docs/fastcgi.txt
27===================================================================
28--- docs/fastcgi.txt    (revision 4739)
29+++ docs/fastcgi.txt    (working copy)
30@@ -3,10 +3,15 @@
31 ==============================
32 
33 Although the `current preferred setup`_ for running Django is Apache_ with
34-`mod_python`_, many people use shared hosting, on which FastCGI is the only
35-viable option. In some setups, FastCGI also allows better security -- and,
36-possibly, better performance -- than mod_python.
37+`mod_python`_, many people use shared hosting, on which protocols such as
38+FastCGI, SCGI, or AJP are the only viable options. In some setups, these protocols
39+also allow better security -- and, possibly, better performance -- than mod_python.
40 
41+.. admonition:: Note
42+
43+    This document discusses FastCGI, but other flup-supported protocols such as SCGI
44+    and AJP are also supported.
45+
46 Essentially, FastCGI is an efficient way of letting an external application
47 serve pages to a Web server. The Web server delegates the incoming Web requests
48 (via a socket) to FastCGI, which executes the code and passes the response back
49@@ -74,10 +79,23 @@
50 If you specify ``help`` as the only option after ``runfcgi``, it'll display a
51 list of all the available options.
52 
53-You'll need to specify either a ``socket`` or both ``host`` and ``port``. Then,
54-when you set up your Web server, you'll just need to point it at the host/port
55+You'll need to specify either a ``socket``, ``protocol`` or both ``host`` and ``port``.
56+Then, when you set up your Web server, you'll just need to point it at the host/port
57 or socket you specified when starting the FastCGI server.
58 
59+Protocols
60+---------
61+
62+Django supports all the protocols that flup_ does, namely fastcgi_, `SCGI`_, and `AJP1.3`_.
63+Your preferred protocol can be selected by using the `protocol=`<protocol_name> option with
64+`./manage.py runfcgi` where <protocol-name> may currently be one of: `fcgi` (the default),
65+`scgi`, or `ajp`.
66+
67+.. _flup: http://www.saddi.com/software/flup/
68+.. _fastcgi: http://www.fastcgi.com/
69+.. _SCGI: http://python.ca/scgi/protocol.txt
70+.. _AJP1.3: http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html
71+
72 Examples
73 --------
74 
75Index: docs/modpython.txt
76===================================================================
77--- docs/modpython.txt  (revision 4739)
78+++ docs/modpython.txt  (working copy)
79@@ -13,14 +13,15 @@
80 Django requires Apache 2.x and mod_python 3.x, and you should use Apache's
81 `prefork MPM`_, as opposed to the `worker MPM`_.
82 
83-You may also be interested in `How to use Django with FastCGI`_.
84+You may also be interested in `How to use Django with FastCGI`_ (which also
85+covers SCGI and AJP).
86 
87 .. _Apache: http://httpd.apache.org/
88 .. _mod_python: http://www.modpython.org/
89 .. _mod_perl: http://perl.apache.org/
90 .. _prefork MPM: http://httpd.apache.org/docs/2.2/mod/prefork.html
91 .. _worker MPM: http://httpd.apache.org/docs/2.2/mod/worker.html
92-.. _How to use Django with FastCGI: ../fastcgi/
93+.. _How to use Django with FastCGI, SCGI or AJP: ../fastcgi/
94 
95 Basic configuration
96 ===================