Version 4 (modified by trac, 3 years ago) (diff)

--

# Tracd

Tracd is a lightweight standalone Trac web server. It can be used in a variety of situations, from a test or development server to a multiprocess setup behind another web server used as a load balancer.

## Pros

• Fewer dependencies: You don't need to install apache or any other web-server.
• Fast: Should be almost as fast as the mod_python version (and much faster than the CGI), even more so since version 0.12 where the HTTP/1.1 version of the protocol is enabled by default
• Automatic reloading: For development, Tracd can be used in auto_reload mode, which will automatically restart the server whenever you make a change to the code (in Trac itself or in a plugin).

## Usage examples

A single project on port 8080. (http://localhost:8080/)

 $tracd -p 8080 /path/to/project  Strictly speaking this will make your Trac accessible to everybody from your network rather than localhost only. To truly limit it use the --hostname option. $ tracd --hostname=localhost -p 8080 /path/to/project


With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)

 $tracd -p 8080 /path/to/project1 /path/to/project2  You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the different projects unique. So if you use /project1/path/to and /project2/path/to, you will only see the second project. An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the -e option. The example above could be rewritten: $ tracd -p 8080 -e /path/to


To exit the server on Windows, be sure to use CTRL-BREAK -- using CTRL-C will leave a Python process running in the background.

## Installing as a Windows Service

### Option 1

To install as a Windows service, get the SRVANY utility and run:

 C:\path\to\instsrv.exe tracd C:\path\to\srvany.exe
reg add HKLM\SYSTEM\CurrentControlSet\Services\tracd\Parameters /v Application /d "\"C:\path\to\python.exe\" \"C:\path\to\python\scripts\tracd-script.py\" <your tracd parameters>"
net start tracd


DO NOT use tracd.exe. Instead register python.exe directly with tracd-script.py as a parameter. If you use tracd.exe, it will spawn the python process without SRVANY's knowledge. This python process will survive a net stop tracd.

If you want tracd to start automatically when you boot Windows, do:

 sc config tracd start= auto


The spacing here is important.

Once the service is installed, it might be simpler to run the Registry Editor rather than use the reg add command documented above. Navigate to:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tracd\Parameters

Three (string) parameters are provided:

 AppDirectory C:\Python26\ Application python.exe AppParameters scripts\tracd-script.py -p 8080 ...

Note that, if the AppDirectory is set as above, the paths of the executable and of the script name and parameter values are relative to the directory. This makes updating Python a little simpler because the change can be limited, here, to a single point. (This is true for the path to the .htpasswd file, as well, despite the documentation calling out the /full/path/to/htpasswd; however, you may not wish to store that file under the Python directory.)

For Windows 7 User, srvany.exe may not be an option, so you can use WINSERV utility and run:

"C:\path\to\winserv.exe" install tracd -displayname "tracd" -start auto "C:\path\to\python.exe" c:\path\to\python\scripts\tracd-script.py <your tracd parameters>"
net start tracd


### Option 2

Use WindowsServiceScript, available at Trac Hacks. Installs, removes, starts, stops, etc. your Trac service.

### Option 3

also cygwin's cygrunsrv.exe can be used:

$cygrunsrv --install tracd --path /cygdrive/c/Python27/Scripts/tracd.exe --args '--port 8000 --env-parent-dir E:\IssueTrackers\Trac\Projects'$ net start tracd


## Using Authentication

Tracd allows you to run Trac without the need for Apache, but you can take advantage of Apache's password tools (htpasswd and htdigest) to easily create a password file in the proper format for tracd to use in authentication. (It is also possible to create the password file without htpasswd or htdigest; see below for alternatives)

Attention: Make sure you place the generated password files on a filesystem which supports sub-second timestamps, as Trac will monitor their modified time and changes happening on a filesystem with too coarse-grained timestamp resolution (like ext2 or ext3 on Linux, or HFS+ on OSX).

Tracd provides support for both Basic and Digest authentication. Digest is considered more secure. The examples below use Digest; to use Basic authentication, replace --auth with --basic-auth in the command line.

The general format for using authentication is:

 $tracd -p port --auth="base_project_dir,password_file_path,realm" project_path  where: • base_project_dir: the base directory of the project specified as follows: • when serving multiple projects: relative to the project_path • when serving only a single project (-s): the name of the project directory Don't use an absolute path here as this won't work. Note: This parameter is case-sensitive even for environments on Windows. • password_file_path: path to the password file • realm: the realm name (can be anything) • project_path: path of the project • --auth in the above means use Digest authentication, replace --auth with --basic-auth if you want to use Basic auth. Although Basic authentication does not require a "realm", the command parser does, so the second comma is required, followed directly by the closing quote for an empty realm name. Examples: $ tracd -p 8080 \


Of course, the password file can be be shared so that it is used for more than one project:

 $tracd -p 8080 \ --auth="project1,/path/to/passwordfile,mycompany.com" \ --auth="project2,/path/to/passwordfile,mycompany.com" \ /path/to/project1 /path/to/project2  Another way to share the password file is to specify "*" for the project name: $ tracd -p 8080 \
--auth="*,/path/to/users.htdigest,mycompany.com" \
/path/to/project1 /path/to/project2


### Basic Authorization: Using a htpasswd password file

This section describes how to use tracd with Apache .htpasswd files.

Note: On Windows It is necessary to install the passlib package in order to decode some htpasswd formats. Only SHA-1 passwords (since Trac 1.0) work without this module.

To create a .htpasswd file use Apache's htpasswd command (see below for a method to create these files without using Apache):

 $sudo htpasswd -c /path/to/env/.htpasswd username  then for additional users: $ sudo htpasswd /path/to/env/.htpasswd username2


Then to start tracd run something like this:

 $tracd -p 8080 --basic-auth="project,/fullpath/environmentname/.htpasswd,realmname" /path/to/project  For example: $ tracd -p 8080 --basic-auth="project,/srv/tracenv/testenv/.htpasswd,My Test Env" /path/to/project


Note: You might need to pass "-m" as a parameter to htpasswd on some platforms (OpenBSD).

### Digest authentication: Using a htdigest password file

If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read this page from the Apache manual to get precise instructions. You'll be prompted for a password to enter for each user that you create. For the name of the password file, you can use whatever you like, but if you use something like users.htdigest it will remind you what the file contains. As a suggestion, put it in your <projectname>/conf folder along with the trac.ini file.

Note that you can start tracd without the --auth argument, but if you click on the Login link you will get an error.

### Generating Passwords Without Apache

Basic Authorization can be accomplished via this online HTTP Password generator which also supports SHA-1. Copy the generated password-hash line to the .htpasswd file on your system. Note that Windows Python lacks the "crypt" module that is the default hash type for htpasswd. Windows Python can grok MD5 password hashes just fine and you should use MD5.

Trac also provides htpasswd and htdigest scripts in contrib:

$./contrib/htpasswd.py -cb htpasswd user1 user1$ ./contrib/htpasswd.py -b htpasswd user2 user2

$./contrib/htdigest.py -cb htdigest trac user1 user1$ ./contrib/htdigest.py -b htdigest trac user2 user2


#### Using md5sum

It is possible to use md5sum utility to generate digest-password file:

user=
realm=