Edgewall Software

Windows Installation Instructions for Subversion w/ Trac 0.10

Languages:

For::

  • Windows Server 2003 SP1
  • IIS 6
  • Trac 0.10

Note 1: Before continuing to set up Trac to run using IIS6, be warned that python running under IIS6 is painfully slow. It is recommended that the use of tracd be used for performance reasons. See http://lazutkin.com/blog/2006/feb/18/setting-tools-windows/ → Section "Trac" → Step 4. This results in a significant performance boost over CGI.


Comment from W.Berger, Statistisches Landesamt, Stuttgart, Germany: The above may be impossible for some reasons. If you still have to connect Trac to IIS, AJP is a much better solution than CGI.


Note 2: This example installs to F: (for extra points, then goes DarkReign? hard with a separate application pool and so on.)


Comment from follower of this guide: I followed the guide exactly, but could not get it running. Ran perfectly with the "test" web server tracd, but did not even get into trac with IIS. Seems the sub folder configured for cgi-bin is never asked for pages, all requests goes to the root (htdocs). Maybe it is totally wrong of my to post here, but I couldn't find anywhere else to notify other who might be trying to use this guide.


Other comment by other follower : I followed the guide but i don't have any directory [F:\Python23]\share\trac\htdocs or .\share\trac\cgi-bin. No more *.cgi files. I don't know where is my misstake.


Note f:/tracsvn should be replaced with your path to your Trac project. Also note to view your site for that project you need to go to /trac/cgi-bin/trac.cgi. You can also make this file the default for the directory so users can just go to the root of the directory instead of needing to hit the direct URL.


Arm Yourself

  1. Get & Read book http://svnbook.red-bean.com

