diff --git a/doc/installation.txt b/doc/installation.txt
index a815707ab4bb4708b43e65f78c537d65497bb98c..d4ef6798a81532a38ad27075b8441e3e892d636a 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
installed and used. You will need to run the "roundup-admin reindex"
command if the tracker has existing data.
- Roundup requires Xapian *newer* than 0.9.2 - it may be necessary for
- you to install a snapshot. Snapshot "0.9.2_svn6532" has been tried
- successfully.
+ Roundup requires Xapian 1.0.0 or newer.
pyopenssl
If pyopenssl_ is installed the roundup-server can be configured
configured, you can require email to be cryptographically signed
before roundup will allow it to make modifications to issues.
-.. _Xapian: http://www.xapian.org/
+.. _Xapian: http://xapian.org/
.. _pytz: http://www.python.org/pypi/pytz
.. _Olson tz database: http://www.twinsun.com/tz/tz-link.htm
.. _pyopenssl: http://pyopenssl.sourceforge.net
and if it runs you may skip the `Basic Installation Steps`_
below and go straight to `configuring your first tracker`_.
-Download the latest version from http://roundup.sf.net/.
+Download the latest version from http://www.roundup-tracker.org/.
If you're using WinZIP's "classic" interface, make sure the "Use
folder names" check box is checked before you extract the files.
Confirm:
Note: running this command will *destroy any existing data in the
- database*. In the case of MySQL and PostgreSQL, any exsting database
+ database*. In the case of MySQL and PostgreSQL, any existing database
will be dropped and re-created.
Once this is done, the tracker has been created.
There are five web interfaces to choose from:
1. `web server cgi-bin`_
-2. `stand-alone web server`_
-3. `Zope product - ZRoundup`_
-4. `Apache HTTP Server with mod_python`_
-5. `WSGI handler`_
+2. `cgi-bin for limited-access hosting`_
+3. `stand-alone web server`_
+4. `Zope product - ZRoundup`_
+5. `Apache HTTP Server with mod_python`_
+6. `WSGI handler`_
You may need to give the web server user permission to access the tracker home
- see the `UNIX environment steps`_ for information. You may also need to
</Location>
+CGI-bin for Limited-Access Hosting
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you are running in a shared-hosting environment or otherwise don't have
+permissiong to edit the system web server's configuration, but can create a
+``.htaccess`` file then you may be able to use this approach.
+
+1. Install flup_
+2. Create a script ``roundup_stub`` in your server's ``cgi-bin`` directory
+ containing::
+
+ #!/usr/bin/env python
+
+ # if necessary modify the Python path to include the place you
+ # installed Roundup
+ #import sys
+ #sys.path.append('...')
+
+ # cgitb is needed for debugging in browser only
+ #import cgitb
+ #cgitb.enable()
+
+ # obtain the WSGI request dispatcher
+ from roundup.cgi.wsgi_handler import RequestDispatcher
+ tracker_home = '/path/to/tracker/home'
+ app = RequestDispatcher(tracker_home)
+
+ from flup.server.cgi import WSGIServer
+ WSGIServer(app).run()
+
+3. Modify or created the ``.htaccess`` file in the desired (sub-)domain
+ directory to contain::
+
+ RewriteEngine On
+ RewriteBase /
+ RewriteRule ^(.*)$ /cgi-bin/roundup_stub/$1 [L]
+
+Now loading the (sub-)domain in a browser should load the tracker web
+interface. If you get a "500" error then enable the "cgitb" lines in the
+stub to get some debugging information.
+
+
Stand-alone Web Server
~~~~~~~~~~~~~~~~~~~~~~
.. _External hyperlink targets:
.. _apache: http://httpd.apache.org/
+.. _flup: http://pypi.python.org/pypi/flup
.. _mod_python: http://www.modpython.org/
.. _MySQLdb: http://sourceforge.net/projects/mysql-python
.. _Psycopg: http://initd.org/software/initd/psycopg