Creating a Trac Project Environment

From Littledamien Wiki
Jump to navigation Jump to search

Overview

How to set up a new Trac project environment on Windows using a SQLite database.

Prerequisites

Trac installation

  • Python
    • Trac works only with Python 2.7 for now (even though Python 3.x exists).
      (It looks like it's possible to run multiple python environments?)
    • The Windows installation of Python doesn't update the "path" environment variable. It's necessary to do that manually to include the path to the python executable.
    • Same is true for Trac. By default the trac libraries are installed in [PYTHON_INSTALL_DIR]\Lib\site-packages\. The trac-admin executable is located in c:\python27\scripts\ (where c:\phython27\ is the installation directory for Python).
  • Python setuptools
  • Genshi

Running Trac on IIS

Install Trac

  • Instead of using port 8000, use 8009 which is the standard port for AJP.
  • Add --protocol=ajp to have tracd use AJP instead of HTTP.
    tracd --port 8009 --protocol=ajp ./littledamien_web/trac
  • This will result in an error indicating that the module flup.server.ajp is missing. If not, flup is installed and the next step may be skipped.

Install flup

  • Copy flup-1.0-py2.5.egg from ​Saddi Software binaries to C:\Python27\Scripts (or whatever may be your Python installation directory).
  • Run easy_install flup.

Install Tomcat AJP Connector for IIS

  • Set up the directory structure.

We assume there will be a base directory named C:\AJP-Connector and three subdirectories bin, conf and logs. Of course, you may choose anything else for the base directory.

  • Copy tomcat-connectors-1.2.37-windows-i386-iis.zip (or tomcat-connectors-1.2.37-windows-x86_64-iis.zip in a 64 bit environment) or a newer version from ​Apache binaries and extract isapi_redirect.dll to the bin subdirectory.
  • Create a configuration file isapi_redirect.properties for the ISAPI redirector.

This must be in the same directory as the DLL and have exactly the same name but with a .properties extension. The configuration file should contain this: (be sure to replace "C:\AJP-Connector" with your actual directory)

# Configuration file for the ISAPI Redirector

# The path to the ISAPI Redirector Extension, relative to the website
# This must be in a virtual directory with execute privileges
extension_uri=/AJP-Connector/isapi_redirect.dll

# Full path to the log file for the ISAPI Redirector
log_file=C:\AJP-Connector\logs\isapi_redirect.log

# Log level (debug, info, warn, error or trace)
log_level=info

# Full path to the workers.properties file
worker_file=C:\AJP-Connector\conf\workers.properties

# Full path to the uriworkermap.properties file
worker_mount_file=C:\AJP-Connector\conf\uriworkermap.properties
  • Create the workers.properties file with the following content: (replace the host name and port if necessary)
# Define 1 real worker
worker.list=trac
# Set properties for trac (ajp13)
worker.trac.type=ajp13
worker.trac.host=localhost
worker.trac.port=8009
worker.trac.socket_keepalive=0
  • Create the uriworkermap.properties file with the following content: (replace foo and bar with your trac project names)
/foo*=trac
/bar*=trac

Define the virtual directory for AJP-Connector

  • Start IIS Manager
  • Inside the web site where you want to publish Trac, define a virtual directory named AJP-Connector, pointing to your bin subdirectory, with permissions to execute executables (not only scripts).
    • Click the name of the virtual directory.
    • In the virtual directory Home area, double click Handler Mappings.
    • In the Actions pane, click Edit Feature Permissions.
    • In the Edit Feature Permissions dialog verify that the Read and Script check boxes are both selected, and that the Execute check box is also selected.

The only purpose for this virtual directory is to allow the ISAPI filter defined in step 6 to find the DLL.

Allow execution of the DLL as Web Service Extension

  • Open IIS manager
  • Click on the Computer name in the left pane (root node in the tree)
  • In the Features view select ISAPI and CGI Restrictions.
  • Under Actions in the right column click Add...
    • ISAPI or CGI path: path to AJP DLL. (c:\AJP-Connector\bin\isapi_redirect.dll)
    • Description: AJP-Connector
    • Allow extension path to execute: checked

Add AJP-Connector to the ISAPI filters

  • In the IIS Manager, open the properties of the web site where you want to publish Trac.
  • Open ISAPI Filters.
  • Add a new filter with any filter name (I prefer "AJP-Connector") and the complete path to c:\AJP-Connector/bin/isapi_redirect.dll as executable.

Creating a project environment

trac-admin /path/to/tracdir initenv

Then trac will prompt for settings:

  • Project name: littledamien
  • Database connection string: sqlite:db/trac-littledamien.db

The configuration file for the new project environment is located at [TRAC_PROJECT_DIR]\conf\trac.ini.

Start the server with

tracd --port 8000 /path/to/tracdir

Then you can connect to the trac project with http://localhost:8000/trac/.

Database

  • Create a new SQLite database.
sqlite3 /develop/trac-projectname.db