Install Subversion Pre-Requisites

  1. Download and Install Python (Get version 2.4.4, because v2.5 doesn't have appropriate SVN plugins available EDIT:not true anymore). http://www.python.org/download/releases/2.4.4/

Add F:\Python23 to path

Note that installing to a path that contains spaces is likely to break the install (iis6 doesn't seem to like cgi interpreters with spaces in their path).

  1. Install IIS Control panel, Configure server roles…
  1. Install Subversion http://subversion.tigris.org (remember to get the python bindings as well)
  1. Install docutils (optional for WikiRestructuredText) http://docutils.sourceforge.net/
      expand and run from the expanded docutils-xxx directory
      > F:\python23\python install.py
    

Create Repository

  1. Create repository
    F:\> svnadmin create f:\tracsvn --fs-type fsfs
    

The bdb repo type doesn't work well with a cgi trac on windows (possibly locking?). The fsfs type works quite well though.

  1. Create skeleton repository structure in f:\temp\project Example:
    /project
      /vendor
        /tags
        /trunk
          files
      /projectname
        /branches
        /tags
        /trunk
          files
    
  1. Build repository tree
    f:\> svn import f:\temp\project file:///f:/tracsvn/ -m "Initial Load"
    
  1. Create local SVN sandbox
    f:\> svn checkout file:///f:/svn/repo1 f:\project
    

Configure IIS

  1. Create the Service-Trac (local) user
    • Add Service-Trac to the IIS_WPG (local) group
  1. Allow the Service-Trac user to run cgi scripts.
    • Grant Service-Trac the following permissions in the 'Local Security Policy' Administrative Tool:
  1. Add a Python CGI web service extension to IIS In the IIS control panel add a new web service extension. The required file is [F:\Python23\python.exe -u "%s" %s]. You will also need to enable this extension.
  1. IIS virtual directories Add a virtual directory for /trac in the IIS control panel. It doesn't need execute permissions of any description as that will be taken care of by /trac/cgi-bin. Map this to [F:\Python23\share\trac\htdocs]. Ensure that Anonymous/Windows? authentication is set as per your usage requirements.

Add a cgi-bin vdir under /trac in the IIS control panel. It needs script execute permissions. Map this to [F:\Python23\share\trac\cgi-bin].

  1. IIS Application Pool Add a new application pool in the IIS control panel. Change the Identity of the new pool to Configurable and enter the details for the Service-Trac user you defined earlier.

Change the Application settings of the /trac/cgi-bin vdir: click Configuration and select the Mappings tab. Add a new mapping.

  • Executable: [F:\Python23\python.exe -u "%s" %s] - note that this must be identical to the web service extension added earlier
  • Extension: [cgi]
  • Verbs: All verbs
  • Script Engine: checked
  • Verify that file exists: unchecked

Change the Application Pool setting of the cgi-bin vdir to the pool you just created.

  1. Fix up permissions Change the ownership of, or give Full-Control permissions on F:\tracsvn to Service-Trac. You may also need to change the ownership or grant write/modify on F:\Python23\Lib\site-packages\trac to Service-Trac (so it can write pyc files). Service-Trac will need read access to F:\Python23\share\trac

Install Trac Prerequisites

  1. Install Subversion Python Bindings (Get from same download page as Subversion - http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91. Currently only supports Python 2.3 and Python 2.4 - NOT 2.5)
    Copy libsvn and svn directories to F:\Python23\Lib
  1. Install SQLite http://www.sqlite.org/download.html
    Copy sqlite.exe to F:\Program Files\SQLite This is really optional. Don't let it mess your disk unless something exceptional not described here happens.
  1. Install PySQLite http://www.initd.org/tracker/pysqlite
  1. Install ClearSilver http://www.clearsilver.net
  1. Install Trac http://projects.edgewall.com/trac/wiki/TracDownload Use the Windows installer to avoid having to manually install Trac with Python.

Modify a few Python scripts to cater for peculiarities specific to IIS

  1. Fix the CGI

In [F:\Python23\Share\Trac\cgi-bin\trac.cgi]

modify the section between the try/except block to be as follows:

try:
    # PATCH IIS6 - start
    import os
    os.environ['TRAC_ENV'] = "F:/tracsvn"
    # PATCH IIS6 - end
    from trac.web import cgi_frontend
    cgi_frontend.run()
except SystemExit:

The TRAC_ENV line is important as IIS6 won't pass this environment variable to the script when it runs. In case you're going to make use of plugins, also add os.environ['PYTHON_EGG_CACHE'] = "F:/path/to/eggcache".

  1. Fix Python file - api.py

In [F:\Python23\Lib\site-packages\trac\web\api.py], change line 217 to:

path_info = property(fget=lambda self: self.environ.get('PATH_INFO','').decode('utf-8').replace(self.environ.get('SCRIPT_NAME', ''), ''),
                     doc='Path inside the application') 

Note: For Trac 0.11 the correct line is 181.
Note: For Trac 0.11.5 the correct line is 208.

  1. Fix Python file - main.py

In [F:\Python23\Lib\site-packages\trac\web\main.py], change line 315 to:

path_info = environ.get('PATH_INFO', '').replace(environ.get('SCRIPT_NAME', ''), '').lstrip('/').split('/') 

Note: For Trac 0.11 this fix is not necessary.

Configure Trac DB

The trac database can be named to match the subversion repository it is working with, which is especially useful if more than one repository will ever be created. However, I'm not going to try that here (re: DarkReign? hard).

  1. Run trac-admin
    f:\Python23\Scripts> python trac-admin f:/tracsvn/
    
  1. Initialize DB

Note: Before performing this step, ensure that your current user account (ie. the account you are running the command prompt under) has read/write permissions to your SVN directory (f:/tracsvn/) in order to create the Trac Sqlite database.

Trac [f:/tracsvn]> initdb

or

Trac [f:/tracsvn]> initenv
  Enter project name
    Project
  Database Connection String
    sqlite:db/trac.db
  Enter path to repository
    f:\tracsvn\
  Enter path to templates
    f:\Python23\share\trac\templates

If you get an error here stating that libdb42.dll was not found, copy [SVN PATH]\bin\libdb42.dll to [PYTHON PATH]\lib\libsvn\, then try again.

  1. Add administrative permissions (the below adds all permissions for 'admin' user)
    Trac [f:/tracsvn]> permission add admin TRAC_ADMIN
    

Note that if you're using windows authentication with iis6 you can grant permissions to windows users here. Eg.

Trac [f:/tracsvn/trac.db]> permission add STAR\\Administrator TRAC_ADMIN

If your iis server's windows network name is "STAR", or your iis server is in the "STAR" domain.

Finally…

  1. Install Subversion clients as necessary (try RapidSVN & TortoiseSVN)
  1. Don't forget to lock down the security on the box!
  1. Now go get a *real* drink

See also: TracGuide, TracCgi, TracFastCgi, TracUpgrade, TracPermissions, #692, #693, #697

Last modified 3 years ago Last modified on Feb 2, 2011 11:16:51 AM